User Tools

Site Tools


modding

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
modding [2025/06/06 19:15] shomodding [2025/08/20 10:04] (current) sho
Line 3: Line 3:
 ===== Prerequisites ===== ===== Prerequisites =====
  
-  * Install [[https://www.unrealengine.com/en-US/download|Unreal Engine]] 5.4.4 in the Epic Games Launcher. Make sure no to use any other version. {{pasted:20250603-162652.png?nolink&600}}+  * Install [[https://www.unrealengine.com/en-US/download|Unreal Engine]] 5.4.4 in the Epic Games Launcher. Make sure not to use any other version. {{pasted:20250603-162652.png?nolink&600}}
   * Install [[https://aka.ms/dotnet-core-applaunch?missing_runtime=true&arch=x86&rid=win-x86&os=win10&apphost_version=8.0.13|.NET 8.0 Runtime]]. The link should directly start the download.   * Install [[https://aka.ms/dotnet-core-applaunch?missing_runtime=true&arch=x86&rid=win-x86&os=win10&apphost_version=8.0.13|.NET 8.0 Runtime]]. The link should directly start the download.
  
-===== Create a mod =====+===== Download the Modding SDK ====
  
-  * Go to ''Modding SDK\Plugins\SubwaySim_Extern''.+  * You can find the latest and older Modding SDK Versions on [[https://github.com/SimuverseInteractive/SubwaySim2-ModdingSDK|GitHub]]. 
 + 
 +===== Creating a mod ===== 
 + 
 +  * Go to ''Modding SDK\Plugins\SubwaySim_Extern'' in the downloaded SDK.
   * Rename the folder ''Simuverse_ModTemplate'' to ''YourName_YourMod'' and inside the folder rename the file ''Simuverse_ModTemplate.uplugin'' to ''YourName_YourMod.uplugin''.   * Rename the folder ''Simuverse_ModTemplate'' to ''YourName_YourMod'' and inside the folder rename the file ''Simuverse_ModTemplate.uplugin'' to ''YourName_YourMod.uplugin''.
   * Rename all occurences of ''Simuverse_ModTemplate'' to ''YourName_YourMod'' in ''YourName_YourMod.uplugin'' and ''Lua\mod.lua''.   * Rename all occurences of ''Simuverse_ModTemplate'' to ''YourName_YourMod'' in ''YourName_YourMod.uplugin'' and ''Lua\mod.lua''.
Line 15: Line 19:
   * If you plan to create a map mod, you need to make sure that "Update Navigation Automatically" is enabled in the Editor for the NavMesh: Edit -> Editor Preferences -> Level Editor -> Miscellaneous -> Editing". {{pasted:20250606-191208.png?nolink&600}}   * If you plan to create a map mod, you need to make sure that "Update Navigation Automatically" is enabled in the Editor for the NavMesh: Edit -> Editor Preferences -> Level Editor -> Miscellaneous -> Editing". {{pasted:20250606-191208.png?nolink&600}}
   * Now you can use the content folder ''All > Plugins > YourName_YourMod Content'' for your mod content and the Lua folder ''Modding SDK\Plugins\SubwaySim_Extern\YourName_YourMod\Lua'' for your Lua scripts.   * Now you can use the content folder ''All > Plugins > YourName_YourMod Content'' for your mod content and the Lua folder ''Modding SDK\Plugins\SubwaySim_Extern\YourName_YourMod\Lua'' for your Lua scripts.
 +  * We provide assets for your mods to build upon in the ''SubwaySim2_Modding'' plugin but do not modify them as the changes will be ignored.
  
  
-===== Build a mod =====+===== Building a mod =====
  
   * Open the build script ''BuildMod.bat'' in a text editor to adjust the variables.   * Open the build script ''BuildMod.bat'' in a text editor to adjust the variables.
Line 33: Line 38:
   * The mod will be built in ''Modding SDK\Output\YourName_YourMod.pak''. Subsequent build times will be much shorter.   * The mod will be built in ''Modding SDK\Output\YourName_YourMod.pak''. Subsequent build times will be much shorter.
  
-===== Install a mod =====+===== Installing a mod =====
  
-  * Place the mod in ''%userprofile%\Documents\My Games\SubwaySim 2\Mods'' (create the folder if it does not exist).+  * Place the mod in ''%userprofile%\Documents\My Games\SubwaySim 2\Mods'' (create the folder if it does not exist). {{pasted:20250606-191859.png?nolink&300}} 
 +  * The SampleModMap can be selected in the "Choose City" menu and the SampleModVehicle can be selected as a vehicle in Berlin.
  
 ===== Testing Lua scripts without rebuilding the mod ===== ===== Testing Lua scripts without rebuilding the mod =====
Line 43: Line 49:
   * The game will now use the Lua scripts from this folder if they exist, otherwise it falls back to the mod itself.   * 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. 
  
  
  
modding.1749230112.txt.gz · Last modified: by sho

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki