· 6 years ago · Jan 12, 2020, 01:32 AM
1# Welcome to Nucleus 1.4.6-S7.0. This is the main configuration file.
2#
3# If you're having issues with Nucleus, we have different support options for you:
4#
5# * Ore: https://ore.spongepowered.org/Nucleus/Nucleus
6# * Nucleus Docs: https://nucleuspowered.org/docs
7# * Real life people in Discord: https://discord.gg/MC2mAuS
8#
9# Thank you for using Nucleus!
10# ==============================================================
11
12# +------------------------------------------------------------+
13# | Modules |
14# | |
15# | Set to: |
16# | ENABLED: to enable the module |
17# | DISABLED: to disable the module |
18# | FORCELOAD: to enable the module and prevent plugins from |
19# | disabling it. |
20# | |
21# | Don't change the section name from "-modules", it's meant |
22# | to be called that to put the modules at the top! |
23# +------------------------------------------------------------+
24"-modules" {
25 # Provides administrative commands
26 admin=ENABLED
27 # Allows users to go AFK
28 afk=ENABLED
29 # Allows users to return to a previous point after teleporting
30 back=ENABLED
31 # Enhances the Minecraft ban system
32 ban=ENABLED
33 # Allows for the formatting of chat to potentially include player prefixes, nicknames and other information
34 chat=ENABLED
35 # Logs chat in separate files for easier searching
36 chat-logger=ENABLED
37 # Logs command usage on the console, in separate files for easier searching
38 command-logger=ENABLED
39 # Allows users with permission to see commands that other players are executing in real time
40 command-spy=ENABLED
41 # Allows for finer grain control over whether players can join the server, and the message non whitelisted players would see.
42 connection=ENABLED
43 # Controls the messages players see when someone joins or leaves the server
44 connection-messages=ENABLED
45 # Allows for virtual crafting tools to be used via commands
46 crafting-gui=ENABLED
47 # Controls whether death messages are displayed
48 death-message=ENABLED
49 # Utilities to contol the world environments
50 environment=ENABLED
51 # Commands and listeners to allow players to fly
52 fly=ENABLED
53 # Allows for freezing players in place
54 freeze-subject=ENABLED
55 # Fun commands for the server that do not (generally) have side effects
56 fun=ENABLED
57 # Display the likely location of a player
58 geo-ip=DISABLED
59 # Provide personal warps for players
60 home=ENABLED
61 # Allows players to ignore others in chat
62 ignore=ENABLED
63 # Lets users see more information about the server, provided by server owners in text files
64 info=ENABLED
65 # Allows for investigating others' inventories
66 inventory=ENABLED
67 # Allows for players to become invulnerable
68 invulnerability=ENABLED
69 # Allows for the maniuplation of items, including names, lore and enchantments
70 item=ENABLED
71 # Enables jails, for punishing players
72 jail=ENABLED
73 # Enables warping to nearby locations
74 jump=ENABLED
75 # Enhances the Minecraft kick function
76 kick=ENABLED
77 # Allows servers to provide players with kits of items and commands, that can be run on demand or automatically
78 kit=ENABLED
79 # Allows users to send semi-permanent mails to each other
80 mail=ENABLED
81 # Enhances the Minecraft whisper functions
82 message=ENABLED
83 # Miscellaneous functions
84 misc=ENABLED
85 # Controls the spawning of mobs
86 mob=ENABLED
87 # Enables preventing players from sending chat messages to the server
88 mute=ENABLED
89 # Bans players with pre-determined names (rather than UUIDs)
90 nameban=ENABLED
91 # Allows players to have nicknames that are different from their Minecraft name
92 nickname=ENABLED
93 # Allows staff to make notes on players, for server record keeping
94 note=ENABLED
95 # Adds commands to display information about players
96 playerinfo=ENABLED
97 # Allows users to bind commands to items, to activate on item use
98 powertool=ENABLED
99 # Adds basic crop trampling and mob griefing protection
100 protection=ENABLED
101 # Allows players to teleport to a random location
102 rtp=ENABLED
103 # Adds a rules command
104 rules=ENABLED
105 # Allows for modification of the server list entry for the server
106 server-list=ENABLED
107 # Adds a simplistic command based server shop for buying and selling items
108 server-shop=ENABLED
109 # Makes it easy to add formatting to signs
110 sign=ENABLED
111 # Controls the player spawning mechanics of the server
112 spawn=ENABLED
113 # Adds a chat channel for server staff
114 staff-chat=ENABLED
115 # Adds functions for teleporting players to/from other players, offline teleports and positional teleports
116 teleport=ENABLED
117 # Allows players to go invisible
118 vanish=ENABLED
119 # Adds a simple warning system for minor rule breaks, which can automatically punish the player.
120 warn=ENABLED
121 # Adds a public warp point system
122 warp=ENABLED
123 # World management, including world borders
124 world=ENABLED
125}
126# +------------------------------------------------------------+
127# | Admin |
128# +------------------------------------------------------------+
129admin {
130 # The prefix and suffix when sending a broadcast message. Accepts chat tokens such as {{displayname}}, {{name}}, etc.
131 broadcast-message-template {
132 prefix="&l&f[&l&dMythic&l&f]&r "
133 suffix=""
134 }
135}
136# +------------------------------------------------------------+
137# | AFK |
138# +------------------------------------------------------------+
139afk {
140 # If true, the server will announce when players go AFK, even when vanished. If false, only non-vanished players can go AFK.
141 afk-when-vanished=false
142 # The amount of time, in seconds, of inactivity before the player will be marked as AFK. Set to 0 to disable, or use the permission "nucleus.afk.exempt.toggle".
143 afktime=300
144 # The amount of time, in seconds, of inactivity before the player will be kicked. Set to 0 to disable, or use the permission "nucleus.afk.exempt.kick".
145 afktimetokick=900
146 # If true, any player that tries to use a command that might require the target to do something will be told if the target is AFK.
147 alert-on-command-send=true
148 # If true, the server will be informed when a player is kicked for inactivity, else, just those with the nucleus.afk.notify permissions
149 broadcast-to-all-on-kick=false
150 # If any of the messages tht would be broadcast to the server are blank, they will not be sent.
151 messages {
152 # The message sent to a player when kicked for inactivity.
153 kick-message-to-subject="You have been kicked for being AFK for too long."
154 on-afk=""
155 on-command="&f{{displayname}} &7is currently AFK and may not respond quickly."
156 # If empty, no message will be sent.
157 on-kick="&f{{displayname}} &7has been kicked for being AFK too long."
158 on-return=""
159 }
160 # Determines what actions determines if a player is active.
161 triggers {
162 # Marks a player as active if they chat
163 on-chat=true
164 # Marks a player as active if they run a command
165 on-command=true
166 # Marks a player as active if they interact
167 on-interact=true
168 # Marks a player as active if they move
169 on-movement=true
170 # Marks a player as active if they rotate (that is, look around)
171 on-rotation=true
172 }
173}
174# +------------------------------------------------------------+
175# | Back |
176# +------------------------------------------------------------+
177back {
178 # Log player's location on death.
179 on-death=true
180 # Log player's last location after travelling through a portal.
181 on-portal=false
182 # Log player's last location on warp.
183 on-teleport=true
184}
185# +------------------------------------------------------------+
186# | Bans |
187# +------------------------------------------------------------+
188ban {
189 # The maximum length a temporary ban may last for (in seconds) unless the user handing the mute has a bypass permission. Set to -1 for no maximum.
190 maximum-tempban-length=604800
191}
192# +------------------------------------------------------------+
193# | Chat |
194# +------------------------------------------------------------+
195chat {
196 # Some mods and plugins move the Minecraft player prefix to the main message body. If this is the case, turn this on, and Nucleus
197 # will try to remove it.
198 check-body-for-minecraft-prefix=false
199 # The prefix to use when someone uses "/me".
200 me-prefix="&7* {{displayName}} "
201 # If "true", Nucleus will attempt to modify the chat
202 modify-chat=true
203 # If true, Nucleus will take the message and try to apply it's own transforms to it. This may overwrite other plugins who do processing super early, so turn this off if you are having problems.
204 modify-main-message=true
205 # If false, Nucleus will prepend it's prefixes/headers with those already set buy other plugins. If true, it will overwrite them.
206 overwrite-early-prefixes=true
207 # If false, Nucleus will prepend it's suffixes/footers with those already set buy other plugins. If true, it will overwrite them.
208 overwrite-early-suffixes=false
209 # If true, Nucleus will try to remove any text formatted in blue and underlined that Minecraft has tried to turn into a link.
210 remove-link-underlines=true
211 templates {
212 # If true, Nucleus will select the most appropriate group template for a player when they send a chat message by checking all of the groups that a player has if the player does not have the "nucleus.chat.group" permission option set. If false, Nucleus will only look for the "nucleus.chat.group" option on players when they chat and will match that to the available group templates, if no match, Nucleus will apply the default template without checking actual permission groups.
213 #
214 # If your chat is lagging and you have group templates turned on, try setting this to false and giving your groups the appropriate "nucleus.chat.group" permission option.
215 check-permission-groups=true
216 # The default chat template if no group templates apply.
217 default {
218 # The default colour for a player's chat if the "chatcolour" permission option isn't set on the player or group. Takes the same input as the "namecolour" option set to "" to retain default behaviour (no change of colour). Do not include the "&" character.
219 default-chatcolour=""
220 # The default styles for a player's chat if the "chatstyle" permission option isn't set on the player or group. Takes the same input as the "chatstyle" option set to "" to retain default behaviour (no style). Do not include the "&" character. Multiple styles must be separated by commas.
221 default-chatstyle=""
222 # The default colour for a player's name if the "namecolour" permission option isn't set on the player or group. Takes the same input as the "chatcolour" option set to "" to retain default behaviour (no change of colour). Do not include the "&" character.
223 default-namecolour=""
224 # The default styles for a player's name if the "namestyle" permission option isn't set on the player or group. Takes the same input as the "namestyle" option, set to "" to retain default behaviour (no style). Do not include the "&" character. Multiple styles must be separated by commas.
225 default-namestyle=""
226 # Sets the prefix to a message. {{prefix}} - prefix (set as an option in a permission plugin), {{suffix}} - suffix (set as an option in a permission plugin), {{name}} - real name, {{displayname}} - display name
227 prefix="{{prefix:s}}{{displayname}}{{suffix}}&f: "
228 # Sets the suffix to a message. {{prefix}} - prefix (set as an option in a permission plugin), {{suffix}} - suffix (set as an option in a permission plugin), {{name}} - real name, {{displayname}} - display name
229 suffix=""
230 }
231 # Group templates override the default chat template based on the users group. Note that the group name is case sensitive.
232 # Weight matters, the player will use the highest weighted template in this list that matches a group they are in, including inherited groups. If the same weight is used on two or more entries, the group with the most parents will be used.
233 group-templates {
234 DefaultTemplate {
235 # The default colour for a player's chat if the "chatcolour" permission option isn't set on the player or group. Takes the same input as the "namecolour" option set to "" to retain default behaviour (no change of colour). Do not include the "&" character.
236 default-chatcolour=""
237 # The default styles for a player's chat if the "chatstyle" permission option isn't set on the player or group. Takes the same input as the "chatstyle" option set to "" to retain default behaviour (no style). Do not include the "&" character. Multiple styles must be separated by commas.
238 default-chatstyle=""
239 # The default colour for a player's name if the "namecolour" permission option isn't set on the player or group. Takes the same input as the "chatcolour" option set to "" to retain default behaviour (no change of colour). Do not include the "&" character.
240 default-namecolour=""
241 # The default styles for a player's name if the "namestyle" permission option isn't set on the player or group. Takes the same input as the "namestyle" option, set to "" to retain default behaviour (no style). Do not include the "&" character. Multiple styles must be separated by commas.
242 default-namestyle=""
243 # Sets the prefix to a message. {{prefix}} - prefix (set as an option in a permission plugin), {{suffix}} - suffix (set as an option in a permission plugin), {{name}} - real name, {{displayname}} - display name
244 prefix="{{prefix:s}}{{displayname}}{{suffix}}&f: "
245 # Sets the suffix to a message. {{prefix}} - prefix (set as an option in a permission plugin), {{suffix}} - suffix (set as an option in a permission plugin), {{name}} - real name, {{displayname}} - display name
246 suffix=""
247 # The weight of the template. A higher number will take priority over lower numbers when two templates could apply to the same player because they are in the both groups.
248 weight=1
249 }
250 }
251 # If "true", then Nucleus will select the most appropriate group template for a player when they send a chat message. If it's false
252 # the default template will always be used, but there will be a performance gain because a player's groups not not have to be retrieved from the permission plugin.
253 # Turn this off if you are getting severe performance problems when someone chats, it's usually due to a misbehaving permissions plugin.
254 use-group-templates=true
255 }
256}
257# +------------------------------------------------------------+
258# | Chat Logger |
259# +------------------------------------------------------------+
260chat-logger {
261 # Whether to actually perform any logging.
262 enable-logging=false
263 # Log chat messages to the log file.
264 log-chat=true
265 # Log mail messages to the log file.
266 log-mail=false
267 # Log private messages to the log file.
268 log-messages=true
269}
270# +------------------------------------------------------------+
271# | Command Logger |
272# +------------------------------------------------------------+
273command-logger {
274 # A comma separated list of commands in the blacklist or whitelist (see whitelist option). Only one alias per command is required.
275 command-filter=[]
276 # If any option is true, log commands from the source.
277 log-command-source {
278 command-block=false
279 console=true
280 other-source=false
281 subject=true
282 }
283 # If true, will log commands to files at /logs/nucleus/commands
284 log-to-file=true
285 # If true, the "command-filter" containing the list of commands to be logged is a whitelist (command must be specfied to be logged), not a blacklist.
286 whitelist=false
287}
288# +------------------------------------------------------------+
289# | Command Spy |
290# +------------------------------------------------------------+
291command-spy {
292 # The blacklist (or whitelist if filter-is-whitelist is true) to use when determining which commands to spy on.
293 command-filter=[]
294 # If true, command-filter acts as a whitelist of commands to spy on, else, it functions as a blacklist.
295 filter-is-whitelist=true
296 # The prefix to use when displaying the player's command.
297 prefix="&7[CS: {{name}}]: "
298}
299# +------------------------------------------------------------+
300# | Connection |
301# +------------------------------------------------------------+
302connection {
303 # The maximum number of reserved slots that can be used. Set to -1 for unlimited.
304 reserved-slots=-1
305 # If this is not empty, the message to send to players when the server is full.
306 server-full-message=""
307 # If this is not empty, the message to send to players when the server is whitelisted.
308 whitelist-message=""
309}
310# +------------------------------------------------------------+
311# | Connection Messages |
312# +------------------------------------------------------------+
313connection-messages {
314 # The message to display to players if a name change has been detected. Use {{previousname}} as the token for the player's previous name.
315 changed-name-message="&f{{name}} &ewas previously known by a different name - they were known as &f{{previousname}}"
316 # If true, those with the "nucleus.connectionmessages.disable" permission will not trigger login/logout messages.
317 disable-with-permission=true
318 # If true, will inform players on the server when a player logs on and a name change has been detected.
319 display-name-change-if-changed=true
320 # This message uses all the standard Minecraft colour codes, prefixed by "&". Use "{{name}}" for the new player's name.
321 first-login-message="&dWelcome &f{{name}} &dto &5Pixelmon Mythic&d!"
322 # If "true", Nucleus will try to make sure that everyone sees connection messages. Note that plugins can potentially override this.
323 force-show-all-connection-messages=true
324 # Shown when a user logs in. This message uses all the standard Minecraft colour codes, prefixed by "&". Use "{{name}}" for the player's name.
325 login-message="&8[&a+&8] &f{{name}}"
326 # Shown when a user logs out. This message uses all the standard Minecraft colour codes, prefixed by "&". Use "{{name}}" for the player's name.
327 logout-message="&8[&c-&8] &f{{name}}"
328 # Enables changing the login message.
329 modify-login-message=false
330 # Enables changing the logout message.
331 modify-logout-message=false
332 # Enables the first time login message.
333 show-first-login-message=true
334}
335# +------------------------------------------------------------+
336# | Core |
337# +------------------------------------------------------------+
338core {
339 # If true, if you log in and have the "wildcard" permission (either * or nucleus), you will be warned of the potential issues caused by the wildcard. If you use the wildcard and are happy with this, set this to false.
340 check-for-wildcard=true
341 # If set, this command will be suggested if a player clicks on the user name in chat in templated messages. Use {{player}} to indicate the player name.
342 command-on-name-click="/msg {{subject}}"
343 # If true, commands executed by the console can affect players that normally have an exempt permission against the command.
344 console-overrides-exemptions=true
345 # Specifies the path to save nucleus data files in. By default, files are saved at the root. Paths can be relative or absolute.
346 #
347 # BE AWARE. Changing this location has the following caveats:
348 # * This will only take effect after a restart.
349 # * Files are NOT moved from the old location, you must do this yourself.
350 # * Files will be in a "nucleus" subdireectory of your selected location.
351 # * If the path indicated cannot be found, this will be ignored. It **must** exist beforehand.
352 # * Minecraft data (as opposed to Nucleus data) is unaffected.
353 #
354 # Common areas that you might want to put the data directory in are (using UNIX paths):
355 # * "config/nucleus" for data in the Nucleus config data directory
356 # * "world" for storing data in the primary world directory.
357 #
358 # DO NOT CHANGE THIS UNLESS YOU ARE SURE YOU KNOW WHAT YOU ARE DOING. Most admins do not need to move the data directory and should leave this option as "default".
359 data-file-location=default
360 # Enables debug mode, which will cause stack traces from commands to be printed to the console.
361 debug-mode=false
362 kick-on-stop {
363 # If true, Nucleus will kick all users just prior to the server stopping.
364 enabled=false
365 # The message to display to players when restarting the server. Overridden when using the /stop [reason] command.
366 message="Server closed"
367 }
368 # When trying to calculate the number of visitors, having this enabled will include visitors before Nucleus was installed, but may cause incompatibilities with other plugins that do not register data keys during startup. For compatibility, this should be false, for accuracy, this can be true.
369 more-accurate-visitor-count=false
370 # If set to "default", uses the default system language if it exists in Nucleus. If set to a language code, Nucleus will try to use that as the default language. Nucleus is primarily written in "en-GB".
371 #
372 # Community translation support is being explored. Please visit us on Discord to ask how you can help translate Nucleus into your own language.
373 override-language=default
374 # Prints to console when a Nucleus save is occurring.
375 print-on-autosave=false
376 # These parameters define how far out to check from a specific point when performing a warp. Larger numbers mean that a wider area is checked, but large numbers will cause server lag. The defaults are sufficient in most cases.
377 safe-teleport-check {
378 height=3
379 width=9
380 }
381 # If true and no economy or permission plugin is detected, Nucleus will print a warning on startup. Set this to false if you dont have one of these types of plugins and youre OK with that.
382 show-warning-on-startup=true
383 # If true, a "messages.conf" file will be generated and used to define custom messages.
384 use-custom-message-file=false
385 # If true, cancel a user's warmup on...
386 warmup-canceling {
387 # running a command
388 cancel-on-command=true
389 # movement
390 cancel-on-move=true
391 }
392 # If you are having issues because a world UUID changed and you were unable to fix it, this allows you to redirect old UUIDs to new ones (or world names). This is a map of old world UUIDs to new world names or new world UUIDs, the following are both valid:
393 #
394 # "123e4567-e89b-12d3-a456-426655440000"="world"
395 #
396 # "123e4567-e89b-12d3-a456-426655440000"="1b671a64-40d5-491e-99b0-da01ff1f3341"
397 #
398 # Other plugins will be able to check this map to perform their own migrations, support for that is up to those plugins.
399 world-uuid-migration {}
400}
401# +------------------------------------------------------------+
402# | Death Messages |
403# +------------------------------------------------------------+
404death-message {
405 # If "false", death messages will be turned off when someone dies.
406 enable-death-messages=false
407 # If "true", Nucleus will try to make sure that everyone sees death messages.
408 force-show-all-death-messages=false
409}
410# +------------------------------------------------------------+
411# | Environment |
412# +------------------------------------------------------------+
413environment {
414 # The maximum amount of time that the weather can be set to last, in seconds. Set to -1 for no restriction.
415 maximum-weather-timespan=-1
416}
417# +------------------------------------------------------------+
418# | Fly |
419# +------------------------------------------------------------+
420fly {
421 # If true, and the player isn't flying and the player is in the air, Nucleus will try to find a safe location to place the player.
422 find-safe-location-on-login=true
423 # If true, in order to keep fly state on login, the permission for the fly command (nucleus.fly.base) is required. If false, a player without access to the /fly command will fall to the ground on login if they are in the air.
424 require-fly-permission-on-login=false
425 # If true, if a player is flying when they disconnect, this state is remembered. If false, this information is only retained between player disconnects if /fly was used.
426 save-all-flystate-on-quit=true
427}
428# +------------------------------------------------------------+
429# | Home |
430# +------------------------------------------------------------+
431home {
432 # If true, if a player has more homes than the permission option "home-count" allows, then players will not be able to use any homes until they delete homes to be at the limit again.
433 prevent-home-count-overhang=true
434 # If true, on respawn, a player will spawn back at their default home (named "home") if it exists.
435 respawn-at-home=false
436 # If true, Nucleus will attempt to ensure that users do not get warped into an unsafe situation (for example, if someone breaks blocks around a home).
437 use-safe-warp=true
438}
439# +------------------------------------------------------------+
440# | Info |
441# +------------------------------------------------------------+
442info {
443 info {
444 # If "use-default-info-section" is true, this section is displayed when a player runs "/info", not the section list.
445 default-info-section=info
446 # If true, when a player runs "/info", the section specified in "default-info-section" will be used, that is, /info will work the same as /info <default-section>.
447 # The list of sections can still be viewed by running "/info -l", if the user has the "nucleus.info.list" permission. If false, or the section does not exist, this list is shown, regardless of this permission.
448 use-default-info-section=false
449 }
450 motd {
451 # The amount of time to wait (in seconds) before sending the MOTD to a player who has just logged in.
452 motd-login-delay=0.5
453 # The title to show at the top of each MOTD page. Colour codes are supported. If blank, this hides the title completely.
454 motd-title=""
455 # If true, show players the MOTD as defined in "motd.txt" when they log onto the server.
456 show-motd-on-join=true
457 # If false, this disables the pagination system for the MOTD. Set this to false if you have one page, do not want a title, and do not want the << >> marks to appear, otherwise, it is recommended to set this to true.
458 use-pagination=false
459 }
460}
461# +------------------------------------------------------------+
462# | Invulnerability |
463# +------------------------------------------------------------+
464invulnerability {
465 # If true, players that are invulnerable will not be able to attack other players or entities without the nucleus.god.pvp.override permission
466 disable-pvp-on-god=false
467 # If true, in order to keep invulnerability on login, the permission for the god command (nucleus.god.base) is required. If false, a player without access to the /god will not be invulnerable on login.
468 require-god-permission-on-login=false
469}
470# +------------------------------------------------------------+
471# | Item |
472# +------------------------------------------------------------+
473item {
474 repair {
475 # The list of item types to prevent (or allow if whitelist is true) repairing using /repair
476 restrictions=[]
477 # If true, the restriction list will be used as a whitelist vs a blacklist.
478 use-whitelist=false
479 }
480 skull {
481 # If true, Nucleus will simply treat /skull as an alias to "/give [player] skull [number] 3 {SkullOwner:[skullplayer]}"
482 use-minecraft-command=false
483 }
484}
485# +------------------------------------------------------------+
486# | Jail |
487# +------------------------------------------------------------+
488jail {
489 # The commands that players are allowed to execute in jail. Do not include the slash.
490 allowed-commands=[
491 m,
492 msg,
493 r,
494 mail,
495 rules,
496 info
497 ]
498 # If true, jail time will only tick down when players are online.
499 jail-time-counts-online-only=false
500 # If true, the player will be muted when in jail.
501 mute-when-jailed=false
502 # If true, then the permission "nucleus.jail.unjail" is required to unjail players.
503 require-separate-unjail-permission=false
504}
505# +------------------------------------------------------------+
506# | Jump |
507# +------------------------------------------------------------+
508jump {
509 # The maximum distance a player can move using the /jump command. Negative values mean infinite - use with care.
510 max-jump-distance=350
511 # The maximum distance a player can move using the /thru command. Negative values mean infinite - use with care.
512 max-thru-distance=25
513 unstuck-distances {
514 # The maximum distance vertically /unstuck can send you.
515 height=1
516 # The maximum distance horizontally /unstuck can send you.
517 horizontal-radius=1
518 }
519}
520# +------------------------------------------------------------+
521# | Kit |
522# +------------------------------------------------------------+
523kit {
524 # If true, any items that couldn't be placed in the player's inventory will be dropped on the floor around them.
525 drop-items-if-inventory-full=true
526 # If this is true, "drop-items-if-inventory-full" will be ignored, and the kit will only be consumed if everything can be consumed.
527 must-get-all-items=false
528 # If true, any tokens such as {{name}} and {{displayname}} will be translated on item names and lore, if they exist, when kits are redeemed.
529 process-tokens-in-lore=false
530}
531# +------------------------------------------------------------+
532# | Message |
533# +------------------------------------------------------------+
534message {
535 # The prefix to any message received via /helpop.
536 helpop-prefix="&7HelpOp: {{name}} &7> &r"
537 # The prefix for received messages. This is displayed to the receiever. Use {{from}} and {{to}} for the message sender/receiver, {{fromDisplay}} or {{toDisplay}} for the display names.
538 msg-receiver-prefix="&7[{{fromDisplay}}&7 -> me]: &r"
539 # The prefix for sent messages. This is displayed to the sender. Use {{from}} and {{to}} for the message sender/receiver, {{fromDisplay}} or {{toDisplay}} for the display names.
540 msg-sender-prefix="&7[me -> {{toDisplay}}&7]: &r"
541 socialspy {
542 # If true, Nucleus will check the "nucleus.socialspy.force" permission on the subject to disallow disabling Social Spy.
543 allow-forced=false
544 # The tag to show at the beginning of a Social Spy message when a player is muted (or otherwise has the message cancelled).
545 cancelled-messages-tag="&c[cancelled] "
546 # Sets the social spy level of the server and any custom message targets.
547 levels {
548 # The social spy level of any custom target that has been registered through the API.
549 custom-targets=2147483647
550 # The server's social spy level.
551 server=2147483647
552 }
553 # The prefix and format for messages sent to social spies. Use {{from}} and {{to}} for the message sender/receiver, {{fromDisplay}} or {{toDisplay}} for the display names. The colours and style at the end of the prefix will be carried over into the message.
554 msg-prefix="&7[SocialSpy] [{{fromDisplay}}&7 -> {{toDisplay}}&7]: &r"
555 # The tag to show at the beginning of a Social Spy message when a player cannot send a message to a player who hasused /msgtoggle (blocking messages from all players).
556 msgtoggle-blocked-messages-tag="&c[blocked] "
557 # If true, and "use-levels" is true, players with social spy will also see messages from players at their own level.
558 same-levels-can-see-each-other=true
559 # Controls the types of *sender* that can be spied on.
560 senders-to-spy-on {
561 custom-target=true
562 player=true
563 server=false
564 }
565 # If true, show messages that players try to send and are cancelled (usually due to being muted).
566 show-cancelled-messages=false
567 # If true, Nucleus will check the "nucleus.socialspy.level" option on the subject for an integer level. A level can see their messages from and to players with levels below their own,
568 # unless "same-levels-can-see-each-other" is set to true, in which case, social spies can see messages from their own level. Players have a default level of 0.
569 use-levels=false
570 }
571}
572# +------------------------------------------------------------+
573# | Miscellaneous |
574# +------------------------------------------------------------+
575misc {
576 # Sets the maximum speed that a player can set via the /speed command.
577 max-speed=5
578}
579# +------------------------------------------------------------+
580# | Mob |
581# +------------------------------------------------------------+
582mob {
583 # The maximum number of mobs that can be spawned using /spawnmob.
584 max-mobs-to-spawn=20
585 # If true, Nucleus will make an additional permission check to check whether a player can spawn a mob.
586 # The permission is "nucleus.spawnmob.mobs.<mobid>", where the mobid has any ":" (colons) replaced with "." (period). So, the permission to spawn a creeper would be
587 # "nucleus.spawnmob.mobs.minecraft.creeper". This allows server owners to allow all vanilla mobs with the permission "nucleus.spawnmob.mobs.minecraft".
588 separate-mob-spawning-permissions=false
589 # Controls the mobs that cannot be spawned. Each section is world specific, with the key being the world name in question, which is case sensitive.
590 spawning-blocks {
591 DIM-1 {
592 # The full IDs of the mobs to block. Minecraft mobs have an id starting with "minecraft:"
593 block-mobs-with-ids=null
594 # If true, all vanilla mobs will be blocked in this world.
595 block-vanilla-mobs=false
596 }
597 DIM1 {
598 # The full IDs of the mobs to block. Minecraft mobs have an id starting with "minecraft:"
599 block-mobs-with-ids=null
600 # If true, all vanilla mobs will be blocked in this world.
601 block-vanilla-mobs=false
602 }
603 world {
604 # The full IDs of the mobs to block. Minecraft mobs have an id starting with "minecraft:"
605 block-mobs-with-ids=null
606 # If true, all vanilla mobs will be blocked in this world.
607 block-vanilla-mobs=false
608 }
609 }
610}
611# +------------------------------------------------------------+
612# | Mute |
613# +------------------------------------------------------------+
614mute {
615 # Commands to block when muted. This is in addition to chat and /m already being blocked.
616 blocked-commands=[
617 "minecraft:me",
618 say
619 ]
620 # The maximum length a mute may last for (in seconds) unless the user handing the mute has a bypass permission. Set to -1 for no maximum.
621 maximum-mute-length=604800
622 # If true, mute time will only tick down when players are online.
623 mute-time-counts-online-only=false
624 # The tag to prepend any cancelled/muted messages with.
625 muted-chat-tag="&c[cancelled] "
626 # If true, then the permission "nucleus.mute.unmute" is required to unmute players.
627 require-separate-unmute-permission=true
628 # If true, those with the "nucleus.mute.seemutedchat" permission will see chat from those who are muted.
629 see-muted-chat=true
630}
631# +------------------------------------------------------------+
632# | Name Banning |
633# +------------------------------------------------------------+
634nameban {
635 default-reason="Your Minecraft username is not appropriate for this server. Please change it before attempting to access this server."
636}
637# +------------------------------------------------------------+
638# | Nickname |
639# +------------------------------------------------------------+
640nickname {
641 # The maximum number of visible characters that the nickname can be.
642 max-nickname-length=20
643 # The minimum number of visible characters that the nickname can be.
644 min-nickname-length=3
645 # A regular expression that limits what form the nickname can take. If Nucleus fails to read the regex here, the default of "[a-zA-Z0-9_]+" (the same restriction as Minecraft usernames) will be used. To allow all characters, use ".+".
646 pattern="[a-zA-Z0-9_]+"
647 # A prefix to any nickname that is displayed in chat.
648 prefix="&b~"
649}
650# +------------------------------------------------------------+
651# | Note |
652# +------------------------------------------------------------+
653note {
654 # If true, users with the permission nucleus.note.showonlogin will be shown a users notes when they login. If false, they will not.
655 show-login=true
656}
657# +------------------------------------------------------------+
658# | Player Info |
659# +------------------------------------------------------------+
660playerinfo {
661 list {
662 list-grouping-by-permission {
663 # If listing by groups is enabled, the group name to display when a player is not in a group.
664 default-group-name=Default
665 # If enabled, list players by their groups.
666 enabled=false
667 # If listing by groups is enabled, then any group listed here (on the left side of an equals sign) will be given the display name on the right hand side.
668 # Multiple groups can be given the same alias, they will be grouped together.
669 group-aliases {
670 example-default-group="Default Group"
671 example-default-group-2="Default Group"
672 }
673 # Any group aliases in this list will be listed in this order, above all other groups, which will be displayed in alphabetical order below.
674 group-order=[]
675 # If true, if an alias hasn't been defined for a group in the `group-aliases` section, it's considered as part of the `default` group.
676 use-aliases-only=false
677 }
678 # Enable this if you are using a server panel, such as Multicraft or PterodactylPanel. This will run /minecraft:list when /list is run on the console.
679 server-panel-compatibility=false
680 # The template to use to display a player's name. Uses the same tokens as chat. Defaults to "{{displayname}}".
681 template="{{displayname}}"
682 }
683 seen {
684 # If true, the permission "nucleus.seen.extended" is required for all information that comes from modules. If false, information will be displayed based on the command permissions a player has (so, a player with check ban rights can see banning information).
685 require-extended-permission-for-module-info=false
686 }
687}
688# +------------------------------------------------------------+
689# | Protection |
690# +------------------------------------------------------------+
691protection {
692 # Disables crop trampling.
693 disable-crop-trample {
694 mobs=false
695 players=false
696 }
697 mob-griefing {
698 # If true, mob griefing will be disabled except for the entities listed in the whitelist (which should be done by mob ID).
699 enable-protection=false
700 whitelist=[]
701 }
702}
703# +------------------------------------------------------------+
704# | rtp |
705# +------------------------------------------------------------+
706rtp {
707 # The number of times to try to find a safe teleport spot when using /rtp before failing. Setting this too low may cause a high rate of failures.
708 attempts=15
709 # If true, the rtp will based around the player, not the world centre
710 center-on-player=false
711 # If this is set, and the world name here matches one of your worlds (case-sensitive!), then `/rtp` will default to use the world specified here. Otherwise, the player's current world will be used.
712 default-world=world
713 # The maximum Y value that can be teleported to.
714 maximum-y=80
715 # The minimum radius from the centre of the world/world border where /rtp will warp to.
716 min-radius=0
717 # The minimum Y value that can be teleported to.
718 minimum-y=60
719 # If true, Nucleus will check the permission "nucleus.rtp.worlds.<worldname>" (where worldname is in lower case) before allowing an RTP attempt to go through.
720 per-world-permissions=false
721 # The maximum radius from the centre of the world/world border where /rtp can warp to. This will not override the world border radius.
722 radius=30000
723 # If true, /rtp will only try to teleport players to the surface, and not into caves.
724 surface-only=true
725 # If a world is listed below with a valid config section, it will take precedence over the global section. World names should be lower case (so, standard nether should be "dim-1".
726 #
727 # Copy the example block and paste it below, with the correct world name, to set the per-world options.
728 world-overrides {
729 example {
730 # If true, the rtp will based around the player, not the world centre
731 center-on-player=false
732 maximum-y=255
733 min-radius=30000
734 minimum-y=0
735 radius=30000
736 surface-only=false
737 }
738 }
739}
740# +------------------------------------------------------------+
741# | Rules |
742# +------------------------------------------------------------+
743rules {
744 # The rules page title.
745 rules-title="&6Server Rules"
746}
747# +------------------------------------------------------------+
748# | Server List |
749# +------------------------------------------------------------+
750server-list {
751 # If true, the player count will not be displayed.
752 hide-player-count=false
753 # If true, any player that is vanished on the server will not appear in the online player list on the server list.
754 hide-vanished-players=false
755 # If "true", when a prospective player pings the server on the multiplayer server list, one of the messages in the list below will be sent to the player. If "whitelist", this module will only act when the whitelist is enabled.
756 modify-server-list-messages=FALSE
757 # Potential messages that could be sent to the player. To split over two lines, include \n where you want the line break to appear.
758 server-list-messages=[
759 "&bWelcome to the server!\n&cCome join us!"
760 ]
761 # Potential messages that could be sent to the player when the server is whitelisted. To split over two lines, include \n where you want the line break to appear.
762 #
763 # If no entries are here, the MOTD will use the `server-list-messages` list.
764 whitelist-server-list-messages=[]
765}
766# +------------------------------------------------------------+
767# | Server Shop |
768# +------------------------------------------------------------+
769server-shop {
770 # The maximum amount a player can buy in one transaction.
771 max-purchasable-at-once=64
772}
773# +------------------------------------------------------------+
774# | Spawn |
775# +------------------------------------------------------------+
776spawn {
777 # If true, if a respawn would be back to a bed, Nucleus will override that, if false, Nucleus will ignore bed spawns.
778 affect-bed-spawn=true
779 # If true, then Nucleus will attempt to force players joining for the first time to spawn at the *direct point* that first spawn has been set.
780 # Only set this if you want Nucleus to override all other plugins on first spawn.
781 force-first-spawn=false
782 # This section controls whether respawning and /spawn work on a per world or global server basis
783 global-spawn {
784 # If "spawn-on-login" is on and this is true, sends the player to the world specified in "target-spawn-world" when they log in.
785 on-login=false
786 # If true, respawning (like from death) sends the player to the world specified in "target-spawn-world", if false, sends them to the world spawn.
787 on-respawn=true
788 # If true, running /spawn sends the player to the world specified in "target-spawn-world", if false, sends them to the world spawn.
789 on-spawn-command=true
790 # The name of the world to use as the server spawn. If this is invalid, the default world is used instead.
791 target-spawn-world=newspawn
792 }
793 # If true, players require the permission "nucleus.spawn.worlds.<worldname>" to spawn in a specific world, where worldname is the name of the world in lowercase.
794 per-world-permissions=false
795 # If true, players will be sent to the default world spawn on login, unless they are sent to the first login spawn, or they have the "nucleus.spawn.exempt.onjoin" permission.
796 spawn-on-login=false
797 # If true, using /spawn will attempt to find a safe place. If false, the teleportation will always directly send the player to the location with no safety checks.
798 use-safe-spawn=true
799}
800# +------------------------------------------------------------+
801# | Staff Chat |
802# +------------------------------------------------------------+
803staff-chat {
804 # If true, Nucleus will include all the normal chat tags in the message, in addition to the prefix.
805 "include-standard-chat-formatting"=false
806 # A Minecraft colour code the denotes the colour to display Staff Chat channel messages in.
807 message-colour=b
808 # The prefix to the staff chat message. Use the following tokens: {{prefix}} - prefix (set as an option in a permission plugin), {{suffix}} - suffix (set as an option in a permission plugin), {{name}} - real name, {{displayname}} - display name.
809 # If "include-standard-chat-formatting" is set to "true", the formatting will be appended to this prefix.
810 message-template="&b[STAFF] &r{{displayname}}&b: "
811}
812# +------------------------------------------------------------+
813# | Teleport |
814# +------------------------------------------------------------+
815teleport {
816 # If true, by default, a target player will not be informed that they have been /teleport ed to. Override using "-q false"
817 default-quiet=true
818 # If true, teleporting tries to find a safe place for players.
819 use-safe-teleportation=true
820}
821# +------------------------------------------------------------+
822# | Vanish |
823# +------------------------------------------------------------+
824vanish {
825 # [EXPERIMENTAL - use with caution] If true, Nucleus will try to alter the tab list when a player vanishes.
826 alter-tab-list=false
827 # If true, players who leave or join the server under vanish will not have a login or logout message broadcast.
828 hide-connection-messages-on-vanish=true
829}
830# +------------------------------------------------------------+
831# | Warn |
832# +------------------------------------------------------------+
833warn {
834 # The command to execute when a player has a specific number of warnings.
835 action-command="tempban {{name}} 6h Exceeding the active warning threshold"
836 # The default length a warning is set to if no length is provided (in seconds). Set to -1 for no maximum.
837 default-length=-1
838 # If true, a record of players warnings will be kept as 'expired warnings'. If false, they will not.
839 expire-warnings=true
840 # The maximum length a warning may last for (in seconds). Set to -1 for no maximum.
841 maximum-warn-length=-172800
842 # The minimum length a warning will last before expiring (in seconds). Set to -1 for no minimum.
843 minimum-warn-length=-1
844 # If true, players will be shown all their warnings when they login. If false, they will not.
845 show-login=true
846 # The number of active warnings a player must accumulate before the action command is executed. Set to -1 to disable.
847 warnings-before-action=5
848}
849# +------------------------------------------------------------+
850# | Warp |
851# +------------------------------------------------------------+
852warp {
853 default-category-name=Uncategorised
854 # The default cost for a warp. Can be overriden using /warp setcost <warp> <cost>
855 default-warp-cost=0
856 # If true, warps will be displayed by category in /warp list.
857 list-warps-by-category=false
858 # If this is set to true, each warp has its own permission node - nucleus.warps.<name>.
859 separate-permissions=false
860 # If true, the warp description will be shown in /warp list, and the co-ords will be shown in the tooltip on hover.
861 show-warp-description-in-list=false
862 # If true, using /warp will attempt to find a safe place. If false, the teleportation will always directly send the player to the location with no safety checks.
863 use-safe-warp=true
864}
865# +------------------------------------------------------------+
866# | World |
867# +------------------------------------------------------------+
868world {
869 # If positive, any new worlds that are created using "/world create" (or "/nworld create") will automatically get a world border that has this diameter (that is, from border to border). Set to 0 or a negative number to disable.
870 default-world-border-diameter=25000
871 # If true, joining or changing worlds will change the gamemode of a player unless they have the Minecraft permission "nucleus.world.force-gamemode.override"
872 enforce-gamemode-on-world-change=true
873 pre-generation {
874 # If true, then players with the "nucleus.world.border.gen.notify" permission will get an update on progress after each generation. Recommended to be off, because it can be VERY spammy.
875 display-after-each-gen=false
876 # If true world generation will warn players on the server that a pre-generation is in progress periodically.
877 display-generation-warning=true
878 # Time, in seconds, between notifications in chat warning players a pre-gen is in progress.
879 notification-interval=20
880 }
881 # If true, changing worlds requires permission to access the target world - "nucleus.worlds.<worldname>"
882 separate-permissions=false
883}