CONTRIBUTING.md

How to contribute your mod to this database:

1. In the top right, select "Fork" and fork the repository to your own account. After a bit you will be redirected to your fork.

2. Click into the category folder that you want to place your mod in.

3. In the top right, click "Add file" then select "Create new file".

4. Type your mod's GUID (unique identifier, generally SomethingLikeThis using only alpha-numeric characters) then a slash (/), then the version number of your mod followed by .json. Example: MyExampleMod/0.5.2.json

5. Copy the template mod entry from below and paste it into the editing area. Proceed to fill out all the fields, using other existing mods as a reference if needed. More information on the install steps and dependencies can be found below too.

{
  "Name": "Your Mod Name",
  "VersionNumber": "1.0.0",
  "Description": "Long description of your mod. Shows on the sidebar when this mod is selected",
  "ShortDescription": "Short description of your mod. Shows under your mod's name in the mod list.",
  "Authors": ["Author 1", "Author 2"],
  "IconUrl": "Link to the icon you want to use. Includes the file extension",
  "SourceUrl": "Link to the GitHub / BoneTome page the mod is sourced from",
  "DownloadUrl": "Download URL for the mod",
  "InstallationSteps": ["extract $GAME_DIR"],
  "Dependencies": {
    "Deli": "^0.2.5"
  }
}

Install Steps:

• extract [location]: extracts the downloaded archive to the folder specified. Example: extract $GAME_DIR/VirtualObjects
• move [location]: Moves the downloaded file to the specified location. Example: move mods/MyMod_0.2.5.deli

Version numbers and dependencies:

• You can mark this mod's version as a beta by adding a - after the version number and then the beta name. e.g. 1.1.5-beta2. These versions will only be visible to people who have opted in to seeing mod beta versions.
• Dependencies are standard semantic version ranges. Place the GUID of the mod you need to install before yours on the left and then the required version number on the right. Generally you want to prefix the version number with a ^. More complex rules can be found here: https://devhints.io/semver

6. Once you're done filling out the information, scroll to the bottom and commit your changes (keeping the 'commit directly to main' option selected)

7. Return to the main page of your fork by clicking on the name in the top left

8. After commiting this new file, there is now a new option to create a pull request back into the main repository. Click the new button and then the green "create pull request" button on the following page.

9. Enter some details about the file you've just added (your name, your mods's name) and then create the pull request.

10. The request will be reviewed by someone with permissions and when it is accepted (merged) your mod will have been added to the database!