CONTRIBUTING.md

Getting Started

You'll need git installed and configured.
Feel free to use my personally created "mule" save to create your builds.
Saves containing unobtainable/cut-content items will not be accepted.

1. Fork the repository: Start by forking the repository by clicking the button above the "About" section or by using this link

2. Clone your fork: Clone your fork to your local machine. This allows you to work on the project from your own computer.

   git clone https://github.com/<your-username>/Elden-Ring-Saves.git

3. (Optional) Create a branch: Before making your changes, create and switch to a new branch. Alternatively, simply commit to the main branch.

   git checkout -b <your-new-branch-name>

Making Changes

1. Make your changes:
   a. Add your save files to the save-files directory.
   

   Add a prefix to save containing folders for sorting purposes - if your saves don't fit into existing categories either make up your own or just use "COMMUNITY".
   Folder name format: <COLLECTION_PREFIX>-<NUM_IN_CATEGORY>--<SAVE_NAME>

   b. Add a entry to the "Showcase" section in the README with:

   • Screenshots of your characters's status pages
   • (Optional): NG+/Journey level
   • (Optional): Links to related videos
   • (Optional): Whatever else you want

2. Commit your changes: Once you're happy with your changes, commit them to your branch.

   git add .
   git commit -m "Add/modify save (<SAVE_FOLDER_NAME>)"

3. Push your changes: Push your changes to your fork on GitHub.

   git push origin <your-new-branch-name>

4. Open a pull request: Go to your fork and click on the "Contribute" dropdown, then the "Open pull request" button.
   You can also open one on this page.
   I'll look into merging your saves as soon as I have time.

Cheat Engine Tips

Get the table here.

Super useful for creating builds, I recommend setting up hotkeys for the NPC menus - it saves a lot of time.

Locking playtime to 0