Skip to content

Commit

Permalink
Update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
LegendEffects committed Jul 29, 2020
1 parent 8806415 commit 494feea
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,18 @@
# OpenAFK
An open source AFK plugin for Spigot.

## Permissions
* openafk.exempt - Prevents the player from being detected as AFK
* openafk.isafk - Allows access to the /isafk command
* openafk.admin - Allows access to the /openafk command
* openafk.afk - Allows access to the /afk command

## Commands
* /isafk <username/uuid> - Checks if a player is AFK
* /afkplayers - Gives a list of AFK players
* /openafk - Admin OpenAFK Command
* /afk - Toggles the executors AFK status

## Understanding the annotations.
* **Parameters with an "(optional)" next to them don't need to be provided unless wanted.**

Expand Down Expand Up @@ -63,7 +75,7 @@ Changes where a players head is, using yaw and pitch.
### Command
Issues a command by a player or by console.
```yaml
- action: "message"
- action: "command"
by: "player" #(Optional - defaults to player) accepts player or console
command: "/help" # Console commands do NOT use the /
```
Expand Down

0 comments on commit 494feea

Please sign in to comment.