These docs will be for modders to be able to extend certain features, and maintain this mod with new releases of Stellaris (hopefully).

Get started

Get set up with git, Stellaris, and this mod

How issues are organized

Milestones: There are a few milestones. Sort them alphabetically. At the time of this writing (Jan 25, 2024), the milestones are incremental groups of work leading up to a usable Steam release, and then a stable 3.10 release.

Issue tags: Please hover over the issue tags to get a description of what they're about. 3.10 upgrade are issues where we have 3.9-related code to maintain and make compatible with 3.10. 3.10 new content are issues where we are adding 3.10 content to the mod, mainly, all the new traits. @_o

How to pick up an issue

Firstly, look at the issue. Is it clear what needs doing? Ask clarifying questions if it is not clear. Most of the issues I have created in sort of a rushed way because I wanted to capture the ideas and the scope of the work. Then, if you think it's something you would like to do, leave a comment that you're starting it.

Next, create a branch on your local machine for the issue. Name the branch along the lines of the issue topic, but not too long. Do your work in it and push your branch and changes regularly to the repo.

Take your time and do a good job. Remember this is for FUN because we love gaming, Stellaris, and this mod is particularly awesome and we want to be able to use it and let the good times roll.

If you get overwhelmed then just leave a comment on the issue saying that it's all a bit much. Do you need some help? Just say so. Did you lose interest? That's OK. You're gonna take a break and spend your free time how you like. Only you can decide when you have had too much or when you have lots of energy.

Remember this is all for fun. If it feels like work then do something else! It's that simple.

Branch pattern

The branches are based on the milestones. When the milestones are all complete, then we merge that into main and share with community members, and/or Steam subscribers if appropriate. A milestone branch can have several sub-branches. The strategy is tackle issues for the milestone, make branches for them, and then merge requests to the milestone branch once the work is done.

Current branches

Main: Contains the original 3.9 version of the mod. Contributors shouldn't try to make changes to this.

3.0a_alpha: Make branches from here, and tackle issues related to that milestone.

Tags

Tags are applied each time the mod is uploaded to Steam.

The upload process consists of me (@openly-retro) copying over the necessary files to another folder, which is being tracked by my game launcher, and upload it.

For each upload to Steam, I'll make a tag in this repo.