Skip to content

Commit 138714b

Browse files
RhythmicSysRhythmicSys
committed
Adjust README more, hopefully this is less confusing
1 parent 2329f0f commit 138714b

1 file changed

Lines changed: 48 additions & 57 deletions

File tree

‎README.md‎

Lines changed: 48 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -6,94 +6,85 @@ Mini-Message comes prepackaged with Paper and all forks of Paper support Mini-Me
66

77
## Commands
88

9+
10+
911
`/nick set <nickname> [player]`
1012

1113
- Sets the nickname of the player.
1214
- Uses Mini-Message Tags such as `<gray>` and `<gradient:red:green>`
13-
- Allows users with permission `simplenick.admin` to change the nickname of another player using the optional [player] argument.
15+
- Allows users with permission `simplenick.admin` to change the nickname of another player using the optional [player]
16+
argument.
1417

1518
`/nick save [player]`
19+
1620
- Saves the player's current nickname for future use
1721

1822
`/nick delete [player|nick] <nick>`
23+
1924
- Deletes the specified nickname from the player's saved names
2025

2126
`/nick reset [player]`
2227

2328
- Sets the nickname of the player back to the original username, unformatted.
24-
- Allows users with permission `simplenick.admin` to reset the nickname of another player using the optional [player] argument.
29+
- Allows users with permission `simplenick.admin` to reset the nickname of another player using the optional [player]
30+
argument.
2531

26-
`/nick reload`
32+
`/nick reload`
2733

2834
- Reloads the configuration and locale.
2935

30-
`/nick help`
36+
`/nick help`
3137

3238
- Provides help text.
3339

3440
### Admin Permissions
3541

36-
- `simplenick.bypass.username`
37-
- Allows the player to use the username of another player on the server, as their own nickname
38-
- `simplenick.bypass.length`
39-
- Allows the player to use a nickname longer than the configured max character
40-
- `simplenick.bypass.regex`
41-
- Allows the player to use a nickname that doesn't match the configured regex
42-
- `simplenick.reload`
43-
- Allows the player to reload the plugin configuration and locale.
44-
- `simplenick.admin.reset`
45-
- Allows the player to reset another player's nickname
46-
- `simplenick.admin.save`
47-
- Allows the player to save another player's nickname
48-
- `simplenick.admin.delete`
49-
- Allows the player to delete another player's saved name
50-
- `simplenick.admin.restrictive`
51-
- Allows the player to set another player's nickname, within the other player's formatting permissions
52-
- Does not override the other player's formatting permissions
53-
- Does override the other player's nickname permissions
54-
- (if the other player cannot nickname themselves, they can still be admin nick'd with this permission)
55-
- `simplenick.admin.basic`
56-
- Allows the player to set another player's nickname, within their own formatting permissions
57-
- Overrides the other player's formatting permissions
58-
- Only allows permissions that the admin has
59-
- `simplenick.admin.full`
60-
- Allows the player to set another player's nickname, regardless of both of their formatting permissions.
61-
62-
> [!NOTE]
63-
>
64-
> This permission allows for all minimessage formatting types, not just the ones that are set in permissions here
65-
>
66-
> These types of formatting can include things like click action, hover text, and similar.
67-
>
68-
> These formats can do really cool stuff, but be careful who you give it to lol
42+
| Permission | Admin permission to: |
43+
|:-------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
44+
| `simplenick.bypass.` | ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ |
45+
| `simplenick.bypass.username` | Use another player's username as their own nickname on the server |
46+
| `simplenick.bypass.length` | Set a nickname longer than the max character limit |
47+
| `simplenick.bypass.regex` | Set a nickname that doesn't match the configured regex |
48+
| ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓ | ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓ |
49+
| `simplenick.reload` | Reload the plugin configuration and locale |
50+
| ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓ | ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓ |
51+
| `simplenick.admin.` | ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ |
52+
| `simplenick.admin.reset` | Reset a target player's nickname |
53+
| `simplenick.admin.save` | Save a target player's nickname to **the target player's** saved nicknames |
54+
| `simplenick.admin.delete` | Delete a target player's saved name from **the target player's** <br>list of saved nicknames |
55+
| `simplenick.admin.restrictive` | Set a target player's nickname, only using the formats the target player has permissions for<br/>(This is a very niche permission, likely not what most servers are looking for) |
56+
| `simplenick.admin.basic` | Set a target player's nickname, using the formats the Admin has permission to use<br>(This is the permission most servers will need for admins) |
57+
| `simplenick.admin.full` | Set a target player's nickname with zero regard for formatting, full permission for all formatting. <br>(Not recommended) |
6958

7059
### Player Permissions
7160

72-
- `simplenick.nick.set`
73-
- Allows the player to set their own nickname
74-
75-
- `simplenick.nick.reset`
76-
- Allows the player to reset their own nickname
77-
78-
- `simplenick.nick.save`
79-
- Allows saving the current nickname
61+
| Permission | Permission to: |
62+
|:---------------------------------------|:---------------------------------------------------------|
63+
| `simplenick.nick` | ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ |
64+
| `simplenick.nick.set` | Set own nickname |
65+
| `simplenick.nick.reset` | Reset own nickname |
66+
| `simplenick.nick.save` | Save current nickname for later use |
67+
| `simplenick.nick.delete` | Delete a previously saved nickname |
68+
| `simplenick.nick.color` | Use color formatting tags (`<color:#aabbcc>` or `<red>`) |
69+
| `simplenick.nick.gradient` | Use gradient formatting tags (`<gradient:red:blue>`) |
70+
| `simplenick.nick.rainbow` | Use rainbow formatting tags (`<rainbow>`) |
71+
| `simplenick.nick.format.` | ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ |
72+
| `simplenick.nick.format.reset` | Use the `<reset>` formatting tags |
73+
| `simplenick.nick.format.underline` | Use the `<u>`,`</u>` formatting tags |
74+
| `simplenick.nick.format.strikethrough` | Use the `<st>`,`</st>` formatting tags |
75+
| `simplenick.nick.format.bold` | Use the `<b>`,`</b>` formatting tags |
76+
| `simplenick.nick.format.obsfucated` | Use the `<obf>`,`</obf>` formatting tags |
8077

81-
- `simplenick.nick.delete`
82-
- Allows deleting a specified saved nickname
83-
84-
- `simplenick.nick.<tag>`
85-
- Allows for the use of those Mini-Message tags.
86-
- Valid Tags are: `color`, `gradient`, and `rainbow`.
87-
88-
- `simplenick.nick.format.<tag>`
89-
- Allows for the use of those formatting tags.
90-
- Valid Tags are: `reset`, `underline`, `italic`, `strikethrough`, `bold`, and `obsfucated`.
9178

9279
## PlaceholderAPI
80+
9381
- Download the `player` ecloud expansion for Placeholder API
9482
- Use `%player_displayname%`
9583

96-
- If you have a specific setup that needs the minimessage formatting before it has been parsed, i.e. the `"<red>Nickname</red>"` version, you can use `%simplenicks_mininick%`
97-
- This won't be necessary for most users though, the previous one will work best.
84+
- If you have a specific setup that needs the minimessage formatting before it has been parsed, i.e. the
85+
`"<red>Nickname</red>"` version, you can use `%simplenicks_mininick%`
86+
- This won't be necessary for most users though, the previous one will work best.
87+
9888
## TODO
89+
9990
- Create a `/nick whois` or similar command to determine "who is the player(s) with this nickname".

0 commit comments

Comments
 (0)