Contribution Guide

Jump to bottom Edit New page

Invalid edited this page Sep 3, 2023 · 1 revision

prerequsites:

(extremely recommended) github Desktop, GitExtentions, or something similar
knowing the layout of SE mod files
enough space to download the entire git repo (~5gb)?

Step 1:

Fork this repository to a folder on your computer. Name it something like SCModRepository-Yourname. This is where your edits can be made, and is apparently how actual projects do it.

Step 2:

Make a branch for the changes you want to do on your local repository. (i.e. SCModRepository-Yourname/BuffMyFavoriteGunPlease) Use your local repository's Main branch to keep in sync with starcore's Main branch, it makes edits much easier. You just click the button on github to sync it.

Step 3:

To test your changes ingame, Copy the mod you want to edit to your %Appdata%/SpaceEngineers/Mods folder.

Step 4:

Make your edits and throw it back in the repository folder. you can use the .bat file included in the repository to link your local Space Engineers mods with the ones in the repository.

Step 5:

Submit a pull request so that the branch can be merged into the SCModRepository/master one.