Skip to content

Commit 98ed087

Browse files
committed
Release 1.0.0 - setup readme, change missing properties, bump loader_version from 0.12.8 -> 0.12.12
1 parent 552676c commit 98ed087

File tree

2 files changed

+33
-10
lines changed

2 files changed

+33
-10
lines changed

README.md

+29-6
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,31 @@
1-
# Meteor Addon Template
1+
[![Github All Releases](https://img.shields.io/github/downloads/SIMULATAN/meteor-notifications-addon/total.svg)](https://github.com/SIMULATAN/meteor-notifications-addon/releases) [![Verified](https://img.shields.io/badge/Verified%3F-yes-lime)](https://anticope.ml/pages/MeteorAddons.html#utilities) [![My Discord (505713760124665867)](https://img.shields.io/badge/My-Discord-%235865F2.svg)](https://discord.com/users/505713760124665867) [![wakatime](https://wakatime.com/badge/github/SIMULATAN/meteor-notifications-addon.svg)](https://wakatime.com/badge/github/SIMULATAN/meteor-notifications-addon)
22

3-
A template to allow easy usage of the Meteor Addon API.
3+
# Meteor Notifications addon
4+
This addon adds various (very customizable) notifications to the HUD of the [Meteor Client](https://github.com/MeteorDevelopment/meteor-client).
45

5-
### How to use:
6-
- Clone this project
7-
- Use this template to create new modules/commands
8-
- Run the mod with Meteor.
6+
### Support
7+
If you need any help, feel free to [DM me on Discord](https://discord.com/users/505713760124665867)
8+
9+
### How to build yourself
10+
- Clone this repository
11+
- Navigate into the folder in a shell
12+
- Run `./gradlew build`
13+
- Copy the `build/libs/meteor-notifications-addon-*.jar` file to your `mods` folder
14+
15+
### How to develop
16+
- Clone this repository
17+
- Import the project in IntelliJ
18+
- Configure IntelliJ to use JDK 17
19+
- Change the `Gradle JVM` option to `Project SDK` (`Build, Execution, Deployment -> Build Tools -> Gradle`)
20+
- Restart IntelliJ after the initial build to load the run configurations
21+
22+
##### Optional:
23+
(Faster build times and better hot swap)
24+
25+
- Open the 'Gradle Settings' dialog from the Gradle tab.
26+
- Change the 'Build and run using' and 'Run tests using' fields to 'IntelliJ IDEA'.
27+
- Go to File → Project Structure → Project and set 'Project compiler output' to $PROJECT_DIR$/out.
28+
Source: [Fabric Wiki](https://fabricmc.net/wiki/tutorial:setup#intellij_idea)
29+
30+
### Contributions
31+
... are welcome! Feel free to modify the code and submit a pull request or open up a issue.

gradle.properties

+4-4
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@ org.gradle.jvmargs=-Xmx2G
33
# Fabric (https://fabricmc.net/versions.html)
44
minecraft_version=1.18
55
yarn_mappings=1.18+build.1
6-
loader_version=0.12.8
6+
loader_version=0.12.12
77

88
# Mod Properties
9-
mod_version=0.3
10-
maven_group=meteordevelopment.addons
11-
archives_base_name=addon-template
9+
mod_version=1.0.0
10+
maven_group=com.github.simulatan
11+
archives_base_name=notifications-addon
1212

1313
# Dependency Versions
1414

0 commit comments

Comments
 (0)