Difference between revisions of "Category:Oblivion Script Extender"

From the Oblivion ConstructionSet Wiki
Jump to navigation Jump to search
imported>Behippo
(update for v0008)
m (Reverted edits by 107.123.5.60 (talk) to last revision by [[User:imported>Shademe|imported>Shademe]])
Tag: Rollback
 
(53 intermediate revisions by 14 users not shown)
Line 3: Line 3:
!style="background:#ffdead;border-bottom:1px solid;"  width="100"  | Description
!style="background:#ffdead;border-bottom:1px solid;"  width="100"  | Description
|style="background:#ffeded;border-bottom:1px solid;" colspan="2"|  
|style="background:#ffeded;border-bottom:1px solid;" colspan="2"|  
Oblivion Script Extender v0008
Oblivion Script Extender v0020
by Ian Patterson and Stephen Abel
by Ian Patterson, Stephen Abel, and Paul Connelly
(ianpatt, behippo, and scruggsywuggsy the ferret)


The Oblivion Script Extender runs in the background behind Oblivion, allowing the addition of new functions for scripters to use in mods. Still very early in development, OBSE has already completely revolutionized scripting with the addition of such much-asked-for functions as IsKeyPressed and GetCurrentSpell.
Additional contributions from Timeslip, The J, DragoonWraith, SkyRanger-1, badhair, JRoush, shadeMe and kyoma.


This doesn't make any modifications to oblivion.exe or TESConstructionSet.exe, or any other files in your Oblivion install, so don't worry about permanent side effects. It will only work with specific versions of Oblivion - in general, it will not work with localized versions, Direct2Drive versions, unpatched versions, and no-CD cracks can prevent it from working as well. See Discussion for more details.
The Oblivion Script Extender, or OBSE for short, is a modder's resource that expands the scripting capabilities of Oblivion. It doesn't make any modifications to oblivion.exe, TESConstructionSet.exe, or any other files in your oblivion install, so don't worry about permanent side effects. It is compatible with the 1.2.0416 Oblivion patch, as well as the 1.2 version of the Construction Set. Versions of Oblivion downloaded via Steam are supported as well.
 
IMPORTANT: Please note that scripts compiled with OBSE v0018 or greater require the user to be running v0018 (or greater), even if no 0018 commands are used.
|-
|-
!style="background:#ffdead;border-bottom:1px solid;"  width="100"  | ianpatt's Comments
|style="background:#ffeded;border-bottom:1px solid;" colspan="2"|
"This release is focused on magic decoding with GetMagicItemValue, GetMagicEffect[Code]Value and MagicItemHasEffect[Code].  You've noticed the [Code] designation by now.  The CS is very picky about using the 4 character Magic effects.  When we return those values we can't pass them back into other script functions.  So our Magic Effect functions come in two flavors: one that takes the magic effect and one that takes the same value returned as an integer from our functions.


We also added a new value to the various object value functions to get the enchantment object of some equipment.  We added GetEquippedObjectValue and GetEquippedCurrentValue to get the values of items equipped in a specific slot.  Finally we added GetNumMouseButtonsPressed and GetMouseButtonPress and fixed a few bugs.
"
|-
|-
!style="background:#ffdead;border-bottom:1px solid;"  width="100"  | Installation
!style="background:#ffdead;border-bottom:1px solid;"  width="100"  | Installation
|style="background:#ffeded;border-bottom:1px solid;" colspan="2"|  
|style="background:#ffeded;border-bottom:1px solid;" colspan="2"|  
#Copy obse.dll, obse_editor.dll, and obse_loader.exe to your Oblivion directory.
#Copy obse_1_1.dll, obse_1_2.dll, obse_1_2_416.dll, obse_editor_1_0.dll, obse_editor_1_2.dll, and obse_loader.exe to your Oblivion directory.
#Copy scripttest.esp or another OBSE enabled ESP to your Oblivion plugins directory and enable it in the launcher.
#Run oblivion by running obse_loader.exe from the Oblivion directory.
#Run oblivion by running obse_loader.exe from the Oblivion directory.
#To create mods using OBSE, you need to run obse_loader.exe with a -editor flag. This can either be done with the Command Line (typically Start->Programs->Accessories->Command Prompt) or by creating a shortcut whose Target reads as follows:<pre>"...wherever it's installed\Oblivion\obse_loader.exe" -editor</pre>
#Scripts written with these new commands must be written via the TESConstructionSet launched with obse_loader. Open a command prompt window, navigate to your oblivion install folder, and type "obse_loader -editor". The normal editor can open plugins with these extended scripts fine, it just can't recompile them and it will give errors if you try.
 
To make things easier, it is recommended that you create a shortcut to obse_loader.exe with the argument already supplied, for example:
[[Image:OBSE CS Shortcut.png|center]]
|-
!style="background:#ffdead;border-bottom:1px solid;"  width="100"  | Suggestions for Modders
|style="background:#ffeded;border-bottom:1px solid;" colspan="2"|
If your mod requires OBSE, please provide a link to the main OBSE website,  instead of packaging it with your mod install. Future versions of OBSE will be backwards compatible, so including a potentially old version can cause confusion and/or break other mods that need newer versions. If you're making a large mod with an installer, inclusion of a specific version of OBSE is OK, but please check the file versions of the OBSE files before replacing them, and only replace earlier versions.
 
When your mod loads, use the command GetOBSEVersion to make sure a compatible version of OBSE is installed. In general, make sure you're testing for any version later than the minimum version you support, as each update to OBSE will have a higher version number. Something like:
 
if GetOBSEVersion < 5
  MessageBox "This mod requires a newer version of OBSE."
endif
 
Another alternative that is even more user-friendly is releasing your mod as an OMOD, and adding a script to check the version when installing the mod:
 
IfNot ScriptExtenderNewerThan #.#.#.#
  Message "Requires Oblivion Script Extender v#### or greater"
  FatalError
EndIf
 
If desired, it is possible to make the same .esp file work for both OBSE and non-OBSE users. See the [[Combine your SI and non-SI mods into one (OBSE, Patch v1.1, Other mods too)]] tutorial for more information.
|-
|-
!style="background:#ffdead;border-bottom:1px solid;"  width="100"  | Troubleshooting
!style="background:#ffdead;border-bottom:1px solid;"  width="100"  | Troubleshooting
|style="background:#ffeded;border-bottom:1px solid;" colspan="2"|  
|style="background:#ffeded;border-bottom:1px solid;" colspan="2"|  
Oblivion doesn't launch after running obse_loader.exe:
Oblivion doesn't launch after running obse_loader.exe:
 
* Make sure you've copied the OBSE files to your oblivion folder. That folder should also contain oblivion.exe.
- Make sure you've copied obse_loader.exe, obse.dll, and obse_editor.dll to your oblivion folder. That folder should also contain oblivion.exe.
* Check the file obse_loader.log in your oblivion folder for errors.
- Check the file obse_loader.log in your oblivion folder for errors.


obse_loader.log tells me it couldn't find a checksum:
obse_loader.log tells me it couldn't find a checksum:
* You may have a version of Oblivion that isn't supported. I have the english official patch v1.2.0.416.  Localized versions with different executables or different patches may not work, but many have been successful. If there's enough legitimate demand for it, I can add support for other versions in the future.
* Your Oblivion install may be corrupt. Hacks or no-cd patches may also change the checksum of the game, making it impossible to detect the installed version.


- You may have a version of Oblivion that isn't supported. I have the english official patch v1.1.0.511, localized versions with different executables or different patches will not work. If there's enough legitimate demand for it, I can add support for other versions in the future.
The OBSE loader tells me I need to use the autopatcher:
* Go to to OBSE website and download autopatcher, which will walk you through the update process. You will need the latest patch from Bethesda, as well as your original Oblivion DVD.


- Your Oblivion install may be corrupt. Hacks or no-cd patches may also change the checksum of the game, making it impossible to detect the installed version.
OBSE doesn't launch with the Direct2Drive version:
* The Direct2Drive version of the Oblivion executable is compressed and possibly encrypted. This makes it very difficult to support. Whether or not it is supportable in the future is unknown. Apologies.
** OBSE does work with the Steam direct-download version, though it requires special installation steps. See the readme. The Direct2Drive limitation only applies to direct downloads from the Direct2Drive service, not Steam.


Crashes or other strange behavior
Crashes or other strange behavior:


- Let me know how you made it crash, and I'll see about fixing it.
- Let me know how you made it crash, and I'll see about fixing it.
|-
|-
!style="background:#ffdead;border-bottom:1px solid;"  width="100"  | Contact
!style="background:#ffdead;border-bottom:1px solid;"  width="100"  | Contact
|style="background:#ffeded;border-bottom:1px solid;" colspan="2"|  
|style="background:#ffeded;border-bottom:1px solid;" colspan="2"|  
Send email to ianpatt+obse [at] gmail [dot] com. (yes, keep the + symbol, it helps sort email)
* Send email to team [at] obse [dot] silverlock [dot] org
Send email to behippo at gamer [at] silverlock [dot] org.
|-
|-
!style="background:#ffdead;border-bottom:1px solid;" | Home Page
!style="background:#ffdead;border-bottom:1px solid;" | Home Page
|style="background:#ffeded;border-bottom:1px solid;" colspan="2"|  
|style="background:#ffeded;border-bottom:1px solid;" colspan="2"|  
[http://obse.silverlock.org/ Silverlock]
[http://obse.silverlock.org/]
|-
|-
!style="background:#ffdead;border-bottom:1px solid;" | Discussion
!style="background:#ffdead;border-bottom:1px solid;" | Discussion
|style="background:#ffeded;border-bottom:1px solid;" colspan="2"|  
|style="background:#ffeded;border-bottom:1px solid;" colspan="2"|  
[http://www.elderscrolls.com/forums/index.php?showtopic=541448 Release thread on The Elder Scrolls Forums]
[http://forums.bethsoft.com/index.php?/topic/1184481-relz-oblivion-script-extender-obse-0020/ Release thread on The Elder Scrolls Forums]
|-
|-
!style="background:#ffdead;border-bottom:1px solid;" | Direct Download (Silverlock)
!style="background:#ffdead;border-bottom:1px solid;" | Direct Download (Silverlock)
|style="background:#ffeded;border-bottom:1px solid;" colspan="2"|  
|style="background:#ffeded;border-bottom:1px solid;" colspan="2"|  
[http://obse.silverlock.org/download/obse_0008.zip Click here to download]
[http://obse.silverlock.org/download/obse_0020.zip Click here to download]
|}
|}



Latest revision as of 08:58, 20 October 2023

Description

Oblivion Script Extender v0020 by Ian Patterson, Stephen Abel, and Paul Connelly (ianpatt, behippo, and scruggsywuggsy the ferret)

Additional contributions from Timeslip, The J, DragoonWraith, SkyRanger-1, badhair, JRoush, shadeMe and kyoma.

The Oblivion Script Extender, or OBSE for short, is a modder's resource that expands the scripting capabilities of Oblivion. It doesn't make any modifications to oblivion.exe, TESConstructionSet.exe, or any other files in your oblivion install, so don't worry about permanent side effects. It is compatible with the 1.2.0416 Oblivion patch, as well as the 1.2 version of the Construction Set. Versions of Oblivion downloaded via Steam are supported as well.

IMPORTANT: Please note that scripts compiled with OBSE v0018 or greater require the user to be running v0018 (or greater), even if no 0018 commands are used.

Installation
  1. Copy obse_1_1.dll, obse_1_2.dll, obse_1_2_416.dll, obse_editor_1_0.dll, obse_editor_1_2.dll, and obse_loader.exe to your Oblivion directory.
  2. Run oblivion by running obse_loader.exe from the Oblivion directory.
  3. Scripts written with these new commands must be written via the TESConstructionSet launched with obse_loader. Open a command prompt window, navigate to your oblivion install folder, and type "obse_loader -editor". The normal editor can open plugins with these extended scripts fine, it just can't recompile them and it will give errors if you try.

To make things easier, it is recommended that you create a shortcut to obse_loader.exe with the argument already supplied, for example:

OBSE CS Shortcut.png
Suggestions for Modders

If your mod requires OBSE, please provide a link to the main OBSE website, instead of packaging it with your mod install. Future versions of OBSE will be backwards compatible, so including a potentially old version can cause confusion and/or break other mods that need newer versions. If you're making a large mod with an installer, inclusion of a specific version of OBSE is OK, but please check the file versions of the OBSE files before replacing them, and only replace earlier versions.

When your mod loads, use the command GetOBSEVersion to make sure a compatible version of OBSE is installed. In general, make sure you're testing for any version later than the minimum version you support, as each update to OBSE will have a higher version number. Something like:

if GetOBSEVersion < 5
  MessageBox "This mod requires a newer version of OBSE."
endif

Another alternative that is even more user-friendly is releasing your mod as an OMOD, and adding a script to check the version when installing the mod:

IfNot ScriptExtenderNewerThan #.#.#.#
  Message "Requires Oblivion Script Extender v#### or greater"
  FatalError
EndIf

If desired, it is possible to make the same .esp file work for both OBSE and non-OBSE users. See the Combine your SI and non-SI mods into one (OBSE, Patch v1.1, Other mods too) tutorial for more information.

Troubleshooting

Oblivion doesn't launch after running obse_loader.exe:

  • Make sure you've copied the OBSE files to your oblivion folder. That folder should also contain oblivion.exe.
  • Check the file obse_loader.log in your oblivion folder for errors.

obse_loader.log tells me it couldn't find a checksum:

  • You may have a version of Oblivion that isn't supported. I have the english official patch v1.2.0.416. Localized versions with different executables or different patches may not work, but many have been successful. If there's enough legitimate demand for it, I can add support for other versions in the future.
  • Your Oblivion install may be corrupt. Hacks or no-cd patches may also change the checksum of the game, making it impossible to detect the installed version.

The OBSE loader tells me I need to use the autopatcher:

  • Go to to OBSE website and download autopatcher, which will walk you through the update process. You will need the latest patch from Bethesda, as well as your original Oblivion DVD.

OBSE doesn't launch with the Direct2Drive version:

  • The Direct2Drive version of the Oblivion executable is compressed and possibly encrypted. This makes it very difficult to support. Whether or not it is supportable in the future is unknown. Apologies.
    • OBSE does work with the Steam direct-download version, though it requires special installation steps. See the readme. The Direct2Drive limitation only applies to direct downloads from the Direct2Drive service, not Steam.

Crashes or other strange behavior:

- Let me know how you made it crash, and I'll see about fixing it.


Contact
  • Send email to team [at] obse [dot] silverlock [dot] org
Home Page

[1]

Discussion

Release thread on The Elder Scrolls Forums

Direct Download (Silverlock)

Click here to download

Subcategories

This category has the following 14 subcategories, out of 14 total.

0

O

Pages in category "Oblivion Script Extender"

The following 6 pages are in this category, out of 6 total.