40 lines
3.0 KiB
Markdown
40 lines
3.0 KiB
Markdown
# Example Mod
|
|
|
|
Template for making Babric mods for BTA!
|
|
|
|
**Note: *DO NOT fork this repository unless you want to contribute!***
|
|
|
|
## Prerequisites
|
|
- JDK for Java 21 ([Eclipse Temurin](https://adoptium.net/temurin/releases/) recommended)
|
|
- [Intellij IDEA](https://www.jetbrains.com/idea/download/) (Scroll down for the free community edition, if using linux **DO NOT** use the flatpak distribution)
|
|
- Minecraft Development plugin (Optional, but highly recommended)
|
|
|
|
## Setup instructions
|
|
|
|
|
|
1. Click the `Use this template` button on this repo's page above (Will only appear if logged in). Choose `Create a new repository`, you will be redirected to a new page. Enter your repo's name and description, and hit `Create repository`.
|
|
To get your project, open IntelliJ IDEA and click `Clone Repository` (`Get from VCS` on older versions). Select `Repository URL` and enter your repo's url
|
|
|
|
2. After the project has finished importing, close it and open it again.
|
|
If that does not work, open the right sidebar with `Gradle` on it, open `Tasks` > `fabric` and run `ideaSyncTask`.
|
|
|
|
3. Create a new run configuration by going in `Run > Edit Configurations`.
|
|
Then click on the plus icon and select Gradle. In the `Tasks and Arguments` field enter `build`.
|
|
Running it will build your finished jar files and put them in `build/libs/`.
|
|
|
|
4. Lastly, open `File` > `Settings` and head to `Build, Execution, Development` > `Build Tools` > `Gradle`.
|
|
Make sure `Build and run using` and `Run tests using` is set to `Gradle`.
|
|
|
|
5. Done! Now, all that's left is to change every mention of `quetzal` and `ciomek` to your own mod id and mod group, respectively. Happy modding!
|
|
|
|
## Tips
|
|
|
|
1. If you quetzal't already you should join the BTA modding discord! https://discord.gg/FTUNJhswBT
|
|
2. You can set your username when launching the client run configuration by setting `--username <username>` in your program arguments.
|
|
3. When launching the server run configuration you may want to remove the `nogui` program argument in order to see the regular server GUI.
|
|
4. In Intellij you can double press shift or press ctrl+N to search class files, change the search from the default `Project Files` to `All Places` you can easily explore the classes for your dependencies and even BTA itself.
|
|
5. In Intellij if ctrl+left-click on a field or method you can quickly get information on when and where that field or method is assign or used.
|
|
6. Ensure IntelliJ is updated to the latest version. This is important because this template uses the latest Gradle version and if your IntelliJ installation is outdated, it may not support the latest version.
|
|
7. In the `quetzal.mixins.json` you'll see `"compatibilityLevel": "JAVA_${java}",` along with an error message from the `Minecraft Development` plugin stating `Cannot resolve compatibility level 'JAVA_${java}'`. You can safely ignore this. The Gradle build system has been set up to grab the Java version from your `gradle.properties` and replace `${java}` with it. So the compiled binary will properly have it as `JAVA_8`.
|
|
|