Skip to content

Commit

Permalink
chore: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Notexe committed Mar 13, 2024
1 parent cc0292e commit 132b7d7
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -45,6 +51,8 @@ SimpleKeyEventHelper entity:

### Second method

SimpleKeyEventHelper entity:

```json
{
"parent": null,
Expand Down Expand Up @@ -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)

0 comments on commit 132b7d7

Please sign in to comment.