Skip to content

Latest commit

 

History

History
26 lines (21 loc) · 1.5 KB

CONTRIBUTING.md

File metadata and controls

26 lines (21 loc) · 1.5 KB

How to contribute to TPA++ (for developers)

  1. Just clone the repository into anywhere on your computer.
  2. Open up Intellij IDEA (don't know about Eclipse) and open TPA++ as a gradle project.
  3. Wait for IDEA to configure the gradle project
  4. Happy Modding!

How to open TPA++ as a Gradle Project

  1. In Intellij IDEA, click File -> Open...

  2. Now in the window that opened, find where you cloned TPA++

  3. Then click on the file called "build.gradle". You may see more than one "build.gradle" but it is important you click on the one in the root directory. Do NOT click on the build.gradle inside common, fabric, forge, etc.

  4. Just wait until gradle has finished building everything, if you open up the "Build" tab and it says BUILD SUCCESSFUL, you should be good to go.

    Note:

    If you get an error somewhere along the lines of "Gradle has run out of memory" try adjusting the value in the file "gradle.properties"
    There should be a line called "org.gradle.jvmargs" near or at the very top. In here you can change the value after the -Xmx to something else.
    It is measured in megabytes, for example 6GB would be 6144M (which it is set to by default), and 10GB would be 10240M. You can calculate this by doing: Megabytes of RAM = 1024 * (how many gigabytes you want to allocate to gradle).

Pull Request

If you want to submit a pull request, you must comply with the following requirements:

  • IDE: Intellij IDEA
  • Compiler: Java 21 +
  • Don't modify gradle related files
  • Don't modify detekt.yml