Make Custom User Scripts.txt wrote:Overview
* The UnOfficial v1.3 patch r102+ supports up to 11 custom user scripts. User scripts are loaded and processed at the start of game_interface.lua. This allows the scripts to control or adjust almost everything that happens ingame. For instance, you can create a script that does a few FakeConsole commands at the start of any map or a script that changes the server name to reflect the amount of people on the server.

Requirements
* SWBF2 mod tools
* v1.3 patch r94+ installed
* Basic understanding of Lua
* Basic understanding of how the game works

How To Do It:
1) First, you will need to read and understand the 'Munge A Custom LVL File.txt' document
2) Then you need to pick a user script slot. The slots are from zero to ten. This guide will use slot four: "4". If you plan to distribute your scripts to others, it is best to copy your files and munge a custom lvl for each slot. This way, the user can decide which slot to use if he or she already has other user scripts in different slots.
3) Configure your map to munge the custom lvl: "user_script_4.lvl" (see the custom lvl doc for help)
4) user_script_4.lvl must, at the very least, contain the lua script: "user_script_4". When your custom lvl is processed by the game, it will load only this script. You can always include more scripts or resources in the lvl if you need them, but the expected script (user_script_4) must load them (use ScriptCB_DoFile() or ReadDataFile()).
5) After you munge your user_script_4.lvl, copy it to the folder: "GameData\Data\_LVL_PC"
6) Thats it! Run your game and check its debug output. You should see it saying it found and loaded your script each time you load a map/level.

More Info
* For an example user script that runs a few FakeConsole commands when you play a single-player map (easy to remove the SP part), see "user_script_example.zip" in the "code eamples" folder of the v1.3 patch.
* You can use these scripts to better configure a dedicated server or enforce rules, such as 'no vehicles' by using the FakeConsole command 'Lock Vehicles' or a snipers only rule by listening in on AddUnitClass() and canceling any non-sniper units from being added to the team!

Munge A Custom LVL File.txt wrote:Overview
* This tutorial will guide you through munging a custom lvl file

Requirements
* SWBF2 mod tools
* Basic understanding of modding
* Basic understanding of the munge process

How To Do It
) This guide will assume the mod map is XXX
) Create the folder: "data_XXX\Shell"
) Create the text file: "data_XXX\Shell\shell.req"
) Create the folder "data_XXX\Shell\scripts"
) Create the script file: "data_XXX\Shell\scripts\test.lua"
) In shell.req, add:

ucft
{
REQN
{
"script"
"test"
}
}

) Open VisualMunge, click "Unselect All", check "Shell", click "Munge"
) When VisualMunge finishes, it will have created the lvl file: "data_XXX\_LVL_PC\shell.lvl"
) Rename shell.lvl to whatever name you need, then move it to where you need the file.

Notes
* The test.lua script is just an example script file. You should change the req file to reflect whatever it is you are trying to munging.

Bonecrusher16O wrote:Uhh thanks for the tutorial.... But that not really the question I asked.....
Thanks anyways.

Bonecrusher16O wrote:Oh.. See you never told me THAT before dak...