User Tools

Site Tools


modding

This is an old revision of the document!


Modding

Prerequisites

  1. Install Unreal Engine 5.4.4 in the Epic Games Launcher. Make sure no to use any other version.
  2. Install .NET 8.0 Runtime. The link should directly start the download.

Create a mod

  1. Go to Modding SDK\Plugins\SubwaySim_Extern.
  2. Rename the folder Simuverse_ModTemplate to YourName_YourMod and inside the folder rename the file Simuverse_ModTemplate.uplugin to YourName_YourMod.uplugin.
  3. Rename all occurences of Simuverse_ModTemplate to YourName_YourMod in YourName_YourMod.uplugin and Lua\mod.lua.
  4. Start the project by double clicking Modding SDK\SubwaySim2.uproject.
  5. Enable Show Plugin Content in the Settings of the Content Browser.
  6. Use the content folder All > Plugins > YourName_YourMod Content for your mod content and use the Lua folder Modding SDK\Plugins\SubwaySim_Extern\YourName_YourMod\Lua for your Lua scripts.

Build a mod

  1. Open the build script BuildMod.bat in a text editor to adjust the variables.
  2. Set DLC_NAME to YourName_YourMod, ENGINE_ROOT to your engine path, LEVEL_PATH to your level (leave empty if the mod does not contain a level).
  3. Run the build script by double clicking BuildMod.bat.
  4. If you filled out the level path you can type y when asked to build the NavMesh for your level.
  5. The mod will be built in Modding SDK\Output\YourName_YourMod.pak. Subsequent build times will be much shorter.

Install a mod

  1. Place the mod in %userprofile%\Documents\My Games\SubwaySim 2\Mods (create the folder if it does not exist).

Testing Lua scripts without rebuilding the mod

  1. Create an empty folder for your plugin %userprofile%\Documents\My Games\SubwaySim 2\Mods\YourName_YourMod\.
  2. Copy the Lua scripts from your Lua folder inside this folder maintaing the same folder structure.
  3. The game will now use the Lua scripts from this folder if they exist, otherwise it falls back to the mod itself.

FAQ

Asset modifications in the SubwaySim2_Modding plugin are not reflected in the game. You may only modify assets in your YourName_YourMod plugin, modified assets in the SubwaySim2_Modding plugin are ignored.

  1. The build script shows errors and warnings: Certain errors and warnings are expected and can usually be ignored if the mod has been built successfully.
modding.1749031972.txt.gz · Last modified: by sho

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki