Client Mod Template

The Client Mod Template provides an easy way to get started using Modular Assemblies without having to set everything up yourself. If this is your first time working with Modular Assemblies, you should definitely check out Getting Started with Modular Assemblies first.

Installation

1. Download Visual Studio 2022 from https://visualstudio.microsoft.com/.
2. Clone the template from https://github.com/StarCoreSE/Modular-Assemblies-Client-Mod-Template.
   1. Select Use This Template -> Create a New Repository.
      
      
   2. Give your repository a good name and description, then click Create repository.
      
      
   3. Now download the repository. You can do this through Github Desktop, Visual Studio, or by directly downloading the .zip file. Make sure that you put it in your Mods folder, located in %appdata%\Space Engineers\Mods.
      
      
3. Open your freshly created mod in Visual Studio. (open ./Modular Assemblies Client Mod Template.sln)
4. In Visual Studio, open .\Data\Scripts\ModularAssemblies\ and ensure that .\Communication\, .\ExampleDefinition.cs, and .\MasterDefinition.cs are all present. Open ExampleDefinition.cs.
   
   
5. This is a standard Modular Assemblies definition file, with a couple of fields filled in and basic functions added. You can read more about the definition file here: The Modular Definition
6. Open MasterDefinition.cs. This is where you list each of the definitions you want loaded.
   
   
7. For now, minimize Visual Studio and open Space Engineers. Go ahead and create a new world, and stop at the Mods selection screen.
8. Subscribe to Modular Assemblies Framework on the workshop and add it to your world.
9. Add your new mod to the world by double-clicking on it. It will have a house icon (see below); if you can't find it, go back to Step 2 and make sure you put it in the Mods folder.
   
   
10. Click OK and load the world. You should see a few messages pop up in chat; if not, go back to the previous step.
    
    
11. If both chat messages showed up, congrats! You're well on the way to creating your own Modular Assemblies Client Mod.

Next Steps

From here, edit the mod as you see fit. Check out the rest of the wiki for help writing your mod - if you still have questions, make a new discussion post and we'll try to help you out.
When you end up releasing it, shoot @aristeas. a message on discord and I'll make sure to list your mod in the Client Mod List.

Good luck, and happy modding!