· 6 years ago · Mar 24, 2020, 03:36 AM
1# Welcome to Nucleus 1.14.3-S7.1. 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 # Provide personal warps for players
58 home=ENABLED
59 # Allows players to ignore others in chat
60 ignore=ENABLED
61 # Lets users see more information about the server, provided by server owners in text files
62 info=ENABLED
63 # Allows for investigating others' inventories
64 inventory=ENABLED
65 # Allows for players to become invulnerable
66 invulnerability=ENABLED
67 # Allows for the maniuplation of items, including names, lore and enchantments
68 item=ENABLED
69 # Enables jails, for punishing players
70 jail=ENABLED
71 # Enables warping to nearby locations
72 jump=ENABLED
73 # Enhances the Minecraft kick function
74 kick=ENABLED
75 # Allows servers to provide players with kits of items and commands, that can be run on demand or automatically
76 kit=ENABLED
77 # Allows users to send semi-permanent mails to each other
78 mail=ENABLED
79 # Enhances the Minecraft whisper functions
80 message=ENABLED
81 # Miscellaneous functions
82 misc=ENABLED
83 # Controls the spawning of mobs
84 mob=ENABLED
85 # Enables preventing players from sending chat messages to the server
86 mute=ENABLED
87 # Bans players with pre-determined names (rather than UUIDs)
88 nameban=ENABLED
89 # Allows players to have nicknames that are different from their Minecraft name
90 nickname=ENABLED
91 # Allows staff to make notes on players, for server record keeping
92 note=ENABLED
93 # Adds commands to display information about players
94 playerinfo=ENABLED
95 # Allows users to bind commands to items, to activate on item use
96 powertool=ENABLED
97 # Adds basic crop trampling and mob griefing protection
98 protection=ENABLED
99 # Allows players to teleport to a random location
100 rtp=ENABLED
101 # Adds a rules command
102 rules=ENABLED
103 # Allows for modification of the server list entry for the server
104 server-list=ENABLED
105 # Adds a simplistic command based server shop for buying and selling items
106 server-shop=ENABLED
107 # Makes it easy to add formatting to signs
108 sign=ENABLED
109 # Controls the player spawning mechanics of the server
110 spawn=ENABLED
111 # Adds a chat channel for server staff
112 staff-chat=ENABLED
113 # Adds functions for teleporting players to/from other players, offline teleports and positional teleports
114 teleport=ENABLED
115 # Allows players to go invisible
116 vanish=ENABLED
117 # Adds a simple warning system for minor rule breaks, which can automatically punish the player.
118 warn=ENABLED
119 # Adds a public warp point system
120 warp=ENABLED
121 # World management, including world borders
122 world=ENABLED
123}
124# +------------------------------------------------------------+
125# | Admin |
126# +------------------------------------------------------------+
127admin {
128 # The prefix and suffix when sending a broadcast message. Accepts chat tokens such as {{displayname}}, {{name}}, etc.
129 broadcast-message-template {
130 prefix="&a[Broadcast] "
131 suffix=""
132 }
133}
134# +------------------------------------------------------------+
135# | AFK |
136# +------------------------------------------------------------+
137afk {
138 # 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".
139 afk-time=300
140 # 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".
141 #
142 # Note that this is not time since going AFK, but time since last activity. Setting this to the same value as "afktime" will cause someone who goesAFK to be kicked instantly.
143 afk-time-to-kick=0
144 # 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.
145 alert-on-command-send=true
146 # If true, the server will always announce when players go AFK, even when vanished. If false, players who are vanished and go AFK will not have this status broadcasted.
147 broadcast-afk-when-vanished=false
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=true
150 # If true, a player in spectator mode will not have their status broadcasted to players, nor will they be kicked for going AFK. Those with the notify permission will still see the AFK messages.
151 disable-in-spectator-mode=false
152 # If any of the messages tht would be broadcast to the server are blank, they will not be sent.
153 messages {
154 # The message sent to a player when kicked for inactivity.
155 kick-message-to-subject="You have been kicked for being AFK for too long."
156 on-afk="&7*&f{{displayname}} &7has gone AFK."
157 on-command="&f{{displayname}} &7is currently AFK and may not respond quickly."
158 # If empty, no message will be sent.
159 on-kick="&f{{displayname}} &7has been kicked for being AFK too long."
160 on-return="&7*&f{{displayname}} &7is no longer AFK."
161 }
162 # Determines what actions determines if a player is active.
163 triggers {
164 # Marks a player as active if they chat
165 on-chat=true
166 # Marks a player as active if they run a command
167 on-command=true
168 # Marks a player as active if they interact
169 on-interact=true
170 # Marks a player as active if they move
171 on-movement=true
172 # Marks a player as active if they rotate (that is, look around)
173 on-rotation=true
174 }
175}
176# +------------------------------------------------------------+
177# | Back |
178# +------------------------------------------------------------+
179back {
180 # Log player's location on death.
181 on-death=true
182 # Log player's last location after travelling through a portal.
183 on-portal=false
184 # Log player's last location on warp.
185 on-teleport=true
186 # If true, when a player is in a different dimension than the back target, then this player will require the nucleus.back.exempt.samedimension permission to be able to go back.
187 only-same-dimension=false
188}
189# +------------------------------------------------------------+
190# | Bans |
191# +------------------------------------------------------------+
192ban {
193 # 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.
194 maximum-tempban-length=604800
195}
196# +------------------------------------------------------------+
197# | Chat |
198# +------------------------------------------------------------+
199chat {
200 # Some mods and plugins move the Minecraft player prefix to the main message body. If this is the case, turn this on, and Nucleus
201 # will try to remove it.
202 check-body-for-minecraft-prefix=false
203 # The prefix to use when someone uses "/me".
204 me-prefix="&7* {{displayName}} "
205 # If "true", Nucleus will attempt to modify the chat
206 modify-chat=true
207 # 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.
208 modify-main-message=true
209 # If false, Nucleus will prepend it's prefixes/headers with those already set buy other plugins. If true, it will overwrite them.
210 overwrite-early-prefixes=false
211 # If false, Nucleus will prepend it's suffixes/footers with those already set buy other plugins. If true, it will overwrite them.
212 overwrite-early-suffixes=false
213 # If true, Nucleus will try to remove any text formatted in blue and underlined that Minecraft has tried to turn into a link.
214 remove-link-underlines=true
215 templates {
216 # 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.
217 #
218 # 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.
219 check-permission-groups=true
220 # The default chat template if no group templates apply.
221 default {
222 # 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.
223 default-chatcolour=""
224 # 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.
225 default-chatstyle=""
226 # 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.
227 default-namecolour=""
228 # 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.
229 default-namestyle=""
230 # 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
231 prefix="{{prefix:s}}{{displayname}}{{suffix}}&f: "
232 # 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
233 suffix=""
234 }
235 # Group templates override the default chat template based on the users group. Note that the group name is case sensitive.
236 # 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.
237 group-templates {
238 DefaultTemplate {
239 # 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.
240 default-chatcolour=""
241 # 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.
242 default-chatstyle=""
243 # 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.
244 default-namecolour=""
245 # 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.
246 default-namestyle=""
247 # 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
248 prefix="{{prefix:s}}{{displayname}}{{suffix}}&f: "
249 # 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
250 suffix=""
251 # 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.
252 weight=1
253 }
254 }
255 # If "true", then Nucleus will select the most appropriate group template for a player when they send a chat message. If it's false
256 # 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.
257 # Turn this off if you are getting severe performance problems when someone chats, it's usually due to a misbehaving permissions plugin.
258 use-group-templates=true
259 }
260 # If true, Nucleus tries to remove the minecraft name prefix (<name>).
261 try-to-remove-minecraft-prefix=true
262}
263# +------------------------------------------------------------+
264# | Chat Logger |
265# +------------------------------------------------------------+
266chat-logger {
267 # Whether to actually perform any logging.
268 enable-logging=false
269 # Log chat messages to the log file.
270 log-chat=true
271 # Log mail messages to the log file.
272 log-mail=false
273 # Log private messages to the log file.
274 log-messages=true
275}
276# +------------------------------------------------------------+
277# | Command Logger |
278# +------------------------------------------------------------+
279command-logger {
280 # A comma separated list of commands in the blacklist or whitelist (see whitelist option). Only one alias per command is required.
281 command-filter=null
282 # If any option is true, log commands from the source.
283 log-command-source {
284 command-block=false
285 console=true
286 other-source=false
287 subject=true
288 }
289 # If true, will log commands to files at /logs/nucleus/commands
290 log-to-file=false
291 # 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.
292 whitelist=false
293}
294# +------------------------------------------------------------+
295# | Command Spy |
296# +------------------------------------------------------------+
297command-spy {
298 # The blacklist (or whitelist if filter-is-whitelist is true) to use when determining which commands to spy on.
299 command-filter=null
300 # If true, command-filter acts as a whitelist of commands to spy on, else, it functions as a blacklist.
301 filter-is-whitelist=true
302 # The prefix to use when displaying the player's command.
303 prefix="&7[CS: {{name}}]: "
304}
305# +------------------------------------------------------------+
306# | Connection |
307# +------------------------------------------------------------+
308connection {
309 # The maximum number of reserved slots that can be used. Set to -1 for unlimited.
310 reserved-slots=-1
311 # If this is not empty, the message to send to players when the server is full.
312 server-full-message=""
313 # If this is not empty, the message to send to players when the server is whitelisted.
314 whitelist-message=""
315}
316# +------------------------------------------------------------+
317# | Connection Messages |
318# +------------------------------------------------------------+
319connection-messages {
320 # The message to display to players if a name change has been detected. 'Use {{previousname}} as the token for the player's previous name.'
321 changed-name-message="&f{{name}} &ewas previously known by a different name - they were known as &f{{previousname}}"
322 # If true, those with the "nucleus.connectionmessages.disable" permission will not trigger login/logout messages.
323 disable-with-permission=false
324 # If true, will inform players on the server when a player logs on and a name change has been detected.
325 display-name-change-if-changed=true
326 # This message uses all the standard Minecraft colour codes, prefixed by "&". Use '"{{name}}"' for the new player's name.
327 first-login-message="&dWelcome &f{{name}} &dto the server!"
328 # If "true", Nucleus will try to make sure that everyone sees connection messages. Note that plugins can potentially override this.
329 force-show-all-connection-messages=true
330 # Shown when a user logs in. This message uses all the standard Minecraft colour codes, prefixed by "&". Use '"{{name}}"' for the player's name.
331 login-message="&8[&a+&8] &f{{name}}"
332 # Shown when a user logs out. This message uses all the standard Minecraft colour codes, prefixed by "&". Use '"{{name}}"' for the player's name.
333 logout-message="&8[&c-&8] &f{{name}}"
334 # Enables changing the login message.
335 modify-login-message=false
336 # Enables changing the logout message.
337 modify-logout-message=false
338 # Enables the first time login message.
339 show-first-login-message=true
340}
341# +------------------------------------------------------------+
342# | Core |
343# +------------------------------------------------------------+
344core {
345 # If set, Nucleus will attempt to autodetect the appropriate language for your system. If false, if a language packis not available, Nucleus will attempt to use UK English (en_GB).
346 attempt-lanugage-autodetect=true
347 # 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.
348 check-for-wildcard=false
349 # 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.
350 command-on-name-click="/msg {{subject}}"
351 # If true, commands executed by the console can affect players that normally have an exempt permission against the command.
352 console-overrides-exemptions=true
353 # Specifies the path to save nucleus data files in. By default, files are saved at the root. Paths can be relative or absolute.
354 #
355 # BE AWARE. Changing this location has the following caveats:
356 # * This will only take effect after a restart.
357 # * Files are NOT moved from the old location, you must do this yourself.
358 # * Files will be in a "nucleus" subdirectory of your selected location.
359 # * If the path indicated cannot be found, this will be ignored. It **must** exist beforehand.
360 # * Minecraft data (as opposed to Nucleus data) is unaffected.
361 #
362 # Common areas that you might want to put the data directory in are (using UNIX paths):
363 # * "config/nucleus" for data in the Nucleus config data directory
364 # * "world" for storing data in the primary world directory.
365 #
366 # 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".
367 data-file-location=default
368 # Enables debug mode, which will cause stack traces from commands to be printed to the console.
369 debug-mode=false
370 # If true, then the permissions "nucleus.owner", "nucleus.admin", "nucleus.mod" and "nucleus.user" can be used as permissionsto grant all suggested permissions for these levels. Note that:
371 #
372 # * /nucleus setupperms will exist, but will be unnecessary for those using this permission structure
373 # * Any specific permissions WILL override these permissions (so, setting `nucleus.home.base` to `false` should override `nucleus.user` being true for that specific permission.
374 #
375 # These permissions are designed to avoid the use of the wildcard. Some permissions are not given with these catch-alls, this is by design - the permission to vanish on login (for example) must ALWAYS be given separately.
376 enable-parent-perms=true
377 # If true, any command that takes a player nickname will attempt to partially match the usernames, which may cause a performance drop on larger servers.
378 enable-partial-name-matching=true
379 kick-on-stop {
380 # If true, Nucleus will kick all users just prior to the server stopping.
381 enabled=false
382 # The message to display to players when restarting the server. Overridden when using the /stop [reason] command.
383 message="Server closed"
384 }
385 # 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.
386 more-accurate-visitor-count=false
387 # Determines the maximum number of offline user entries that are returned for Nucleus commands that allow offline user targeting.
388 offline-user-tab-limit=20
389 # 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".
390 #
391 # Community translation support is being explored. Please visit us on Discord to ask how you can help translate Nucleus into your own language.
392 override-language=default
393 # If true, Nucleus will print a message when a permission is checked that has not been properly registered. This usually indicates a Nucleus issue and should be reported to the Nucleus github.
394 print-message-when-permission-isnt-registered=false
395 # Prints to console when a Nucleus save is occurring.
396 print-on-autosave=false
397 # 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.
398 safe-teleport-check {
399 height=3
400 width=9
401 }
402 # If true and no economy or permission plugin is detected, Nucleus will print a warning on startup. Set this to false if you don't have one of these types of plugins and you're OK with that.
403 show-warning-on-startup=true
404 # If true, a "messages.conf" file will be generated and used to define custom messages.
405 use-custom-message-file=false
406 # If true, cancel a user's warmup on...
407 warmup-canceling {
408 # running a command
409 cancel-on-command=true
410 # movement
411 cancel-on-move=true
412 }
413 # 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:
414 #
415 # "123e4567-e89b-12d3-a456-426655440000"="world"
416 #
417 # "123e4567-e89b-12d3-a456-426655440000"="1b671a64-40d5-491e-99b0-da01ff1f3341"
418 #
419 # Other plugins will be able to check this map to perform their own migrations, support for that is up to those plugins.
420 world-uuid-migration {}
421}
422# +------------------------------------------------------------+
423# | Death Messages |
424# +------------------------------------------------------------+
425death-message {
426 # If "false", death messages will be turned off when someone dies.
427 enable-death-messages=true
428 # If "true", Nucleus will try to make sure that everyone sees death messages.
429 force-show-all-death-messages=true
430}
431# +------------------------------------------------------------+
432# | Environment |
433# +------------------------------------------------------------+
434environment {
435 # The maximum amount of time that the weather can be set to last, in seconds. Set to -1 for no restriction.
436 maximum-weather-timespan=-1
437}
438# +------------------------------------------------------------+
439# | Fly |
440# +------------------------------------------------------------+
441fly {
442 # 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.
443 find-safe-location-on-login=true
444 # 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.
445 require-fly-permission-on-login=false
446 # 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.
447 save-all-flystate-on-quit=true
448}
449# +------------------------------------------------------------+
450# | Home |
451# +------------------------------------------------------------+
452home {
453 # If true, when a player is in a different dimension than the designated home, then this player will require the nucleus.home.exempt.samedimension permission to be able to use that home.
454 only-same-dimension=false
455 # 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.
456 prevent-home-count-overhang=true
457 # If true, on respawn, a player will spawn back at their default home (named "home") if it exists.
458 respawn-at-home=false
459 # 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).
460 use-safe-warp=true
461}
462# +------------------------------------------------------------+
463# | Info |
464# +------------------------------------------------------------+
465info {
466 info {
467 # If "use-default-info-section" is true, this section is displayed when a player runs "/info", not the section list.
468 default-info-section=info
469 # 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>.
470 # 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.
471 use-default-info-section=false
472 }
473 motd {
474 # The amount of time to wait (in seconds) before sending the MOTD to a player who has just logged in.
475 motd-login-delay=0.5
476 # The title to show at the top of each MOTD page. Colour codes are supported. If blank, this hides the title completely.
477 motd-title="&6MOTD"
478 # If true, show players the MOTD as defined in "motd.txt" when they log onto the server.
479 show-motd-on-join=true
480 # 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.
481 use-pagination=true
482 }
483}
484# +------------------------------------------------------------+
485# | Invulnerability |
486# +------------------------------------------------------------+
487invulnerability {
488 # If true, players that are invulnerable will not be able to attack other players or entities without the nucleus.god.pvp.override permission
489 disable-pvp-on-god=false
490 # 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.
491 require-god-permission-on-login=false
492}
493# +------------------------------------------------------------+
494# | Item |
495# +------------------------------------------------------------+
496item {
497 repair {
498 # The list of item types to prevent (or allow if whitelist is true) repairing using /repair
499 restrictions=null
500 # If true, the restriction list will be used as a whitelist vs a blacklist.
501 use-whitelist=false
502 }
503 skull {
504 # Limits the number of skulls that can be spawned using the "/skull" command. Set to -1 to disable the limit.
505 spawn-limit=-1
506 # If true, Nucleus will simply treat /skull as an alias to "/give [player] skull [number] 3 {SkullOwner:[skullplayer]}"
507 use-minecraft-command=false
508 }
509}
510# +------------------------------------------------------------+
511# | Jail |
512# +------------------------------------------------------------+
513jail {
514 # The commands that players are allowed to execute in jail. Do not include the slash.
515 allowed-commands=[
516 m,
517 msg,
518 r,
519 mail,
520 rules,
521 info
522 ]
523 # If true, jail time will only tick down when players are online.
524 jail-time-counts-online-only=false
525 # If true, the player will be muted when in jail.
526 mute-when-jailed=false
527 # If true, then the permission "nucleus.jail.unjail" is required to unjail players.
528 require-separate-unjail-permission=false
529}
530# +------------------------------------------------------------+
531# | Jump |
532# +------------------------------------------------------------+
533jump {
534 # The maximum distance a player can move using the /jump command. Negative values mean infinite - use with care.
535 max-jump-distance=350
536 # The maximum distance a player can move using the /thru command. Negative values mean infinite - use with care.
537 max-thru-distance=25
538 unstuck-distances {
539 # The maximum distance vertically /unstuck can send you.
540 height=1
541 # The maximum distance horizontally /unstuck can send you.
542 horizontal-radius=1
543 }
544}
545# +------------------------------------------------------------+
546# | Kit |
547# +------------------------------------------------------------+
548kit {
549 auto-redeem {
550 # If true, kit autoredeem will be enabled.
551 enable=false
552 # If true, the console will get messages indicating what was auto-redeemed when a player logs in.
553 log=false
554 }
555 # If true, any items that couldn't be placed in the player's inventory will be dropped on the floor around them.
556 drop-items-if-inventory-full=false
557 # If this is true, "drop-items-if-inventory-full" will be ignored, and the kit will only be consumed if everything can be consumed.
558 must-get-all-items=false
559 # If true, any tokens such as {{name}} and {{displayname}} will be translated on item names and lore, if they exist, when kits are redeemed.
560 process-tokens-in-lore=false
561}
562# +------------------------------------------------------------+
563# | Message |
564# +------------------------------------------------------------+
565message {
566 # The prefix to any message received via /helpop.
567 helpop-prefix="&7HelpOp: {{name}} &7> &r"
568 # 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.
569 msg-receiver-prefix="&7[{{fromDisplay}}&7 -> me]: &r"
570 # 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.
571 msg-sender-prefix="&7[me -> {{toDisplay}}&7]: &r"
572 socialspy {
573 # If true, Nucleus will check the "nucleus.socialspy.force" permission on the subject to disallow disabling Social Spy.
574 allow-forced=false
575 # The tag to show at the beginning of a Social Spy message when a player is muted (or otherwise has the message cancelled).
576 cancelled-messages-tag="&c[cancelled] "
577 # Sets the social spy level of the server and any custom message targets.
578 levels {
579 # The social spy level of any custom target that has been registered through the API.
580 custom-targets=2147483647
581 # The server's social spy level.
582 server=2147483647
583 }
584 # '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.'
585 msg-prefix="&7[SocialSpy] [{{fromDisplay}}&7 -> {{toDisplay}}&7]: &r"
586 # 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).
587 msgtoggle-blocked-messages-tag="&c[blocked] "
588 # If true, and "use-levels" is true, players with social spy will also see messages from players at their own level.
589 same-levels-can-see-each-other=true
590 # Controls the types of *sender* that can be spied on.
591 senders-to-spy-on {
592 custom-target=true
593 player=true
594 server=true
595 }
596 # If true, show messages that players try to send and are cancelled (usually due to being muted).
597 show-cancelled-messages=false
598 # 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,
599 # 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.
600 use-levels=false
601 }
602}
603# +------------------------------------------------------------+
604# | Miscellaneous |
605# +------------------------------------------------------------+
606misc {
607 # Sets the maximum speed that a player can set via the /speed command.
608 max-speed=5
609}
610# +------------------------------------------------------------+
611# | Mob |
612# +------------------------------------------------------------+
613mob {
614 # The maximum number of mobs that can be spawned using /spawnmob.
615 max-mobs-to-spawn=20
616 # If true, Nucleus will make an additional permission check to check whether a player can spawn a mob.
617 # 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
618 # "nucleus.spawnmob.mobs.minecraft.creeper". This allows server owners to allow all vanilla mobs with the permission "nucleus.spawnmob.mobs.minecraft".
619 separate-mob-spawning-permissions=false
620 # 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.
621 spawning-blocks {
622 DIM-1 {
623 # The full IDs of the mobs to block. Minecraft mobs have an id starting with "minecraft:"
624 block-mobs-with-ids=null
625 # If true, all vanilla mobs will be blocked in this world.
626 block-vanilla-mobs=false
627 }
628 DIM1 {
629 # The full IDs of the mobs to block. Minecraft mobs have an id starting with "minecraft:"
630 block-mobs-with-ids=null
631 # If true, all vanilla mobs will be blocked in this world.
632 block-vanilla-mobs=false
633 }
634 world {
635 # The full IDs of the mobs to block. Minecraft mobs have an id starting with "minecraft:"
636 block-mobs-with-ids=null
637 # If true, all vanilla mobs will be blocked in this world.
638 block-vanilla-mobs=false
639 }
640 }
641}
642# +------------------------------------------------------------+
643# | Mute |
644# +------------------------------------------------------------+
645mute {
646 # Commands to block when muted. This is in addition to chat and /m already being blocked.
647 blocked-commands=[
648 "minecraft:me",
649 say
650 ]
651 # 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.
652 maximum-mute-length=604800
653 # If true, mute time will only tick down when players are online.
654 mute-time-counts-online-only=false
655 # The tag to prepend any cancelled/muted messages with.
656 muted-chat-tag="&c[cancelled] "
657 # If true, then the permission "nucleus.mute.unmute" is required to unmute players.
658 require-separate-unmute-permission=false
659 # If true, those with the "nucleus.mute.seemutedchat" permission will see chat from those who are muted.
660 see-muted-chat=false
661}
662# +------------------------------------------------------------+
663# | Name Banning |
664# +------------------------------------------------------------+
665nameban {
666 default-reason="Your Minecraft username is not appropriate for this server. Please change it before attempting to access this server."
667}
668# +------------------------------------------------------------+
669# | Nickname |
670# +------------------------------------------------------------+
671nickname {
672 # The maximum number of visible characters that the nickname can be.
673 max-nickname-length=20
674 # The minimum number of visible characters that the nickname can be.
675 min-nickname-length=3
676 # 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 ".+".
677 pattern="[a-zA-Z0-9_]+"
678 # A prefix to any nickname that is displayed in chat.
679 prefix="&b~"
680}
681# +------------------------------------------------------------+
682# | Note |
683# +------------------------------------------------------------+
684note {
685 # If true, users with the permission nucleus.note.showonlogin will be shown a users notes when they login. If false, they will not.
686 show-login=true
687}
688# +------------------------------------------------------------+
689# | Player Info |
690# +------------------------------------------------------------+
691playerinfo {
692 list {
693 # If true, /list will be displayed in a compact form.
694 compact-list=true
695 # If compact /list is enabled, this specifies how many players will be sent in one line. If clients are disconnecting when running list, lower the number.
696 compact-max-players=20
697 list-grouping-by-permission {
698 # If listing by groups is enabled, the group name to display when a player is not in a group.
699 default-group-name=Default
700 # If enabled, list players by their groups.
701 enabled=false
702 # 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.
703 # Multiple groups can be given the same alias, they will be grouped together.
704 group-aliases {
705 example-default-group="Default Group"
706 example-default-group-2="Default Group"
707 }
708 # Any group aliases in this list will be listed in this order, above all other groups, which will be displayed in alphabetical order below.
709 group-order=null
710 # 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.
711 use-aliases-only=false
712 }
713 # 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.
714 server-panel-compatibility=false
715 # The template to use to display a player's name. Uses the same tokens as chat. Defaults to "{{displayname}}".
716 template="{{displayname}}"
717 }
718 near {
719 # The max radius for the /near command, bypassable with nucleus.near.maxexempt
720 max-radius=200
721 }
722 seen {
723 # 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).
724 require-extended-permission-for-module-info=false
725 }
726}
727# +------------------------------------------------------------+
728# | Protection |
729# +------------------------------------------------------------+
730protection {
731 # Disables crop trampling.
732 disable-crop-trample {
733 mobs=false
734 players=false
735 }
736 mob-griefing {
737 # If true, mob griefing will be disabled except for the entities listed in the whitelist (which should be done by mob ID).
738 enable-protection=false
739 }
740}
741# +------------------------------------------------------------+
742# | rtp |
743# +------------------------------------------------------------+
744rtp {
745 # 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.
746 attempts=10
747 # The default RTP kernel to use with /rtp. The default options are:
748 #
749 # * "nucleus:default": standard RTP, with the min/max radius centred around the spawn point
750 # * "nucleus:surface_only": RTP which will attempt to only pick a surface (must see sky) location, with the min/max radius centred around the spawn point
751 # * "nucleus:around_player": RTP which is like default, but the random position will depend on the player's current position, not the spawn point
752 # * "nucleus:around_player_surface": RTP which is like surface only, but the random position will depend on the player's current position, not the spawn point
753 #
754 # Other plugins might add their own kernels, in which case they will give you an ID to use here.
755 default-method="nucleus:default"
756 # 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.
757 default-world=""
758 # The maximum Y value that can be teleported to.
759 maximum-y=255
760 # The minimum radius from the centre of the world/world border where /rtp will warp to.
761 min-radius=0
762 # The minimum Y value that can be teleported to.
763 minimum-y=0
764 # 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.
765 per-world-permissions=false
766 # A list of biomes that RTP should not attempt to teleport into.
767 prohibited-biomes=[
768 "minecraft:frozen_ocean",
769 "minecraft:ocean",
770 "minecraft:deep_ocean"
771 ]
772 # The maximum radius from the centre of the world/world border where /rtp can warp to. This will not override the world border radius.
773 radius=30000
774 # 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".
775 #
776 # Copy the example block and paste it below, with the correct world name, to set the per-world options.
777 world-overrides {
778 example {
779 # The default RTP kernel to use with /rtp. The default options are:
780 #
781 # * "nucleus:default": standard RTP, with the min/max radius centred around the spawn point
782 # * "nucleus:surface_only": RTP which will attempt to only pick a surface (must see sky) location, with the min/max radius centred around the spawn point
783 # * "nucleus:around_player": RTP which is like default, but the random position will depend on the player's current position, not the spawn point
784 # * "nucleus:around_player_surface": RTP which is like surface only, but the random position will depend on the player's current position, not the spawn point
785 #
786 # Other plugins might add their own kernels, in which case they will give you an ID to use here.
787 default-method="nucleus:default"
788 maximum-y=255
789 min-radius=0
790 minimum-y=0
791 radius=30000
792 }
793 }
794}
795# +------------------------------------------------------------+
796# | Rules |
797# +------------------------------------------------------------+
798rules {
799 # The rules page title.
800 rules-title="&6Server Rules"
801}
802# +------------------------------------------------------------+
803# | Server List |
804# +------------------------------------------------------------+
805server-list {
806 # If true, the player count will not be displayed.
807 hide-player-count=false
808 # If true, any player that is vanished on the server will not appear in the online player list on the server list.
809 hide-vanished-players=false
810 # 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.
811 modify-server-list-messages=FALSE
812 # 'Potential messages that could be sent to the player. To split over two lines, include \n where you want the line break to appear.'
813 server-list-messages=[
814 "&bWelcome to the server!\n&cCome join us!"
815 ]
816 # '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.
817 #
818 # If no entries are here, the MOTD will use the `server-list-messages` list.'
819 whitelist-server-list-messages=null
820}
821# +------------------------------------------------------------+
822# | Server Shop |
823# +------------------------------------------------------------+
824server-shop {
825 # The maximum amount a player can buy in one transaction.
826 max-purchasable-at-once=64
827}
828# +------------------------------------------------------------+
829# | Spawn |
830# +------------------------------------------------------------+
831spawn {
832 # If true, if a respawn would be back to a bed, Nucleus will override that, if false, Nucleus will ignore bed spawns.
833 affect-bed-spawn=true
834 # 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.
835 # Only set this if you want Nucleus to override all other plugins on first spawn.
836 force-first-spawn=false
837 # This section controls whether respawning and /spawn work on a per world or global server basis
838 global-spawn {
839 # 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.
840 on-login=false
841 # 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.
842 on-respawn=false
843 # If true, running /spawn sends the player to the world specified in "target-spawn-world", if false, sends them to the world spawn.
844 on-spawn-command=false
845 # The name of the world to use as the server spawn. If this is invalid, the default world is used instead.
846 target-spawn-world=world
847 }
848 # If true, Nucleus will intercept respawn logic to ensure a player is warped back to the spawn point when respawning. This may conflict with some mods that do their own processing, if so, set this to false.
849 handle-on-respawn=true
850 # 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.
851 per-world-permissions=false
852 # 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.login" permission.
853 spawn-on-login=false
854 # If "spawn-on-login" is true, if a player logs in and is on any of the worlds listed here, they will NOT be redirected to the spawn point.
855 #
856 # This supports both world names and world UUIDs.
857 spawn-on-login-exempt-worlds=null
858 # 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.
859 use-safe-spawn=true
860}
861# +------------------------------------------------------------+
862# | Staff Chat |
863# +------------------------------------------------------------+
864staff-chat {
865 # If true, Nucleus will include all the normal chat tags in the message, in addition to the prefix.
866 "include-standard-chat-formatting"=false
867 # A Minecraft colour code the denotes the colour to display Staff Chat channel messages in.
868 message-colour=b
869 # '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.'
870 # If "include-standard-chat-formatting" is set to "true", the formatting will be appended to this prefix.
871 message-template="&b[STAFF] &r{{displayname}}&b: "
872}
873# +------------------------------------------------------------+
874# | Teleport |
875# +------------------------------------------------------------+
876teleport {
877 # If true, by default, a target player will not be informed that they have been /teleport ed to. Override using "-q false"
878 default-quiet=true
879 # If true, when a player is in a different dimension than the designated target, then the requesting player will require the
880 # "nucleus.teleport.exempt.samedimension" permission to allow teleportation.
881 only-same-dimension=false
882 # If true, any player that has a /tpa request denied (or times out) will have any charge for the command refunded.
883 # If set to false, Nucleus will consider that the command has a cost, rather than the teleport action and will not refund on any teleport denials.
884 refund-on-deny=true
885 # If true, Nucleus will show Accept and Deny links when a tpa or tpahere request is made.
886 show-clickable-tpa-accept-deny=true
887 # If true, when running /tpa, a player's cooldown starts immediately. Otherwise, the cooldown will start
888 # if and when the teleport is accepted.
889 start-cooldown-when-asking=false
890 # If true, this will force Nucleus to use the /tpaccept and /tpdeny commands explicitly if someone clicks "Accept" or "Deny" to a tpa/tpahere request. This provides compatibility to some plugins that try to block commands by name rather than by action, but will not work if the commands have been aliased or turned off.
891 #
892 # It is recommended that you set this to false wherever possible.
893 use-commands-when-clicking-tpa-accept-deny=false
894 # If true, if a requester makes a /tpa or /tpahere request to a player, the player who is teleporting will teleport to the position the request was made at, rather than the requester's current position. If false, the player will teleport to the requester's current position, regardless of where the request was made.
895 use-request-location-on-tp-requests=false
896 # If true, teleporting tries to find a safe place for players.
897 use-safe-teleportation=true
898}
899# +------------------------------------------------------------+
900# | Vanish |
901# +------------------------------------------------------------+
902vanish {
903 # [EXPERIMENTAL - use with caution] If true, Nucleus will try to alter the tab list when a player vanishes.
904 alter-tab-list=false
905 # If true, Nucleus is more aggressive about setting the vanish state on a player during login. This may interfere with other plugins that use the vanish status.
906 force-nucleus-vanish=true
907 # If true, players who leave or join the server under vanish will not have a login or logout message broadcast.
908 hide-connection-messages-on-vanish=false
909 # If true, if a player is vanished and another player who does not have see permissions runs /seen, the player will appear tobe offline.
910 try-hide-players-in-seen=true
911 # If true, attempts to work around a Sponge issue where vanish status does not persist over respawns.
912 # See https://github.com/SpongePowered/SpongeCommon/issues/2325.
913 workaround-sponge-vanish-issue=true
914}
915# +------------------------------------------------------------+
916# | Warn |
917# +------------------------------------------------------------+
918warn {
919 # The command to execute when a player has a specific number of warnings.
920 action-command="tempban {{name}} 1d Exceeding the active warning threshold"
921 # The default length a warning is set to if no length is provided (in seconds). Set to -1 for no maximum.
922 default-length=-1
923 # If true, a record of players warnings will be kept as 'expired warnings'. If false, they will not.
924 expire-warnings=true
925 # The maximum length a warning may last for (in seconds). Set to -1 for no maximum.
926 maximum-warn-length=-1
927 # The minimum length a warning will last before expiring (in seconds). Set to -1 for no minimum.
928 minimum-warn-length=-1
929 # If true, players will be shown all their warnings when they login. If false, they will not.
930 show-login=true
931 # The number of active warnings a player must accumulate before the action command is executed. Set to -1 to disable.
932 warnings-before-action=-1
933}
934# +------------------------------------------------------------+
935# | Warp |
936# +------------------------------------------------------------+
937warp {
938 default-category-name=Uncategorised
939 # The default cost for a warp. Can be overriden using /warp setcost <warp> <cost>
940 default-warp-cost=0
941 # If true, warps will be displayed by category in /warp list.
942 list-warps-by-category=false
943 # If this is set to true, each warp has its own permission node - nucleus.warps.<name>.
944 #
945 # NOTE: This option will be removed inNucleus v2 and will act as if it's "true". Use the permission node "nucleus.warps" to emulate this being "false".
946 separate-permissions=true
947 # If true, the warp description will be shown in /warp list, and the co-ords will be shown in the tooltip on hover.
948 show-warp-description-in-list=false
949 # 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.
950 use-safe-warp=true
951}
952# +------------------------------------------------------------+
953# | World |
954# +------------------------------------------------------------+
955world {
956 # 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.
957 default-world-border-diameter=0
958 # If true, joining or changing worlds will change the gamemode of a player unless they have the Minecraft permission "nucleus.world.force-gamemode.override"
959 enforce-gamemode-on-world-change=false
960 pre-generation {
961 # 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.
962 display-after-each-gen=false
963 # If true world generation will warn players on the server that a pre-generation is in progress periodically.
964 display-generation-warning=true
965 # Time, in seconds, between notifications in chat warning players a pre-gen is in progress.
966 notification-interval=20
967 }
968 # If true, changing worlds requires permission to access the target world - "nucleus.worlds.<worldname>"
969 separate-permissions=false
970}