diff --git a/README.md b/README.md index 3934da4..807f699 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,13 @@ Adds a helper entitytemplate for developers who wish to add custom key bindings ## Usage -This helper mod allows you to setup custom keybinds which you can then use to fire pins in your mod. +This helper mod allows you to setup custom keybinds which you can then use to fire pins in your mod. Please reference this mod in the "requirements" section in your mod's manifest like so: + +```json +"requirements": [ + "Notex.SimpleKeyEventHelper" +] +``` There are two methods of using this mod: @@ -45,6 +51,8 @@ SimpleKeyEventHelper entity: ### Second method +SimpleKeyEventHelper entity: + ```json { "parent": null, @@ -108,6 +116,6 @@ See JSON example for possible values #### Output pins -- `Pressed`: void (Fires on key pressed down and repeats if held for over a second.) +- `Pressed`: void (Fires on key pressed down and repeats if held for over a second) - `Down`: void (Fires on key pressed down) - `Up`: void (Fires on key released)