@@ -4,10 +4,52 @@ A template to allow easy usage of the Meteor Addon API.
44
55### How to use
66
7- - Clone this project
8- - Use this template to create new modules/commands
9- - Build the executable using the gradle ` build ` task.
10- - Run the mod with Meteor.
7+ #### Use GitHub Template (Recommended)
8+
9+ - Click the green ` Use this template ` button in the top right corner of this page.
10+ This will create a new repository with this template and a clean history.
11+
12+ #### Clone Manually
13+
14+ - Alternatively, clone this repository using these commands for a clean history:
15+ ``` bash
16+ git clone --depth 1 https://github.com/MeteorDevelopment/meteor-addon-template your-addon-name
17+ cd your-addon-name
18+ rm -rf .git
19+ git init
20+ git add .
21+ git commit -m " Initial commit from template"
22+ ```
23+
24+ #### Development
25+
26+ - Use this template to add custom modules, commands, HUDs, and other features to Meteor Client.
27+ - To test, run the ` Minecraft Client ` configuration in your IDE.
28+ This will start a Minecraft client with the Meteor Client mod and your addon loaded.
29+ - To build, run the gradle ` build ` task. This will create a JAR file in the ` build/libs ` folder.
30+ - Move the JAR file to the ` mods ` folder of your Minecraft installation, alongside the Meteor Client mod and run the
31+ game.
32+
33+ ### Updating to newer Minecraft versions
34+
35+ To update this template to a newer Minecraft version, follow these steps:
36+
37+ 1 . Ensure a Meteor Client snapshot is available for the new Minecraft version.
38+ 2 . Update ` gradle.properties ` :
39+ - Set ` minecraft_version ` , ` yarn_mappings ` and ` loader_version ` to the new version.
40+ - Update any additional dependencies accordingly.
41+ 3 . Update Loom:
42+ - Change the ` loom_version ` in ` build.gradle.kts ` to the latest version compatible with the new Minecraft version.
43+ 4 . Update the Gradle wrapper:
44+ - You can find the latest Gradle version [ here] ( https://gradle.org/releases/ ) .
45+ - Run the ` ./gradlew wrapper --gradle-version <version>; ./gradlew wrapper ` command to update the wrapper script.
46+ 5 . Update your source code:
47+ - Adjust for Minecraft or Yarn mapping changes: method names, imports, mixins, etc.
48+ - Check for Meteor Client API changes that may affect your addon by comparing against the
49+ [ master branch] ( https://github.com/MeteorDevelopment/meteor-client/tree/master ) .
50+ 6 . Build and test:
51+ - Run the gradle ` build ` task.
52+ - Confirm the build succeeds and your addon works with the new Minecraft version.
1153
1254### Project structure
1355
@@ -42,13 +84,13 @@ A template to allow easy usage of the Meteor Addon API.
4284│ ╰── fabric.mod.json
4385│── .editorconfig
4486│── .gitignore
45- │── build.gradle
87+ │── build.gradle.kts
4688│── gradle.properties
4789│── gradlew
4890│── gradlew.bat
4991│── LICENSE
5092│── README.md
51- ╰── settings.gradle
93+ ╰── settings.gradle.kts
5294```
5395
5496This is the default project structure. Each folder/file has a specific purpose.
0 commit comments