Skip to content

Belisarian/ReunitingLostKin

Repository files navigation

RLK

Getting Set Up

You just need to have a GitHub account and the GitHub Desktop application installed on your PC.

Once the two above are done, open up GitHub Desktop and login to your account. Should be in "File -> Options". Then, in GitHub Desktop, press "File -> Clone Repository". This will make a "clone" of the repository of data on your own computer, which you can edit and change at will, locally. Select "URL", decide a local path, and then in the URL slot type in "Belisarian/ReunitingLostKin". Press "Clone", and it will be added onto your PC on the path decided!

And now you have the entire repository of ReunitingLostKin installed onto your PC. I recommend setting the "local path" as the ReunitingLostKin folder in your MyMod folder, to make everything even easier.

Making Edits

Before you get started making edits to the mod, you've gotta do two things. First off, in GitHub Desktop, where it says "Current repository", make sure it says the ReunitingLostKin repo. And in "Current branch", select it and press "New branch", to make your own new "branch" of data. This will help us with merging all the different flows of changes; if several people edit the same table or file, we'll be able to see who did what and how to combine them. Then, in RPFM, open up your ReunitingLostKin MyMod, clear out everything within it, and use "Add Folder... ->", and target the ReunitingLostKin MyMod folder. This will make sure your local copy of RPFM is up-to-date with the latest version of ReunitingLostKin before you get working.

At that point, your RPFM .pack is 100% up-to-date with our working version, and you can start making edits within RPFM. Once you're done and have tested, simply right click your .pack in RPFM, press "Extract", and everything will automatically be sent to the MyMod folder.

VERY IMPORTANT: If you delete a file in RPFM and use extract, RPFM will not delete the file locally, and so GitHub won't know to delete the file. You can just wipe the entire MyMod local folder prior to extracting the contents in RPFM, so you can assure your .pack file's contents are the only things on the repo.

Once you've made your changes there, make a "Commit". In GitHub Desktop, it will see all of the various changed files in the left column, and below that it will ask for a Summary and Description. Give as regular commits as you can so it's easier to track what went on, and give some good details as well. Once you're done with all your commits and you're ready to send your new branch for submission, press "Publish Branch", which will submit it into the GitHub repo for others to see. If you've already pressed "Publish Branch", use "Push Branch", to "push" the local files you've changed onto the public repo.

IMPORTANT: Make sure you have "Disable UUID Regeneration on DB Tables" ticked in RPFM's preferences, causes dumb issues with github otherwise

GETTING THE PACK

Instead of dealing with the whole MyMod and working data folder nonsense, you can also grab the latest compiled .pack from https://github.com/Belisarian/ReunitingLostKin/releases

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages