Skip to content

Commit efcd050

Browse files
committed
README.md change
1 parent e0566c6 commit efcd050

File tree

2 files changed

+107
-48
lines changed

2 files changed

+107
-48
lines changed

.idea/misc.xml

Lines changed: 0 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

README.md

Lines changed: 107 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
![DupePlus Icon](https://cdn.modrinth.com/data/cached_images/c37c728a99ba59a425ff67a8992354ca5368f1d2.png)
22
# DupePlus
33

4-
The best Dupe Plugin for your Dupe Server, it provides you with a user-friendly configuration with comments that help you understand what things mean in the YML, it will also make your survival life easier just by duplicating. Just send in chat "/dupe"!
4+
The best duplication plugin for your Dupe Server. DupePlus provides you with a user-friendly configuration with comments that help you understand what each section means in the YML. It will also make your survival easier just by duplicating. Just send "/dupe" in chat!
55

66
## Setup Guide
77

@@ -19,34 +19,72 @@ If you ever manage to break the `config.yml` or accidentally emptied the config.
1919

2020
```yml
2121
# DupePlus's Settings
22-
# Message Variables
23-
# %item_type% = The Duplicated item
24-
# %item_name% = The Item's Display Name
25-
# %old_item_count% = The Item Count before dupe
26-
# %new_item_count% = The Item Count after dupe
27-
# %item_count% = Item Count
28-
# %prefix% = The default prefix or the prefix you set
29-
# %max% = The maximum
30-
# %min% = The minimum
22+
# Message Variables:
23+
# <item_type> = The Duplicated item
24+
# <item_name> = The Item's Display Name
25+
# <old_item_count> = The Item Count before dupe
26+
# <new_item_count> = The Item Count after dupe
27+
# <item_count> = Item Count
28+
# <prefix> = The default prefix or the prefix you set
29+
# <max> = The maximum
30+
# <min> = The minimum
31+
# <world> = The world name
32+
# <link> = Where you can download the new version
33+
# <currentversion> = The current version installed in the server.
34+
# <newversion> = The new version
3135

3236
# Use this website to help you customize your messages
3337
# https://webui.advntr.dev
38+
39+
# If you want to request a feature or notice any issues with the Plugin. Then create an issue in the GitHub Repository.
40+
# https://github.com/meme20200/dupeplus/issues
3441
dupe:
35-
# The prefix for you to use
42+
# The prefix that is added before each message.
3643
prefix: "<green>DupePlus</green>"
3744

45+
# Settings to change the Dupe Command into a Custom command.
46+
custom-command:
47+
# Make it false to disable the custom command, make it true to enable it. (Default: false)
48+
enabled: false
49+
50+
# The name used to create the custom command (Default: "dupe")
51+
# /<name>
52+
name: "dupe"
53+
54+
# Other ways of using /dupe
55+
aliases: ["duplicate"]
56+
57+
# Settings to block or allow /dupe in specific worlds.
58+
worlds:
59+
# Make it false to disable this feature.
60+
enabled: false
61+
62+
# Mode: whitelist, blacklist (Default:
63+
# whitelist will block all worlds but only allow /dupe in the worlds list.
64+
# blacklist will allow all worlds but block /dupe in the worlds list.
65+
mode: blacklist
66+
67+
# If the player tries to dupe in a blocked world. (Default: "<prefix> <dark_gray>|</dark_gray> <red>The world is banned from using /dupe!</red>")
68+
# Allowed message variable: <prefix>, <item_type>, <item_name>, <item_count>, <world>
69+
# Leave blank for no message
70+
blocked-message: "<prefix> <dark_gray>|</dark_gray> <red>The world is banned from using /dupe!</red>"
71+
72+
# Add or remove worlds to either block (blacklist) or allow (whitelist) it from players in the world from duping.
73+
worlds: []
74+
75+
3876
# Make it false to let everyone allowed to use this command (Default: false)
3977
# Permission: dupeplus.dupe
4078
permission: false
4179

4280

43-
# The message sent to the player when try to execute dupe or reloadconfig no permission (Only if the above is true) (Default: "%prefix% <dark_gray>|</dark_gray> <red>You are not allowed to use this command</red>")
81+
# The message sent to the player when try to execute dupe or reloadconfig no permission (Only if the above is true) (Default: "<prefix> <dark_gray>|</dark_gray> <red>You are not allowed to use this command</red>")
4482
# Leave blank for no message
45-
permission-message: "%prefix% <dark_gray>|</dark_gray> <red>You are not allowed to use this command</red>"
83+
permission-message: "<prefix> <dark_gray>|</dark_gray> <red>You are not allowed to use this command</red>"
4684

47-
# The message sent to the player when you duplicate an item. (Default: "%prefix% <dark_gray>|</dark_gray> <gray>Duped %item_name%</gray>")
48-
# Allowed Message Variables: %prefix%, %item_type%, %item_name%, %old_item_count%, %new_item_count%
49-
message: "%prefix% <dark_gray>|</dark_gray> <gray>Duped %item_name%</gray>"
85+
# The message sent to the player when you duplicate an item. (Default: "<prefix> <dark_gray>|</dark_gray> <gray>Duped <item_name></gray>")
86+
# Allowed Message Variables: <prefix>, <item_type>, <item_name>, <old_item_count>, <new_item_count>
87+
message: "<prefix> <dark_gray>|</dark_gray> <gray>Duped <item_name></gray>"
5088

5189
# The message sent whenever the player tries to dupe nothing (Air) (Default: "")
5290
# Leave blank for no message
@@ -57,9 +95,9 @@ dupe:
5795
# Make it false to disable the Custom NBT feature, make it true to enable it (Default: true)
5896
enabled: true
5997

60-
# Allowed message variable: %prefix%, %item_type%, %item_name%, %item_count% (Default: "%prefix% <dark_gray>|</dark_gray> <red>The item is blocked from being duped!</red>")
98+
# Allowed message variable: <prefix>, <item_type>, <item_name>, <item_count> (Default: "<prefix> <dark_gray>|</dark_gray> <red>The item is blocked from being duped!</red>")
6199
# Leave blank for no message
62-
blocked-message: "%prefix% <dark_gray>|</dark_gray> <red>The item is blocked from being duped!</red>"
100+
blocked-message: "<prefix> <dark_gray>|</dark_gray> <red>The item is blocked from being duped!</red>"
63101

64102

65103
# When using /dupe, in which hand will it dupe? (Default: MainHand)
@@ -70,21 +108,40 @@ dupe:
70108
# Message to the sender if they try to dupe as a non-player (Default: "DupePlus | You can't do that!")
71109
console-message: "DupePlus | You can't do that!"
72110

73-
# Settings for blacklist
74-
blacklist:
75-
# Make it false to disable the blacklist, make it true to enable it (Default: false)
111+
# Settings for blacklist / whitelist
112+
list:
113+
# Make it false to disable these features, make it true to enable it (Default: false)
76114
enabled: false
77-
# If the player tries to dupe an item that is in (Default: "%prefix% <dark_gray>|</dark_gray> <red>The item is blocked from being duped!</red>")
78-
# Allowed message variable: %prefix%, %item_type%, %item_name%, %item_count%
115+
116+
# Make it false to make it "whitelist", make it true to make it "blacklist" (Default: true)
117+
# whitelist will block all items but only allow item duplication .
118+
# blacklist will allow all worlds but block /dupe in the worlds list.
119+
# Enabled must be true
120+
blacklist: true
121+
122+
# Checks Shulker Boxes when duplicating items (Default: true)
123+
shulkerbox: true
124+
125+
# If the player tries to dupe an item that is in the blacklist or the item is not in the whitelist (Default: "<prefix> <dark_gray>|</dark_gray> <red>The item is blocked from being duped!</red>")
126+
# Allowed message variable: <prefix>, <item_type>, <item_name>, <item_count>
79127
# Leave blank for no message
80-
blocked-message: "%prefix% <dark_gray>|</dark_gray> <red>The item is blocked from being duped!</red>"
81-
# Add or remove items to block them from being duped, also do not include spaces. (NO: "diamond block" YES: "diamond_block")
128+
blocked-message: "<prefix> <dark_gray>|</dark_gray> <red>The item is blocked from being duped!</red>"
82129

130+
# Add or remove items to either block (blacklist) or allow (whitelist) them from being duped, also do not include spaces. (NO: "diamond block" YES: "diamond_block")
83131
# Begin the item's id with minecraft: to check the item's type only, it will ignore if the item is part of a custom plugin. (Default: - minecraft:barrier)
84132
# Begin the item's id with itemsadder: if you want to check if the item's itemsadder id, it will not check for the namespace.
133+
134+
135+
# You can use itemsadder:* to block all ItemsAdder items from being duplicated
85136
items:
86137
- minecraft:barrier
87138

139+
140+
# Add or remove specific itemsadder namespaces to either block (blacklist) or allow (whitelist) any items that is under those namespaces from being duplicated
141+
itemsadder-namespaces:
142+
- replace_me
143+
144+
88145
# Settings for the cooldown of /dupe
89146
cooldown:
90147
# Make it false to disable the cooldown, make it true to enable it. (Default: false)
@@ -93,10 +150,10 @@ dupe:
93150
# How many seconds for the cooldowns to be. (Default: 3)
94151
seconds: 3
95152

96-
# If the player tries to dupe while the cooldown is set. (Default: "%prefix% <dark_gray>|</dark_gray> <red>Please wait %duration%.</red>")
97-
# Allowed message variable: %prefix%, %duration%
153+
# If the player tries to dupe while the cooldown is set. (Default: "<prefix> <dark_gray>|</dark_gray> <red>Please wait <duration>.</red>")
154+
# Allowed message variable: <prefix>, <duration>
98155
# Leave blank for no message
99-
wait-message: "%prefix% <dark_gray>|</dark_gray> <red>Please wait %duration%.</red>"
156+
wait-message: "<prefix> <dark_gray>|</dark_gray> <red>Please wait <duration>.</red>"
100157

101158
# Make it true if you want players with the permission to ignore the cooldown, make it false if you want everyone to have cooldown. (Default: false)
102159
# Permission: dupeplus.cooldown
@@ -116,21 +173,21 @@ dupe:
116173
pro: 10
117174
vip: 8
118175
default: 5 # Default permission or players without the permission who are using the dupe times.
119-
120-
# If the player puts the value above the maximum then what's the message? (Default: "%prefix% <dark_gray>|</dark_gray> <red>This is higher than maximum! Do something lower than %max%</red>")
121-
# Allowed message variable: %prefix%, %max%, %min%
176+
177+
# If the player puts the value above the maximum then what's the message? (Default: "<prefix> <dark_gray>|</dark_gray> <red>This is higher than maximum! Do something lower than <max></red>")
178+
# Allowed message variable: <prefix>, <max>, <min>
122179
# Leave blank for no message
123-
max-message: "%prefix% <dark_gray>|</dark_gray> <red>This is higher than maximum! Do something lower than %max%</red>"
180+
max-message: "<prefix> <dark_gray>|</dark_gray> <red>This is higher than maximum! Do something lower than <max></red>"
124181

125182
# 0 for no minimum amount of times the player can run (Default: 0) (Recommended: 0)
126183
# Permission to let a player/group have no minimum regardless of this option: dupeplus.times.min.unlimited
127184
# It is recommended to just keep this at 0
128185
min: 0
129186

130-
# If the player puts the value below the minimum (Default: "%prefix% <dark_gray>|</dark_gray> <red>This is lower than minimum! Do something higher than %min%</red>")
131-
# Allowed message variable: %prefix%, %max%, %min%
187+
# If the player puts the value below the minimum (Default: "<prefix> <dark_gray>|</dark_gray> <red>This is lower than minimum! Do something higher than <min></red>")
188+
# Allowed message variable: <prefix>, <max>, <min>
132189
# Leave blank for no message
133-
min-message: "%prefix% <dark_gray>|</dark_gray> <red>This is lower than minimum! Do something higher than %min%</red>"
190+
min-message: "<prefix> <dark_gray>|</dark_gray> <red>This is lower than minimum! Do something higher than <min></red>"
134191

135192
# Instead of sending the dupe message for every time it duplicates, it sends it one time to stop spam. (Default: true)
136193
one-time-message: true
@@ -153,10 +210,16 @@ dupe:
153210
mode: set
154211

155212
# The Integrations that this plugin connects with.
213+
# If you notice any issues then please create an issue in GitHub (meme20200/dupeplus)
156214
integrations:
157215
# Enables ItemsAdder Integration (Default: true)
158216
itemsadder: true
159217

218+
# Enables PlaceholderAPI Integration (Default: true)
219+
placeholderapi: true
220+
221+
222+
160223
# Checks for updates using the set API (Modrinth or SpigotMC),
161224
updates:
162225
# Checks on startup for updates, disable if you do not wish to update DupePlus.
@@ -170,22 +233,22 @@ updates:
170233
notify:
171234
# Notify players with the permission to update the plugin to the latest version.
172235
player-notify: true
173-
# The message sent to everyone who has the permission (Default: "%prefix% <dark_gray>|</dark_gray> <white><green>DupePlus</green> is outdated, please update at: <blue>%link%</blue>")
236+
# The message sent to everyone who has the permission (Default: "<prefix> <dark_gray>|</dark_gray> <white><green>DupePlus</green> is outdated, please update at: <blue><link></blue>")
174237
# (Permission: dupeplus.updates.notify)
175-
# Allowed message variable: %prefix%, %link%, %currentversion%, %newversion%
176-
notify-message: "%prefix% <dark_gray>|</dark_gray> <white><green>DupePlus</green> is outdated, please update at: <blue>%link%</blue>"
238+
# Allowed message variable: <prefix>, <link>, <currentversion>, <newversion>
239+
notify-message: "<prefix> <dark_gray>|</dark_gray> <white><green>DupePlus</green> is outdated, please update at: <blue><link></blue>"
177240

178241
# Send message to the console for the server owner to update the plugin.
179242
console-notify: true
180243

181-
# The message sent to the console (Default: "%prefix% | Update DupePlus at %link%")
182-
# Allowed message variable: %prefix%, %link%, %currentversion%, %newversion%
183-
console-notify-message: "%prefix% | Update DupePlus at %link%"
244+
# The message sent to the console (Default: "<prefix> | Update DupePlus at <link>")
245+
# Allowed message variable: <prefix>, <link>, <currentversion>, <newversion>
246+
console-notify-message: "<prefix> | Update DupePlus at <link>"
184247

185248
# Don't edit this
186-
# Previous: 1.2
187-
# config-version: 1.3
188-
config-version: 1.3
249+
# Previous: 1.3
250+
# config-version: 1.4
251+
config-version: 1.4
189252
```
190253
</details>
191254
@@ -252,6 +315,3 @@ Server Software this plugin supports and recommend to use: Bold & ^
252315
- Fabric#
253316
- Forge#
254317

255-
## Upcoming 1.3.1
256-
- [ ] Support PlaceholderAPI
257-
> Note: Please request features in the Issues Tab

0 commit comments

Comments
 (0)