diff options
author | IRONM00N <64110067+IRONM00N@users.noreply.github.com> | 2021-03-08 21:35:04 -0500 |
---|---|---|
committer | IRONM00N <64110067+IRONM00N@users.noreply.github.com> | 2021-03-08 21:35:04 -0500 |
commit | 73b6f703307b4524fadead8fd0977c67b028e1f6 (patch) | |
tree | e90bc3f5d51778e2e2ac5639b92b25e336956b61 | |
parent | 30a75da8df79f7a150272c7210cc6dbdf5e50cdf (diff) | |
download | NotEnoughUpdates-REPO-73b6f703307b4524fadead8fd0977c67b028e1f6.tar.gz NotEnoughUpdates-REPO-73b6f703307b4524fadead8fd0977c67b028e1f6.tar.bz2 NotEnoughUpdates-REPO-73b6f703307b4524fadead8fd0977c67b028e1f6.zip |
add readme
-rw-r--r-- | README.md | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 00000000..d1c5c538 --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +<h1 align = "center"> NotEnoughUpdates-REPO </h1> + +This repository is used in order to store the various JSON files used for the Minecraft mod [NotEnoughUpdates](https://github.com/Moulberry/NotEnoughUpdates). + +<h2 align = "center"> How to contribute </h2> + +In order to contribute to the item repo you should enable the item editor tools by editing your config, in your configNew.json (.minecraft/config/notenoughupdates/configNew.json) ensure the following values are set: + +```json +"enableItemEditing": true, +"dev": true, +``` + +Once you have these options enabled you can edit and add items in-game using the following keybinds: + +* `k` - Open the item editor. +* `o` - While in an items recipe menu, add the recipe. +* `y` - Opens a pane on the right side of your inventory + +If you need further help on how to contribute feel free to join the [discord](https://discord.gg/moulberry) or contact `IRONM00N#0001`. |