=============
Before contributing to this project, please ensure that you read the following guidelines. It's crucial to have your development environment configured correctly. Additionally, pull requests that do not adhere to the specified format will not be accepted.
Follow the steps here: https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository
2) Setup in IntelliJ IDEA
- Open the template's root folder as a new project in IDEA. This is the folder that contains this README.md file and the gradlew executable.
- If your default JVM/JDK is not Java 21 you will encounter an error when opening the project. This error is fixed by going to
File > Settings > Build, Execution, Deployment > Build Tools > Gradle > Gradle JVM
and changing the value to a valid Java 21 JVM. You will also need to set the Project SDK to Java 21. This can be done by going toFile > Project Structure > Project SDK
. Once both have been set open the Gradle tab in IDEA and click the refresh button to reload the project. - Open your Run/Debug Configurations. Under the
Application
category there should now be options to run Fabric and NeoForge projects. Select one of the client options and try to run it. - Assuming you were able to run the game in step 3 your workspace should now be set up.
Eclipse/VSCode not supported
Please do at least one build via Tasks > build > build
to have the spotless plugin format all code before submitting the PR.
Follow the steps here: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request