Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ImToggle committed Jun 20, 2024
1 parent 387d99e commit 56bde97
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 14 deletions.
19 changes: 6 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,9 @@
# OneConfigExampleMod
# Item Counter

![Powered by OneConfig](https://polyfrost.org/img/cozy_vector.svg)
![Compact Powered by OneConfig](https://polyfrost.org/img/compact_vector.svg)
![Minimal Powered by OneConfig](https://polyfrost.org/img/cozy-minimal_vector.svg)
![Minimal Compact Powered by OneConfig](https://polyfrost.org/img/compact-minimal_vector.svg)

Example mod implementing OneConfig.

## How to use

- Copy the template either by using GitHub's "Use this template" feature or downloading the repo manually.
- **Remove the license named "LICENSE-TEMPLATE" and choose a new one.**
- Refactor the template (specifically, the modid, version and name in the gradle.properties and most of the class names)
to a different name.
- Have fun modding! :D
## Screenshots
HUD
![HUD.png](screenshots/HUD.png)
Config Menu
![Config.png](screenshots/Config.png)
2 changes: 1 addition & 1 deletion gradle.properties
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# gradle.properties file -- CHANGE THE VALUES STARTING WITH `mod_*` AND REMOVE THIS COMMENT.

# Sets the name of your mod.
mod_name=ItemCounter
mod_name=Item Counter
# Sets the id of your mod that mod loaders use to recognize it.
mod_id=itemcounter
# Sets the version of your mod. Make sure to update this when you make changes according to semver.
Expand Down
Binary file added screenshots/Config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/HUD.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 56bde97

Please sign in to comment.