Steam Community :: Guide :: Monitor file changes with GitHub

Store Page

Stellaris

All Discussions Screenshots Artwork Broadcasts Videos Workshop News Guides Reviews

Stellaris > Guides > Ryuichiro's Guides

Not enough ratings

Monitor file changes with GitHub

By Ryuichiro

How to setup a GitHub repository to keep track of files changes from official patches.

This is targeted at modders to help with:
- Identifying which mods can have their supported version increased without any changes.
- Finding lines in overwritten files that have to be updated to make their mods work with a new patch.

Award

Created by

Ryuichiro
Online

Category: Modding or Configuration

Languages: English

Posted

Updated

9 Jun, 2019 @ 5:09pm

9 Jun, 2019 @ 5:19pm

335	Unique Visitors
9	Current Favorites

Guide Index

Overview

Required Software

Setup

Update

Taking things further

Comments

Required Software

This tutorial is done for GitHub Desktop, but if you know how to work with another Git client you should be able to easily adjust everything to that.

Download[desktop.github.com]

Setup

Install GitHub Desktop
Create a new .txt file in your "...\Steam\steamapps\common\Stellaris" folder
rename the file to .gitignore
edit the file and copy the following text into it:
/* !/.gitignore !/common/ !/events/ !/localisation/
If your mods contain files in different subfolder add them as additional line at the end e.g.
!/interface/
Start GitHub Desktop
Select File -> New repository
Name the repository Stellaris and set the Local path to your steams common folder
Leave Git ignore as None so it will use the one we created earlier
Create the repository

Update

Each time a new patch is released you:

Open GitHub Desktop
Select the Stellaris repository
You can now see all the changed files in the left
Put the Name of the new patch into the Summary in the bottom left and click "Commit to master"
Switch over to History and you can see all the changed files from the patches you tracked

Taking things further

If you want to see all of this in GitHubs Web environment you can Publish the repository.
If you want a bit more structure you can create branches for bigger patches and only merge into master when a big patch like Wolfe is released.

5 Comments

< >

Ryuichiro [author] 27 Jan, 2020 @ 1:11pm

You can use Git locally and GitHub Desktop is just one of many applications which provides a graphical UI for Git. It is made by the provider of GitHub, so it encourages usage of their online hosting service, but it is by no means mandatory.
I thought that my screenshots covered every crucial step, where should I add additional ones.

FirePrince 27 Jan, 2020 @ 9:58am

I am not familiar with GitHub, if I were I would certainly not read your guide. My repository was created under ".\steamapps\common\Stellaris\Stellaris\" because I lack the point to specify only the parent folder when creating it. It is also not usually to let a third-party tool unrestricted access to the original folder structure of a game. There is now a ".git" folder in the game. So my comment was a lag of understanding how GitHub Desktop works (you desc. without images is really at the minimum, you have zero explanation what is going on). I never heard you can use GitHub offline and it is also not to be expected (there is also no word in the very first GitHub tutorial). Thanks

Ryuichiro [author] 27 Jan, 2020 @ 8:02am

Trolling?
1. This is targeted at modders.
2. It shows how to filter which folders you want to sync.
3. It works completely locally, unless you want to use GitHubs Web environment.

FirePrince 27 Jan, 2020 @ 6:17am

This means every fucking user uploads his damn same standard folders to Github!? Yeah that's fucking effective!!

1yur 10 Jun, 2019 @ 12:53am

https://www.gitkraken.com/ - a very cool git client.

< >