Skip to content

Latest commit

 

History

History
29 lines (27 loc) · 2.88 KB

CONTRIBUTING.md

File metadata and controls

29 lines (27 loc) · 2.88 KB

If you have a GitHub account or are willing to create one and eager to learn the basics

  • Fork the repo in the top-right corner. how to fork
  • Clone your forked repo. how to clone
  • Open your local clone of your forked repo.
  • Put your mod from CustomMaps into the tqcalculator/resources/databases directory.
  • Put your modstrings.txt in a folder called text. (you can take a look at the other mods for reference)
  • Put your skill points rewarded by quests in a txt file inside the questSkillPoints folder. (you can take a look at the other mods for reference and the vanilla points)
  • Delete the assets and source directories as they are not required and would bloat the repo.
  • If you have any kind of uncommon directory structure and are familiar with git please have a look at the .gitignore in the databases directory to avoid bloating the repo.
  • Feel free to put some relevant links in a links.txt inside your mod directory. (I suggest copying one of the existing links.txt from another mod)
    • links consist of two parts separated by an arrow like this text->url:
      • the text that will be visible on the site
      • the url where clicking on the text will take you
  • If you're real fancy you can slim down the repo by:
    • Building the maven project inside tqcalculator
    • Running the resulting program (located in the target directory) ONCE
    • Deleting all database directories in tqcalculator/target/resources/databases not named modname-cleaned and remove the -cleaned from the new directories
    • Then copy the relevant directories into the tqcalculator/resources/databases directory
  • Add your images to the tqcalculator/mods/modname/images directory (take a look at the other mods to reproduce the correct structure
  • Commit your changes with a message like [database] add -modname-. how to commit
  • Push your local clone. pushing a repo
  • Create a pull request. (you can take a look at the example pull request)
  • That's it you're done, you can now wait for someone to merge the pull and push the result

If you do not want to create a Github account

If you're just lazy