This boilerplate includes everything used to start developing modifications for Stellaris and publish them on the Steam workshop.
- Fork this template repository and rename it.
- Clone it locally on your machine (I recommend using GitHub Desktop to do so, putting it in the default location
~/Documents/GitHub/your-mod-repository-name). - Use the Stellaris launcher to create your local mod.
- Upload it to the workshop. This sets the workshop-id, and yes it will be empty on the workshop for now. If you do not want that, you will need to update the
descriptor.modfile manually later on as uploading for the first time changes it. - Copy the new mod folder to
./mod/(you will work on your mod from here). You can seestellaris-mod-template/as an example folder (you may delete or leave it). - Work on your mod. You will probably use VSCode to do so, opening the root folder of the repository.
- Whenever you want to test your mod ingame or upload a new version to the workshop, execute either
copy-latest-to-local-mod.shoroverwrite-local-mod-with-latest.shusing bash (e.g. git bash). The second option overwrites any content that is only present there, so make sure you know what you're doing (e.g. you deleted a file that isn't necessary any more). Alternatively you can just copy the mod manually (tedious and unnecessary, the scripts work from anywhere). - Commit and push your changes if you're working alone. If you're part of a team of modders, make sure you adhere to their git workflow. This may necessitate doing so more often or entirely different steps than detailed here.
- Use the launcher to upload your mod, updating it on the workshop. Make sure to include a new thumbnail, if you're updating to a new game version. If you skipped Step 2. initially this is the time to update the
descriptor.modfile from the/Stellaris/mod/your-mod-folder-namefolder. - Don't forget to update the Change Notes on the workshop and leave a comment informing your subscribers of the latest changes.
- Upload and re-order new screenshots, if necessary.
- Update your description, if necessary.
- Repeat from Step 6. whenever you want to continue modding.
Self-explanatory. You will use git to clone the repository. As stated before I recommend using GitHub Desktop as well if you want a UI to go along with it. Using GitHub to manage your projects will allow you to work together with other modders more easily. Git also comes with its own bash, which will allow you to use the scripts I have included. It is possible to not use git and GitHub Desktop with this setup, but it is very much recommended to do so.
VSCode is the preferred editor to mod anything Stellaris, excluding graphical assets.
Install "CWTools - Paradox Language Services" (tboby.cwtools-vscode) from Thomas Boby.
It includes syntax highlighting and context-sensitive code completion for Stellaris.
It and its Extension Pack are also part of the recommended workspace. Just follow the instructions by VSCode.
NotePad++ is useful, if you wish to quickly search through the vanilla game files in a different program than VSCode.
Use Ctrl+Shift+F to quickly open a search through multiple files.
The text editor will remember previous search queries in the chosen vanilla folders and any restrictions (like .txt and .yml files) you entered last time you opened it, so it is a very convenient tool to quickly get back to anything you searched up before (this includes keeping the files as tabs). This way you have access to a great library of examples.
cough So far Paint has been (mostly) enough to manage thumbnails and screenshots. If you plan to do anything more, you should use something different.
I like Gimp, but you can use any other kind of similar software to edit .dds files which is necessary if you wish to add pictures to events, etc. If you want to edit 3D assets, I am sorry, but I cannot help you. Ask somebody else, for example on the Stellaris Modding Den Discord (linked below).
Check out the amazing Stellaris Wiki, which provides information on basically everything related to modding Stellaris. If you would like to speak to other modders, I recommend joining the Stellaris Modding Den Discord where you can chat with like-minded creators.
Stellaris uses the Orbitron Font Family which can be downloaded here. You may want to use it to style your mod more closely to the vanilla game (e.g. for the thumbnail). Installing fonts on Windows is as easy as searching for "fonts" on the start menu or native search bar, then adding the font files from the zip archive into the Windows collection.
This section covers the Steam Workshop for Stellaris.
Thumbnails are required to adhere to a file size of 1 MB or below. They also need to be in .png format and located in the mod's top directory, with "thumbnail.png" as their file name. An example thumbnail design is included.
An exemplary description is included. It uses banners to direct users to other mods of yours. You can also direct them to your github repository, if you would like to collect bug reports and feature requests there (much easier tracking than them on the steam workshop). Steam has a formatting help page which will prove useful.
Don't forget to upload and sort some screenshots showcasing your mod. Do take note that re-ordering screenshots will only work when you do not upload any at the same time. New screenshots are sorted at the end automatically.
A collection of example change notes as well as some tips on how to version your mod are included as well .