Differences

This shows you the differences between two versions of the page.

--- manual:subwaysim:map_construction:build_mod [2025/12/12 12:52] – [Installing the Mod in SubwaySim 2] dcs
+++ manual:subwaysim:map_construction:build_mod [2026/08/19 07:49] (current) – dcs
@@ Line 2: / Line 2: @@
 Before a mod can be used in SubwaySim 2, it must be converted into a format that the game can read. This process is required because of how Unreal Engine handles assets and game content.
 ----
@@ Line 19: / Line 18: @@
 ----
-===== Preparing the BuildMod.bat =====
+===== Opening the Modding Tools =====
-Before building your mod, the file BuildMod.bat must be configured correctly. This file is located in the root directory of the Modding SDK.
+In the current version of the Modding SDK, the previously used ''BuildMod.bat'' files are no longer required.
-Open BuildMod.bat using a text editor.
+Building mods is now handled directly inside the Unreal Editor using the **Modding Tools**.
-Inside the file, you will see several entries. Only the following ones are relevant and must be checked or adjusted:
+With the Unreal Editor open, you can find the Modding Tools button in the top toolbar next to the Play controls. The button uses a notepad icon.
-set DLC_NAME=SubwaySim_SDK_Testplugin
+Click the icon to open the **Modding Tools** window.
-set LEVEL_PATH=Level/Testmap
-set ENGINE_ROOT=C:\Program Files\Epic Games\UE_5.4
+{{:manual:subwaysim:build_mod:buildmod1.png?nolink&800|}}
+The window contains several options for setting up and working with the Modding SDK. For building a mod, only the **Build Mod** section is required.
 ----
-===== Explanation of the Settings =====
+===== Build Mod Settings =====
-**DLC_NAME**
+{{:manual:subwaysim:build_mod:buildmod3.png?nolink&800|}}
-This value must match exactly the name of your plugin folder inside Simuverse_Extern.
-If the name does not match, the mod will not be built correctly.
-**LEVEL_PATH**
+The **Build Mod** section contains the following options:
-This path is required so that Unreal Engine can build the Navigation Mesh for your level.
-Enter the path to your .umap file without the file extension.
-Example:
+**Mod Name**
-Level/Testmap.umap → Level/Testmap
-**ENGINE_ROOT**
+Enter the name of the plugin that contains your mod.
-This must point to the correct installation path of Unreal Engine 5.4.
-If the path is incorrect, the build process will fail with a “path not found” error.
+The name must match the name of your plugin.
+For example:
+''Simuverse_SampleModMap''
 ----
-===== Building the Mod =====
+**Level Path**
-Once all values are set correctly, you can start the build process by double-clicking BuildMod.bat.
+If your mod contains a level, enter the path to the level inside your plugin starting from the plugin's ''Content'' folder.
-A console window will open and ask: **Build the NavMesh for level (y/N):**
+Do not include the ''Content'' folder itself in the path.
-Press y and Enter to rebuild the Navigation Mesh, or press N to skip this step.
+For example, if your level is located at:
-After that, Unreal Engine will start cooking the mod. Depending on your PC hardware and the size of the mod, this process may take some time.
+''YourPlugin/Content/Level/SampleModMap.umap''
+enter:
+''Level/SampleModMap''
+If your mod does not contain a level, this field can be left empty.
+----
+**Build Nav Mesh**
+Enable **Build Nav Mesh** if the Navigation Mesh of your level needs to be rebuilt.
+This is only necessary if changes have been made to the map that affect the navigation areas used by passengers, for example when new Nav Mesh areas have been added or existing ones have been modified.
+If no changes to the passenger navigation have been made, this option can remain disabled.
+----
+===== Building the Mod =====
+Once the required values have been entered, click **Build Mod**.
+The build process will start automatically.
+Unreal Engine will start cooking the mod. Depending on your PC hardware and the size of the mod, this process may take some time.
 When finished, the generated .pak file will automatically be moved into the Output folder located in the SDK root directory.
+{{:manual:subwaysim:build_mod:buildmod2.png?nolink&600|}}
+----
+===== Output and Lua Folder =====
+The Modding Tools window also provides two useful buttons:
+**Open Output Folder**
+Opens the Output folder containing the finished .pak files generated by the build process.
+**Open Lua Folder**
+Opens the Lua folder of the plugin currently specified under **Mod Name**.
+This is useful when working on or testing the Lua scripts of your mod.
 ----
@@ Line 71: / Line 115: @@
 ''%userprofile%\Documents\My Games\SubwaySim 2\Mods''
+----
+===== Testing Lua scripts without rebuilding the mod =====
+  * Create an empty folder for your plugin ''%userprofile%\Documents\My Games\SubwaySim 2\Mods\YourName_YourMod\''.
+  * Copy the Lua scripts from your Lua folder inside this folder maintaining the same folder structure.
+  * The game will now use the Lua scripts from this folder if they exist, otherwise it falls back to the mod itself.
 ----
@@ Line 77: / Line 129: @@
 Your mod is now ready to be used in SubwaySim 2. Have fun testing your content!
+{{page>manual:footer}}