Skip to content

Commit 0ec14b9

Browse files
committed
Update README
1 parent a2b702e commit 0ec14b9

File tree

3 files changed

+57
-46
lines changed

3 files changed

+57
-46
lines changed

README.md

+47-43
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,12 @@ Mini-Message comes prepackaged with Paper and all forks of Paper support Mini-Me
1212
- Uses Mini-Message Tags such as `<gray>` and `<gradient:red:green>`
1313
- Allows users with permission `simplenick.admin` to change the nickname of another player using the optional [player] argument.
1414

15+
`/nick save [player]`
16+
- Saves the player's current nickname for future use
17+
18+
`/nick delete [player|nick] <nick>`
19+
- Deletes the specified nickname from the player's saved names
20+
1521
`/nick reset [player]`
1622

1723
- Sets the nickname of the player back to the original username, unformatted.
@@ -27,34 +33,31 @@ Mini-Message comes prepackaged with Paper and all forks of Paper support Mini-Me
2733

2834
### Admin Permissions
2935

30-
`simplenick.usernamebypass`
31-
32-
- Allows the player to use the username of another player on the server, as their own nickname
33-
34-
`simplenick.reload`
35-
36-
- Allows the player to reload the plugin configuration and locale.
37-
38-
`simplenick.admin.reset`
39-
40-
- Allows the player to reset another player's nickname
41-
42-
`simplenick.admin.restrictive`
43-
44-
- Allows the player to set another player's nickname, within the other player's formatting permissions
45-
- Does not override the other player's formatting permissions
46-
- Does override the other player's nickname permissions
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
4754
- (if the other player cannot nickname themselves, they can still be admin nick'd with this permission)
48-
49-
`simplenick.admin.basic`
50-
51-
- Allows the player to set another player's nickname, within their own formatting permissions
52-
- Overrides the other player's formatting permissions
53-
- Only allows permissions that the admin has
54-
55-
`simplenick.admin.full`
56-
57-
- Allows the player to set another player's nickname, regardless of both of their formatting permissions.
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.
5861

5962
> [!NOTE]
6063
>
@@ -66,28 +69,29 @@ Mini-Message comes prepackaged with Paper and all forks of Paper support Mini-Me
6669
6770
### Player Permissions
6871

69-
`simplenicks.nick.set`
70-
71-
- Allows the player to set their own nickname
72+
- `simplenicks.nick.set`
73+
- Allows the player to set their own nickname
7274

73-
`simplenicks.nick.reset`
75+
- `simplenicks.nick.reset`
76+
- Allows the player to reset their own nickname
7477

75-
- Allows the player to reset their own nickname
78+
- `simplenicks.nick.save`
79+
- Allows saving the current nickname
7680

77-
`simplenicks.nick.<tag>`
81+
- `simplenicks.nick.delete`
82+
- Allows deleting a specified saved nickname
7883

79-
- Allows for the use of those Mini-Message tags.
80-
- Valid Tags are: `color`, `gradient`, and `rainbow`.
84+
- `simplenicks.nick.<tag>`
85+
- Allows for the use of those Mini-Message tags.
86+
- Valid Tags are: `color`, `gradient`, and `rainbow`.
8187

82-
`simplenick.nick.format.<tag>`
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`.
8391

84-
- Allows for the use of those formatting tags.
85-
- Valid Tags are: `reset`, `underline`, `italic`, `strikethrough`, `bold`, and `obsfucated`.
92+
## PlaceholderAPI
93+
- `%simplenicks_mininick%`
94+
- Nickname pre-parsed
8695

8796
## TODO
88-
89-
- Provide Config Option for TabList Changing and implement logic for TabList Update.
9097
- Create a `/nick whois` or similar command to determine "who is the player(s) with this nickname".
91-
- Make the code less of a mess
92-
- Allow for nicknames to be set by non-players
93-
- Make a placeholderAPI extension

src/main/java/simplexity/simplenicks/util/TagPermission.java

-3
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,6 @@
33
import net.kyori.adventure.text.format.TextDecoration;
44
import net.kyori.adventure.text.minimessage.tag.resolver.TagResolver;
55
import net.kyori.adventure.text.minimessage.tag.standard.StandardTags;
6-
import org.bukkit.command.CommandSender;
7-
8-
import java.util.ArrayList;
96

107
public enum TagPermission {
118
//Nickname Perms

src/main/resources/plugin.yml

+10
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,16 @@ permissions:
4141
description: Allows the user to set another player's nickname, does not check the formatting permissions delegated to either player
4242
children:
4343
simplenick.admin: true
44+
simplenick.admin.save:
45+
default: op
46+
description: Allows the user to save another player's nickname for future use
47+
children:
48+
simplenick.admin: true
49+
simplenick.admin.delete:
50+
default: op
51+
description: Allows the user to delete one of another player's saved nicknames
52+
children:
53+
simplenick.admin: true
4454
simplenick.reload:
4555
description: allows a user to reload the locale and config of this plugin
4656
default: op

0 commit comments

Comments
 (0)