Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
xR4YM0ND committed Jun 15, 2024
1 parent 7616325 commit 6855f65
Showing 1 changed file with 33 additions and 3 deletions.
36 changes: 33 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,38 @@
# NutritionZ
NutritionZ adds a nutrition system to enhance the gameplay.

### Installation
## Installation
NutritionZ is a mod built for the [Fabric Loader](https://fabricmc.net/). It requires [Fabric API](https://www.curseforge.com/minecraft/mc-mods/fabric-api) and [Cloth Config API](https://www.curseforge.com/minecraft/mc-mods/cloth-config) to be installed separately; all other dependencies are installed with the mod.

### License
NutritionZ is licensed under MIT.
## License
NutritionZ is licensed under MIT.

## Datapacks
You can add custom mod support with datapacks.
Just create a [datapack](https://minecraft.wiki/w/Data_pack) with a `pack.mcmeta` & a version for your minecraft version.

Then you just need a folder structure for the mod e.g. `data/modid/nutrition/sometext.json`.

In this json you can add the mods items & give them nutrient values.

```json
{
"modid:itemid": {
"carbohydrates": 0,
"protein": 0,
"fat": 0,
"vitamins": 0,
"minerals": 0
},
"modid:itemid2": {
"carbohydrates": 0,
"protein": 0,
"fat": 0,
"vitamins": 0,
"minerals": 0
}
}
```
### More Infos
*The default datapack gives 5 values per half hunger.*
You also currently can't overwrite the default datapacks (items & values added via them)

0 comments on commit 6855f65

Please sign in to comment.