Difference between revisions of "Fallout Script Extender"

From the Fallout3 GECK Wiki
Jump to navigation Jump to search
imported>Quetzilla
(→‎How to use FOSE with the GECK: formatting for clarity)
imported>Pintocat
 
(17 intermediate revisions by 6 users not shown)
Line 1: Line 1:
=Fallout Script Extender (FOSE)=


'''Current Version:''' v0001 beta <br />
{{Template:Community_Wiki}}
'''Main site:''' [http://fose.silverlock.org http://fose.silverlock.org]<br />
'''Documentation:''' [http://fose.silverlock.org/fose_command_doc.html FOSE Command Documentation]<br />


[[Category: Mod Tools]]
[[Category: Mod Tools]]
[[Category:Scripting]]


== BETA NOTICE ==
== Description ==
Please note that v0001 is a beta release, and should not be used in any released mods. Functionality may be added or removed before the final release, and scripts will need to be recompiled.
The Fallout Script Extender, also known as FOSE, is maintained by Ian Patterson (ianpatt), Stephen Abel (behippo), and Paul Connelly (scruggsywuggsy the ferret).


== How It Works (AKA why NOT to be afraid of FOSE) ==
'''Current stable version:''' v1.1 beta 9 <br>
'''Current beta version:''' v1.2 beta 2 <br>
'''Main site:''' [http://www.zenimax.com/external.php?locale=en-us&url=http://fose.silverlock.org http://fose.silverlock.org] <br>
'''Documentation:''' [http://www.zenimax.com/external.php?locale=en-us&url=http://fose.silverlock.org/fose_command_doc.html FOSE Command Documentation] <br>
'''Official forum thread:''' [http://www.bethsoft.com/bgsforums/index.php?showtopic=1044512 Fallout Script Extender (FOSE) v1, Thread 12]
 
== How it Works (or why NOT to be afraid of FOSE) ==
FOSE does '''not''' edit your Fallout3.exe in any way, and as such is '''not dangerous''' to use at all.  It works by running the .exe and then patching it while it is '''in memory''' in order to add in new scripting functions.
FOSE does '''not''' edit your Fallout3.exe in any way, and as such is '''not dangerous''' to use at all.  It works by running the .exe and then patching it while it is '''in memory''' in order to add in new scripting functions.


== How to use FOSE with the GECK ==
== How to use FOSE with the GECK ==
Scripts written with these new commands must be created via the G.E.C.K. after it is launched via fose_loader.  Open a command prompt window, navigate to your Fallout 3 install direcory, and type "fose_loader.exe -editor".
Scripts written with FOSE's new functions must be created via the GECK after it's been loaded through fose_loader.exe. To use FOSE with the GECK:
 
# Extract fose_loader.exe and the necessary dll files to your Fallout 3 directory.
Alternately you can create a shortcut to fose_loader.exe, open the properties window and add "-editor" to the Target field. The normal editor can open plugins with these extended scripts, but it cannot recompile them and will give errors if you try.
# Open a command prompt window and navigate to that directory.
 
# Type this into the command prompt:
'''NOTE:''' If a mod uses FOSE commands as conditionals then the GECK must be started via fose_loader.exe in order to open the mod.
<blockquote>
fose_loader.exe -editor
</blockquote>
A more convenient method is to automate this command through a shortcut:
# Create a shortcut to fose_loader.exe.
# Right-click on the shortcut and open the properties window.
# Add "-editor" to the Target field.
'''Note:''' the normal editor can open plugins with extended scripts, but will give errors if it tries to recompile them.


== Compatibility ==
== Compatibility ==
FOSE works with the DVD version of Fallout 3, as well as the Steam version. It does not work with the Direct2Drive version since that .exe is encrypted. Support '''cannot''' and '''will not''' be added for the D2D version as decrypting the .exe is '''illegal'''.
==== Compatible Versions ====
* '''FOSE v1 (Stable)''' supports the DVD and Steam version patched to 1.1.0.35.
* '''FOSE v1.1 Beta 9''' supports these versions of Fallout 3 (both DVD and Steam releases):
** 1.0.0.15
** 1.1.0.35
** 1.4.0.6 (original release)
** 1.4.0.6 (alternate release, found on steam and some European patches)
** 1.5.0.22
** 1.6.0.3
** 1.7.0.3
* '''FOSE v1.2 Beta 2''' adds support for the German no-gore version of 1.7.0.3.


== Notes ==
==== Incompatible Versions ====
* FOSE is currently incompatible with Windows Live, so when running via fose_loader.exe, Live will be disabled. It appears that Live periodically checks the cryptographic signature of the Fallout runtime. If the signature doesn't validate properly, Live fails. Support is currently under investigation. It will still work fine when run without FOSE, so don't worry about issues if future features end up being tied to Live (buying DLC, etc).
* '''Build 1.0.0.12:''' FOSE is not compatible with the original, unpatched DVD or Steam version.
* With the above situation, users will need to move their save games from their user profile folder in the '''My Documents''' folder to the main '''Saves''' folder in order to access them.
* '''Copy Protected Versions:''' the following versions of Fallout 3 use copy protection schemes to encrypt the Fallout3.exe, thus making it illegal to decrypt:
** Direct2Drive (D2D) version
** Polish DVD version w/ SafeDisc protection
** Russian DVD version w/ StarForce protection
* '''Games for Windows Live (GFWL):''' when running Fallout 3 via fose_loader.exe, GFWL will be disabled automatically. GFWL functions as an anti-cheat mechanism, so it disables itself if it detects any in-memory modifications to the executable, despite the fact that Fallout has no multiplayer component. Since GFWL cannot tell the difference between the modifications we make and the modifications a cheating program would make, we will probably never be directly compatible. To download DLC and updates, simply launch Fallout normally.
** '''A note on DLC:''' by loading Fallout3.exe instead of fose_loader.exe, you can still download DLC and updates through Live. If you have DLC, you will need to move the DLC files into the Data directory located in the Fallout 3 installation folder.
** '''A note on saved games:''' since Live stores save files in a separate folder when active, users will need to move their save games from their user profile folder in the '''My Documents''' folder to the main '''Saves''' folder in order to access them.

Latest revision as of 13:29, 7 May 2017


Please Note: The official wiki is no longer being maintained by the community[edit source]

The modding community for Fallout 3 and Fallout New Vegas has created its own wiki due to onerous and painful captcha requirements for every edit.

The active wiki contributors have moved to the new wiki -- for the most current information, visit:

http://geckwiki.com[edit source]

Description[edit | edit source]

The Fallout Script Extender, also known as FOSE, is maintained by Ian Patterson (ianpatt), Stephen Abel (behippo), and Paul Connelly (scruggsywuggsy the ferret).

Current stable version: v1.1 beta 9
Current beta version: v1.2 beta 2
Main site: http://fose.silverlock.org
Documentation: FOSE Command Documentation
Official forum thread: Fallout Script Extender (FOSE) v1, Thread 12

How it Works (or why NOT to be afraid of FOSE)[edit | edit source]

FOSE does not edit your Fallout3.exe in any way, and as such is not dangerous to use at all. It works by running the .exe and then patching it while it is in memory in order to add in new scripting functions.

How to use FOSE with the GECK[edit | edit source]

Scripts written with FOSE's new functions must be created via the GECK after it's been loaded through fose_loader.exe. To use FOSE with the GECK:

  1. Extract fose_loader.exe and the necessary dll files to your Fallout 3 directory.
  2. Open a command prompt window and navigate to that directory.
  3. Type this into the command prompt:

fose_loader.exe -editor

A more convenient method is to automate this command through a shortcut:

  1. Create a shortcut to fose_loader.exe.
  2. Right-click on the shortcut and open the properties window.
  3. Add "-editor" to the Target field.

Note: the normal editor can open plugins with extended scripts, but will give errors if it tries to recompile them.

Compatibility[edit | edit source]

Compatible Versions[edit | edit source]

  • FOSE v1 (Stable) supports the DVD and Steam version patched to 1.1.0.35.
  • FOSE v1.1 Beta 9 supports these versions of Fallout 3 (both DVD and Steam releases):
    • 1.0.0.15
    • 1.1.0.35
    • 1.4.0.6 (original release)
    • 1.4.0.6 (alternate release, found on steam and some European patches)
    • 1.5.0.22
    • 1.6.0.3
    • 1.7.0.3
  • FOSE v1.2 Beta 2 adds support for the German no-gore version of 1.7.0.3.

Incompatible Versions[edit | edit source]

  • Build 1.0.0.12: FOSE is not compatible with the original, unpatched DVD or Steam version.
  • Copy Protected Versions: the following versions of Fallout 3 use copy protection schemes to encrypt the Fallout3.exe, thus making it illegal to decrypt:
    • Direct2Drive (D2D) version
    • Polish DVD version w/ SafeDisc protection
    • Russian DVD version w/ StarForce protection
  • Games for Windows Live (GFWL): when running Fallout 3 via fose_loader.exe, GFWL will be disabled automatically. GFWL functions as an anti-cheat mechanism, so it disables itself if it detects any in-memory modifications to the executable, despite the fact that Fallout has no multiplayer component. Since GFWL cannot tell the difference between the modifications we make and the modifications a cheating program would make, we will probably never be directly compatible. To download DLC and updates, simply launch Fallout normally.
    • A note on DLC: by loading Fallout3.exe instead of fose_loader.exe, you can still download DLC and updates through Live. If you have DLC, you will need to move the DLC files into the Data directory located in the Fallout 3 installation folder.
    • A note on saved games: since Live stores save files in a separate folder when active, users will need to move their save games from their user profile folder in the My Documents folder to the main Saves folder in order to access them.