Skip to content
This repository has been archived by the owner on Sep 16, 2024. It is now read-only.

Commit

Permalink
add documention
Browse files Browse the repository at this point in the history
  • Loading branch information
0xs2 committed Feb 4, 2024
1 parent f658326 commit 26a962c
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,24 @@ this plugin is just dead simple, straight to the point. does staffchat and nothi

<img src="https://i.imgur.com/FoOl2gQ.png" width="500px">

### settings.yml

```yml
settings:
staffchat-prefix: '&c[StaffChat]&f'
staffchat-toggle-alert: true
staffchat-use-displayNamesStaffChat: false
staffchat-use-displayNamesPublicChat: true
staffchat-publicChatPrefix: '&f<%player%&f> '
config-version: 1
```
- Staff chat prefix, should be obvious
- Toggle alert, this sends the player a message letting them know staff chat is toggled upon joining.
- 'displayNamesStaffChat' - if you want any custom display name you have set or just their raw username displayed
- 'displayNamesPublicChat' - same thing.
- Public chat prefix, ideally you want to make this match the thing you have on your server.
### commands
- `/staffchat`, `/sc` - type in the staff chat
- `/staffchattoggle`, `/sct` - toggle the staff chat on/off
Expand Down

0 comments on commit 26a962c

Please sign in to comment.