Skip to content

Latest commit

 

History

History
49 lines (33 loc) · 2.66 KB

README.md

File metadata and controls

49 lines (33 loc) · 2.66 KB
Raw

Apply Patch

  1. Click Code
  2. Click Download ZIP
  3. Extract to game folder and Replace All.

How To Contribute

TLDR 3 steps.

Fork the repository.
Make the changes.
Submit a pull request to the project owner.

If everything looks good and doesn't break things I'll merge it in.

Longer Version:

Things that are needed:

  • VSCode Make sure you check all the boxes for context menus. image
  • The Game
  • Git (Use the default for everything. Just keep clicking Next)
  • Motivation to learn

Installation:

  1. Fork the repo using the fork button at the top. Click Code > HTTPS > Copy URL.
  2. Right click on the game folder and click 'Open with VSCode' (Shift+Right_Click if you are on Windows 11)
  3. Click on the Source Control Button and click initialize repository.

image

  1. At the top click on Terminal > New Terminal. Enter the following: git clone [URL_YOU_COPIED_ABOVE].
  2. Copy the contents of the new folder created with git clone into the game folder and replace all.
  3. Your source control menu should be good to go and look like this.

image

Now you are all setup, all you need to do is play the game and look for any changes that need to be made. Stuff like spelling errors, wrong names, inconsistencies, spacing issues, etc.

  1. Use the FIND functionality to search for what you are trying to fix. For example if a character's name is wrong, type that into the search menu and start looking, then make the change. Try not to mess with any scripts or variables you might see.

image

  1. After you are satisfied with your changes it's time to put in a PR. Go to source control to see all your changes. Add a message and click the Commit button to save them all.

image

  1. Click Sync to push your changes to your fork. Now all that's left is to put in a pull request.
  2. Go to Pull Requests > New Pull Requests. Look at the arrow, your fork should be pointing to the original repo (mine). Add in details on what you fixed and Submit. If everything looks good I'll merge it in and you would have successfully contributed.

Got questions? Just shoot me a message, more than happy to walk you through any of the tools.