Oblivion Mod Manager How-To

How to utilize OBMM.

This page updated on 6/6/2007 2:14:29 PM CST

Script Templates

This page contains scripts that I put together for mods that I have converted into OMODs. They are to be considered templates or code snippets. I will try to keep from duplicating the same functions unless they are showing multiple ways of doing the same thing.

Table of Contents

My Personal Scripting Template

Purpose: This is the base scripting template I start with for each mod. These are the most-used functions even though many mods don't need any scripting at all.

The Code:

If VersionLessThan 0.8.7 Message "This mod must be installed by OBMM version 0.8.7 or later to prevent install script errors." FatalError EndIf Message "Light Saber - Only one type of saber can be active." "Light Sabers - Choice Info" DontInstallAnyPlugins Select "Choose Type of Light Saber" "One-Handed (default)" "Dual Swords" "Double-Ended" Case One-Handed (default) InstallPlugin "SW-Saber-Single.esp" Break Case Dual Swords InstallPlugin "SW-Saber-Dual.esp" Break Case Double-Ended InstallPlugin "SW-Saber-DoubleEnded.esp" Break EndSelect

OBMM Version Check

Purpose: If your script uses scripting functions that didn't work or exist in older versions of OBMM, you should include an OBMM version check. When you finish creating your script, check the Script History page to see if you used any functions that didn't exist or wasn't stable when OBMM version 0.6.10 released.

The Code:

If VersionLessThan 0.8.18 Message "This mod must be installed by OBMM version 0.8.18 or later to prevent install script errors." FatalError EndIf

Oblivion Version Check

Purpose: If your mod requires a patched version of oblivion, this will be helpful to avoid unwanted problems.

Code for requiring Oblivion 1.1.511:

;** Requirement Check for Oblivion 1.1.511 or higher ** IfNot OblivionNewerThan 1.1.510.0 Message "This mod is compatible with Oblivion 1.1.511 or higher. Please download and install the official patch." FatalError EndIf

Code for requiring Oblivion 1.2.214:

;** Requirement Check for Oblivion 1.2.214 or higher ** IfNot OblivionNewerThan 1.2.213.0 Message "This mod requires Oblivion 1.2.214 or higher. Please download and install the official patch." FatalError EndIf

Code for requiring Oblivion 1.2.416:

;** Requirement Check for Oblivion 1.2.416 or higher ** IfNot OblivionNewerThan 1.2.415.0 Message "This mod requires Oblivion 1.2.416 or higher. Please download and install the official patch." FatalError EndIf

Oblivion Script Extender Check

Purpose: If your mod requires (any version) of Oblivion Script Extender (OBSE), this will be helpful to avoid unwanted problems.

The Code:

IfNot ScriptExtenderPresent Message "Polymorph self OBSE TEST requires Oblivion Script Extender. This cannot work without it and will be disabled." "WARNING - MISSING OBSE" FatalError EndIf

Oblivion Script Extender Check (Specific Version)

Purpose: If your mod requires Oblivion Script Extender (OBSE) as well as a specific version of OBSE, this will be helpful to avoid unwanted problems.

The Code:

IfNot ScriptExtenderNewerThan 0.0.0.4 Message "Polymorph self OBSE TEST requires Oblivion Script Extender v0004 or higher and has been disabled." "WARNING - OLD OBSE VERSION" FatalError EndIf

Menu Video Loop Replacement

Purpose: This script will allow you to install a custom menu video without overwriting the original video and without manually editing anything just like any other non-destructive mod. Of course, you'll need to name your video file with a unique filename.

The Code:

Message "Only enable one Video Menu loop replacement at a time. This will modify Oblivion.ini. If you uninstall this mod, it will restore the original menu video loop entry." "WARNING" EditINI [General] SMainMenuMovie "Bravil Guard Fight.bik"

Avoid Incompatible Mods (that you know about)

Purpose: If you know this mod is incompatible with another and it uses the same .esp file for every version, this script will work fine.

The Code:

If DataFileExists "SW-Saber-DoubleEnded.esp" Message "This mod is not compatible with the Star Wars Light Saber mod." FatalError EndIf

Recommending Complimentary Mods

Purpose: If your mod compliments another mod but does not require it, add an FYI message stating so.

The Code:

IfNot DataFileExists "gardening.esp" Message "Complete Gardening not detected. Armory Lab could strongly benefit from that mod." "Armory Lab" EndIf

Selecting Multiple Plugins

Purpose: If your mod has more than one .esp file and can be enabled at the same time, this script will allow the player to pick one or more.

The Code:

DontInstallAnyPlugins SelectMany "Star Wars Sabers - Pick Some" "Single Blade" "Dual Blade" "Double-Ended Staff" "None" Case Single Blade InstallPlugin "SW-Single-Blade.esp" Break Case Dual Blade InstallPlugin "SW-Dual-Blade.esp" Break Case Double-Ended Staff InstallPlugin "SW-Double-Ended-Staff.esp" Break Case None EndSelect

CopyPlugin

Purpose: This script os for mods that have more than one .esp file and only one can be enabled at a time with a strong importance be placed on the .esp name remaining the same no matter which .esp you select.

The Code:

Select "Star Wars Race - Pick Race Plugin" "Old Republic (default)" "Confederation" "Galactic Empire" Case Old Republic (default) CopyPlugin "Star Wars - Races Republic.esp" "Star Wars - Races.esp" Break Case Confederation CopyPlugin "Star Wars - Races Confed.esp" "Star Wars - Races.esp" Break Case Galactic Empire CopyPlugin "Star Wars - Races Empire.esp" "Star Wars - Races.esp" Break EndSelect

CopyDataFile

Purpose: If your mod has more than one texture option for an object, you can use CopyDateFile to give the player an option for which texture to use. The OBMM manual states that using the function can cause the conflict detector to go haywire.

The Code:

DontInstallDataFolder "Textures\\Weapons\\SW-Sabers" "True" Select "Star Wars Sabers - Color Picker" "Green (default)" "Red" "Blue" Case Green (default) CopyDataFile "Textures\\Weapons\\SW-Sabers\Green.dds" "Textures\\Weapons\\SW-Sabers\color.dds" CopyDataFile "Textures\\Weapons\\SW-Sabers\Green_n.dds" "Textures\\Weapons\\SW-Sabers\color_n.dds" Break Case Red CopyDataFile "Textures\\Weapons\\SW-Sabers\Red.dds" "Textures\\Weapons\\SW-Sabers\color.dds" CopyDataFile "Textures\\Weapons\\SW-Sabers\Red_n.dds" "Textures\\Weapons\\SW-Sabers\color_n.dds" Break Case Blue CopyDataFile "Textures\\Weapons\\SW-Sabers\Blue.dds" "Textures\\Weapons\\SW-Sabers\color.dds" CopyDataFile "Textures\\Weapons\\SW-Sabers\Blue_n.dds" "Textures\\Weapons\\SW-Sabers\color_n.dds" Break EndSelect

--SCRIPT TITLE HERE--

Purpose: --INSERT PURPOSE HERE--

The Code:

--INSERT CODE HERE--