Skip to content

Commit e8ae180

Browse files
RegularLunarRegularLunar
authored
Initial commit
0 parents  commit e8ae180

22 files changed

Lines changed: 1087 additions & 0 deletions

‎.editorconfig‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
[*]
2+
charset = utf-8
3+
indent_style = space
4+
insert_final_newline = true
5+
trim_trailing_whitespace = true
6+
indent_size = 4
7+
ij_continuation_indent_size = 4
8+
9+
[*.{json,yml}]
10+
indent_size = 2
11+
12+
[*.md]
13+
trim_trailing_whitespace = false

‎.github/workflows/dev_build.yml‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: Publish Development Build
2+
on: push
3+
4+
jobs:
5+
build:
6+
runs-on: ubuntu-latest
7+
8+
steps:
9+
- name: Checkout Repository
10+
uses: actions/checkout@v4
11+
with:
12+
persist-credentials: false
13+
14+
- name: Set up Gradle
15+
uses: gradle/actions/setup-gradle@v4
16+
17+
- name: Set up Java
18+
uses: actions/setup-java@v4
19+
with:
20+
distribution: 'temurin'
21+
java-version: 21
22+
23+
- name: Build with Gradle
24+
run: ./gradlew build
25+
26+
- name: Release
27+
uses: softprops/action-gh-release@v2
28+
with:
29+
token: ${{ secrets.GITHUB_TOKEN }}
30+
tag_name: snapshot
31+
name: Dev Build
32+
prerelease: true
33+
files: |
34+
./build/libs/*.jar

‎.github/workflows/pull_request.yml‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: Build Pull Request Artifacts
2+
on: pull_request
3+
4+
jobs:
5+
build:
6+
runs-on: ubuntu-latest
7+
8+
steps:
9+
- name: Checkout Repository
10+
uses: actions/checkout@v4
11+
with:
12+
persist-credentials: false
13+
14+
- name: Set up Gradle
15+
uses: gradle/actions/setup-gradle@v4
16+
17+
- name: Set up Java
18+
uses: actions/setup-java@v4
19+
with:
20+
distribution: 'temurin'
21+
java-version: 21
22+
23+
- name: Build with Gradle
24+
run: ./gradlew build
25+
26+
- name: Release
27+
uses: actions/upload-artifact@v4
28+
with:
29+
name: Artifacts
30+
path: build/libs/

‎.gitignore‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# gradle
2+
3+
.gradle/
4+
build/
5+
out/
6+
classes/
7+
8+
# eclipse
9+
10+
*.launch
11+
12+
# idea
13+
14+
.idea/
15+
*.iml
16+
*.ipr
17+
*.iws
18+
19+
# vscode
20+
21+
.settings/
22+
.vscode/
23+
bin/
24+
.classpath
25+
.project
26+
27+
# macos
28+
29+
*.DS_Store
30+
31+
# fabric
32+
33+
run/

‎LICENSE‎

Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
Creative Commons Legal Code
2+
3+
CC0 1.0 Universal
4+
5+
CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
6+
LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
7+
ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
8+
INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
9+
REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
10+
PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
11+
THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
12+
HEREUNDER.
13+
14+
Statement of Purpose
15+
16+
The laws of most jurisdictions throughout the world automatically confer
17+
exclusive Copyright and Related Rights (defined below) upon the creator
18+
and subsequent owner(s) (each and all, an "owner") of an original work of
19+
authorship and/or a database (each, a "Work").
20+
21+
Certain owners wish to permanently relinquish those rights to a Work for
22+
the purpose of contributing to a commons of creative, cultural and
23+
scientific works ("Commons") that the public can reliably and without fear
24+
of later claims of infringement build upon, modify, incorporate in other
25+
works, reuse and redistribute as freely as possible in any form whatsoever
26+
and for any purposes, including without limitation commercial purposes.
27+
These owners may contribute to the Commons to promote the ideal of a free
28+
culture and the further production of creative, cultural and scientific
29+
works, or to gain reputation or greater distribution for their Work in
30+
part through the use and efforts of others.
31+
32+
For these and/or other purposes and motivations, and without any
33+
expectation of additional consideration or compensation, the person
34+
associating CC0 with a Work (the "Affirmer"), to the extent that he or she
35+
is an owner of Copyright and Related Rights in the Work, voluntarily
36+
elects to apply CC0 to the Work and publicly distribute the Work under its
37+
terms, with knowledge of his or her Copyright and Related Rights in the
38+
Work and the meaning and intended legal effect of CC0 on those rights.
39+
40+
1. Copyright and Related Rights. A Work made available under CC0 may be
41+
protected by copyright and related or neighboring rights ("Copyright and
42+
Related Rights"). Copyright and Related Rights include, but are not
43+
limited to, the following:
44+
45+
i. the right to reproduce, adapt, distribute, perform, display,
46+
communicate, and translate a Work;
47+
ii. moral rights retained by the original author(s) and/or performer(s);
48+
iii. publicity and privacy rights pertaining to a person's image or
49+
likeness depicted in a Work;
50+
iv. rights protecting against unfair competition in regards to a Work,
51+
subject to the limitations in paragraph 4(a), below;
52+
v. rights protecting the extraction, dissemination, use and reuse of data
53+
in a Work;
54+
vi. database rights (such as those arising under Directive 96/9/EC of the
55+
European Parliament and of the Council of 11 March 1996 on the legal
56+
protection of databases, and under any national implementation
57+
thereof, including any amended or successor version of such
58+
directive); and
59+
vii. other similar, equivalent or corresponding rights throughout the
60+
world based on applicable law or treaty, and any national
61+
implementations thereof.
62+
63+
2. Waiver. To the greatest extent permitted by, but not in contravention
64+
of, applicable law, Affirmer hereby overtly, fully, permanently,
65+
irrevocably and unconditionally waives, abandons, and surrenders all of
66+
Affirmer's Copyright and Related Rights and associated claims and causes
67+
of action, whether now known or unknown (including existing as well as
68+
future claims and causes of action), in the Work (i) in all territories
69+
worldwide, (ii) for the maximum duration provided by applicable law or
70+
treaty (including future time extensions), (iii) in any current or future
71+
medium and for any number of copies, and (iv) for any purpose whatsoever,
72+
including without limitation commercial, advertising or promotional
73+
purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
74+
member of the public at large and to the detriment of Affirmer's heirs and
75+
successors, fully intending that such Waiver shall not be subject to
76+
revocation, rescission, cancellation, termination, or any other legal or
77+
equitable action to disrupt the quiet enjoyment of the Work by the public
78+
as contemplated by Affirmer's express Statement of Purpose.
79+
80+
3. Public License Fallback. Should any part of the Waiver for any reason
81+
be judged legally invalid or ineffective under applicable law, then the
82+
Waiver shall be preserved to the maximum extent permitted taking into
83+
account Affirmer's express Statement of Purpose. In addition, to the
84+
extent the Waiver is so judged Affirmer hereby grants to each affected
85+
person a royalty-free, non transferable, non sublicensable, non exclusive,
86+
irrevocable and unconditional license to exercise Affirmer's Copyright and
87+
Related Rights in the Work (i) in all territories worldwide, (ii) for the
88+
maximum duration provided by applicable law or treaty (including future
89+
time extensions), (iii) in any current or future medium and for any number
90+
of copies, and (iv) for any purpose whatsoever, including without
91+
limitation commercial, advertising or promotional purposes (the
92+
"License"). The License shall be deemed effective as of the date CC0 was
93+
applied by Affirmer to the Work. Should any part of the License for any
94+
reason be judged legally invalid or ineffective under applicable law, such
95+
partial invalidity or ineffectiveness shall not invalidate the remainder
96+
of the License, and in such case Affirmer hereby affirms that he or she
97+
will not (i) exercise any of his or her remaining Copyright and Related
98+
Rights in the Work or (ii) assert any associated claims and causes of
99+
action with respect to the Work, in either case contrary to Affirmer's
100+
express Statement of Purpose.
101+
102+
4. Limitations and Disclaimers.
103+
104+
a. No trademark or patent rights held by Affirmer are waived, abandoned,
105+
surrendered, licensed or otherwise affected by this document.
106+
b. Affirmer offers the Work as-is and makes no representations or
107+
warranties of any kind concerning the Work, express, implied,
108+
statutory or otherwise, including without limitation warranties of
109+
title, merchantability, fitness for a particular purpose, non
110+
infringement, or the absence of latent or other defects, accuracy, or
111+
the present or absence of errors, whether or not discoverable, all to
112+
the greatest extent permissible under applicable law.
113+
c. Affirmer disclaims responsibility for clearing rights of other persons
114+
that may apply to the Work or any use thereof, including without
115+
limitation any person's Copyright and Related Rights in the Work.
116+
Further, Affirmer disclaims responsibility for obtaining any necessary
117+
consents, permissions or other rights required for any use of the
118+
Work.
119+
d. Affirmer understands and acknowledges that Creative Commons is not a
120+
party to this document and has no duty or obligation with respect to
121+
this CC0 or use of the Work.

‎README.md‎

Lines changed: 140 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
1+
# Meteor Addon Template
2+
3+
A template to allow easy usage of the Meteor Addon API.
4+
5+
### How to use
6+
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/libs.versions.toml` (the versions catalog):
39+
- Set the version entries to the new versions. Common keys to update are:
40+
- `versions.minecraft` - Minecraft version
41+
- `versions.yarn-mappings` - Yarn mappings
42+
- `versions.fabric-loader` - Fabric loader version
43+
- `versions.meteor` - Meteor Client snapshot version
44+
- If your addon depends on other libraries listed under the `[libraries]` section, update their versions there as
45+
needed.
46+
- After editing, refresh Gradle dependencies and rebuild your project in the IDE.
47+
3. Update Loom:
48+
- Change the `loom` version in `gradle/libs.versions.toml` (the `versions.loom` entry) to the latest version
49+
compatible with the new Minecraft version.
50+
4. Update the Gradle wrapper:
51+
- Run the wrapper update command for your platform. Examples:
52+
- Unix / macOS / Windows (Powershell): `./gradlew wrapper --gradle-version <version> && ./gradlew wrapper`
53+
- Windows (cmd.exe): `gradlew.bat wrapper --gradle-version <version> && gradlew.bat wrapper`
54+
- This updates and regenerates the Gradle Wrapper scripts (`gradlew`, `gradlew.bat`, etc.) for the specified version.
55+
5. Update your source code:
56+
- Adjust for Minecraft or Yarn mapping changes: method names, imports, mixins, etc.
57+
- Check for Meteor Client API changes that may affect your addon by comparing against the
58+
[master branch](https://github.com/MeteorDevelopment/meteor-client/tree/master).
59+
6. Build and test:
60+
- Run the gradle `build` task.
61+
- Confirm the build succeeds and your addon works with the new Minecraft version.
62+
63+
### Project structure
64+
65+
```text
66+
.
67+
│── .github
68+
│ ╰── workflows
69+
│ │── dev_build.yml
70+
│ ╰── pull_request.yml
71+
│── gradle
72+
│ │── libs.versions.toml
73+
│ ╰── wrapper
74+
│ │── gradle-wrapper.jar
75+
│ ╰── gradle-wrapper.properties
76+
│── src
77+
│ ╰── main
78+
│ │── java
79+
│ │ ╰── com
80+
│ │ ╰── example
81+
│ │ ╰── addon
82+
│ │ │── commands
83+
│ │ │ ╰── CommandExample
84+
│ │ │── hud
85+
│ │ │ ╰── HudExample
86+
│ │ │── modules
87+
│ │ │ ╰── ModuleExample
88+
│ │ ╰── AddonTemplate
89+
│ ╰── resources
90+
│ │── assets
91+
│ │ ╰── template
92+
│ │ ╰── icon.png
93+
│ │── addon-template.mixins.json
94+
│ ╰── fabric.mod.json
95+
│── .editorconfig
96+
│── .gitignore
97+
│── build.gradle.kts
98+
│── gradle.properties
99+
│── gradlew
100+
│── gradlew.bat
101+
│── LICENSE
102+
│── README.md
103+
╰── settings.gradle.kts
104+
```
105+
106+
This is the default project structure. Each folder/file has a specific purpose.
107+
Here is a brief explanation of the ones you might need to modify:
108+
109+
- `.github/workflows`: Contains the GitHub Actions configuration files.
110+
- `gradle`: Contains the Gradle wrapper files and the versions catalog.
111+
- `libs.versions.toml`: Defines version numbers for Minecraft, Loom, Meteor, and other dependencies.
112+
- `wrapper`: Contains the Gradle wrapper executable files.
113+
To update the Gradle wrapper executable itself, run the wrapper update command (examples are shown above).
114+
- `src/main/java/com/example/addon`: Contains the main class of the addon.
115+
Here you can register your custom commands, modules, and HUDs.
116+
Edit the `getPackage` method to reflect the package of your addon.
117+
- `src/main/resources`: Contains the resources of the addon.
118+
- `assets`: Contains the assets of the addon.
119+
You can add your own assets here, separated in subfolders.
120+
- `template`: Contains the assets of the template.
121+
You can replace the `icon.png` file with your own addon icon.
122+
Also, rename this folder to reflect the name of your addon.
123+
- `addon-template.mixins.json`: Contains the Mixin configuration for the addon.
124+
You can add your own mixins in the `client` array.
125+
- `fabric.mod.json`: Contains the metadata of the addon.
126+
Edit the various fields to reflect the metadata of your addon.
127+
- `build.gradle.kts`: Contains the Gradle build script.
128+
You can manage the dependencies of the addon here.
129+
Remember to keep the `fabric-loom` version up-to-date.
130+
- `gradle.properties`: Contains additional build properties used by the build script
131+
(for example `maven_group` and `archives_base_name`).
132+
Dependency and platform version numbers are stored in `gradle/libs.versions.toml`.
133+
- `LICENSE`: Contains the license of the addon.
134+
You can edit this file to change the license of your addon.
135+
- `README.md`: Contains the documentation of the addon.
136+
You can edit this file to reflect the documentation of your addon, and showcase its features.
137+
138+
## License
139+
140+
This template is available under the CC0 license. Feel free to use it for your own projects.

0 commit comments

Comments
 (0)