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