Welcome to the new docs site for Nucleus v2! Still on Nucleus v1? Visit the old site here.

Core Module

Introduction

The Core module contains functions that cannot be disabled. This module provides no game changing functionality on its own.

Plugin Management

The module is primarily concerned with ensuring that the internal functions of the plugin can be accessed. Included in the command set are ways to force saving the latest data, reloading the plugin configuration, and deleting user information.

Note that changing module and command enabling statuses will not take effect until the server is restarted.

Setting up default permissions

See the Installation and Configuration tutorial step here

The following are incompatibilities that may occur with this module, along with how to resolve the problem. For the full mod/plugin incompatibility list, see the compatibility page.

No plugin incompatibilities have been reported.

/commandinfo
Module: core
Returns information about a command

Aliases: /commandinfo

Usage: /commandinfo <command>

Default Role: admin

Basic Command Permission: nucleus.commandinfo.base

Permissions

  • nucleus.commandinfo.base - Default Role: admin
    Allows the user to run the command /commandinfo
/nucleus
Module: core
Displays Nucleus version and module information.

The Nucleus command allows access to sub commands that administer the entire plugin.

Aliases: /nucleus

Usage: /nucleus

Default Role: admin

Basic Command Permission: nucleus.nucleus.base

Permissions

  • nucleus.nucleus.base - Default Role: admin
    Allows the user to run the command /nucleus
/nucleus compatibility
Module: core
Lists any compatibility issues that have been detected.

Aliases: /nucleus compatibility, /nucleus compat

Usage: /nucleus compatibility

Default Role: admin

Basic Command Permission: nucleus.nucleus.compatibility.base

Permissions

  • nucleus.nucleus.compatibility.base - Default Role: admin
    Allows the user to run the command /nucleus compatibility
/nucleus debug
Module: core
Utilities to support debugging server issues.

Aliases: /nucleus debug

Usage: /nucleus debug

Default Role: admin

Basic Command Permission: nucleus.nucleus.debug.base

Permissions

  • nucleus.nucleus.debug.base - Default Role: admin
    Allows the user to run the command /nucleus debug
Gets all UUIDs that appear to be registered to a username.

Aliases: /nucleus debug getuuids

Usage: /nucleus debug getuuids <user>

Default Role: admin

Basic Command Permission: nucleus.nucleus.debug.getuuids.base

Permissions

  • nucleus.nucleus.debug.getuuids.base - Default Role: admin
    Allows the user to run the command /debug getuuids
Refreshes the {{uniquecount}} token, in case it's out of sync.

Aliases: /nucleus debug refreshuniquevisitors

Usage: /nucleus debug refreshuniquevisitors

Default Role: admin

Basic Command Permission: nucleus.nucleus.debug.refreshuniquevisitors.base

Permissions

  • nucleus.nucleus.debug.refreshuniquevisitors.base - Default Role: admin
    Allows the user to run the command /debug refreshuniquevisitors
Verifies that all command keys are set correctly

Aliases: /nucleus debug verifycmds

Usage: /nucleus debug verifycmds

Default Role: admin

Basic Command Permission: nucleus.nucleus.debug.verifycmds.base

Permissions

  • nucleus.nucleus.debug.verifycmds - Default Role: admin
    Allows the user to run the command /nucleus debug verify-cmds
/nucleus docgen
Module: core
Generates Nucleus documentation data files

Aliases: /nucleus docgen

Usage: /nucleus docgen

Default Role:

Basic Command Permission: nucleus.nucleus.docgen.base

Permissions

  • nucleus.nucleus.docgen.base - Default Role:
    Allows the user to run the command /docgen
/nucleus getuser
Module: core
Gets or refreshes a user's entry in the username cache.

Occasionally, the Minecraft username cache gets out of sync with the rest of the system, and some commands that require a user fail. This command allows you to request updated information about a user from Mojang's server (via either a UUID or a current user name) and adds them to the cache.

Aliases: /nucleus getuser

Usage: /nucleus getuser <UUID>|<name>

Default Role:

Basic Command Permission: nucleus.nucleus.getuser.base

Permissions

  • nucleus.nucleus.getuser.base - Default Role:
    Allows the user to run the command /nucleus getuser
/nucleus info
Module: core
Creates a file in the server root directory containing information about the server and Nucleus environment.

Aliases: /nucleus info

Usage: /nucleus info

Default Role: admin

Basic Command Permission: nucleus.nucleus.info.base

Permissions

  • nucleus.nucleus.info.base - Default Role: admin
    Allows the user to run the command /nucleus info
/nucleus nucleus
Module: core
Clears the in-memory cache of users who have logged on in the past session, forcing Nucleus to read the data files on their next login.

Aliases: /nucleus nucleus

Usage: /nucleus nucleus

Default Role: admin

Basic Command Permission: nucleus.nucleus.clearcache.base

Permissions

  • nucleus.nucleus.clearcache.base - Default Role: admin
    Allows the user to run the command /nucleus clearcache
/nucleus printperms
Module: core
Prints all permissions registered in Nucleus.

Aliases: /nucleus printperms

Usage: /nucleus printperms

Default Role: admin

Basic Command Permission: nucleus.nucleus.printperms.base

Permissions

  • nucleus.nucleus.printperms.base - Default Role: admin
    Allows the user to run the command /nucleus printperms
Rebuild the Nucleus user cache.

Some operations that we might want to do might want to look at offline and online players, but unfortunately, as we store things as separate user files, it would take a lot of processing to get some simple data. The cache copies this all into one place. However, there is a chance it'll go stale, this command asks Nucleus to rebuild the cache.

Aliases: /nucleus rebuildusercache

Usage: /nucleus rebuildusercache

Default Role: admin

Basic Command Permission: nucleus.nucleus.rebuildusercache.base

Permissions

  • nucleus.nucleus.rebuildusercache.base - Default Role: admin
    Allows the user to run the command /nucleus rebuildusercache
/nucleus reload
Module: core
Reloads Nucleus' configuration files.

This command will reload everything EXCEPT whether modules and/or commands are enabled.
A restart of the entire server is required for these two actions to take effect.

Aliases: /nucleus reload

Usage: /nucleus reload

Default Role: admin

Basic Command Permission: nucleus.nucleus.reload.base

Permissions

  • nucleus.nucleus.reload.base - Default Role: admin
    Allows the user to run the command /nucleus reload
/nucleus resetuser
Module: core
Deletes all data in Nucleus, and optionally, Minecraft, for a player.

This can be useful to clear out everything Nucleus knows about a player. However, if you want to delete Minecraft data, pass the "-a" flag.

This will not delete data stored by other plugins about this player.

Aliases: /nucleus resetuser

Usage: /nucleus resetuser [-a|--all <a>] <user>|<UUID>

Default Role: admin

Basic Command Permission: nucleus.nucleus.resetuser.base

Permissions

  • nucleus.nucleus.resetuser.base - Default Role: admin
    Allows the user to run the command /nucleus resetuser
/nucleus save
Module: core
Saves all files.

Aliases: /nucleus save

Usage: /nucleus save

Default Role: admin

Basic Command Permission: nucleus.nucleus.save.base

Permissions

  • nucleus.nucleus.save.base - Default Role: admin
    Allows the user to run the command /nucleus save
/nucleus setupperms
Module: core
Allows the user to add the recommended permissions for either USER, MOD or ADMIN roles to a specified group.

There are three flags for this command:

* -r: if set, all Nucleus permissions will be set regardless of whether they have been set before. Else, only those that the permissions plugindoes not report have been set are set will be set to true.
* -i: Apply the perms from the selected role and lower to this group (so, if ADMIN is selected, MOD and USER perms will be applied to the group too).
* -g: Create "admin" and "mod" groups, setup inheritance, and apply default permissions (should only be used for new servers).
* "-g -y": Bypasses the info given by `-g` on its own.

The permissions that are applied will be added to the console.

Aliases: /nucleus setupperms, /nucleus setperms

Usage: /nucleus setupperms -g [-y]|[-r|--reset <r>] [-i|--inherit <i>] <Nucleus Role> <Permission Group>

Default Role: admin

Basic Command Permission: nucleus.nucleus.setupperms.base

Permissions

  • nucleus.nucleus.setupperms.base - Default Role: admin
    Allows the user to run the command /nucleus setupperms
/nuserprefs
Module: core
Gets and sets Nucleus user preferences.

User Preferences allow players to customise a subset of Nucleus functions themselves, such as vanish on login, should they havepermission to do so. Users can:

* list preferences that are relevant to them by running the command with no arguments;
* get a specific preference by running the command with the name of a preference key;
* set a specific preference by running the command with the name of the preference key and the new value.

Other user's preferences can be inspected by those with the "others" permission for this command.

Aliases: /nuserprefs, /userprefs

Usage: /nuserprefs [<user>] [<preference> [value]]

Default Role: user

Basic Command Permission: nucleus.userprefs.base

Permissions

  • nucleus.userprefs.base - Default Role: user
    Allows the user to run the command /nuserprefs
  • nucleus.userprefs.others - Default Role: admin
    Allows the user to target other players using the command "nuserprefs".
/setnucleuslanguage
Module: core
Sets the Nucleus language for self or a given player.

The language is only set on a per player basis. The language should be set in the form "xx_XX", for example "en_GB" or"zh_CN".

Aliases: /setnucleuslanguage, /setnuclang

Usage: /setnucleuslanguage [<user>] <locale>

Default Role: user

Basic Command Permission: nucleus.userprefs.base

Permissions

  • nucleus.setnucleuslanguage.others - Default Role: admin
    Allows the user to target other players using the command "setnucleuslanguage".
  • nucleus.userprefs.base - Default Role: user
    Allows the user to run the command /nuserprefs
/update-messages
Module: core
Scans the messages file for keys that might not include all the required tokens and replaces them with the standard translation.

Aliases: /update-messages

Usage: /update-messages [-y <y>]

Default Role: admin

Basic Command Permission: nucleus.nucleus.update-messages.base

Permissions

  • nucleus.nucleus.update-messages.base - Default Role: admin
    Allows the user to run the command /nucleus update-messages
Permission Suggested Role Description
nucleus.commandinfo.base admin Allows the user to run the command /commandinfo
nucleus.nucleus.base admin Allows the user to run the command /nucleus
nucleus.nucleus.clearcache.base admin Allows the user to run the command /nucleus clearcache
nucleus.nucleus.compatibility.base admin Allows the user to run the command /nucleus compatibility
nucleus.nucleus.debug.base admin Allows the user to run the command /nucleus debug
nucleus.nucleus.debug.getuuids.base admin Allows the user to run the command /debug getuuids
nucleus.nucleus.debug.refreshuniquevisitors.base admin Allows the user to run the command /debug refreshuniquevisitors
nucleus.nucleus.debug.verifycmds admin Allows the user to run the command /nucleus debug verify-cmds
nucleus.nucleus.docgen.base Allows the user to run the command /docgen
nucleus.nucleus.getuser.base Allows the user to run the command /nucleus getuser
nucleus.nucleus.info.base admin Allows the user to run the command /nucleus info
nucleus.nucleus.printperms.base admin Allows the user to run the command /nucleus printperms
nucleus.nucleus.rebuildusercache.base admin Allows the user to run the command /nucleus rebuildusercache
nucleus.nucleus.reload.base admin Allows the user to run the command /nucleus reload
nucleus.nucleus.resetuser.base admin Allows the user to run the command /nucleus resetuser
nucleus.nucleus.save.base admin Allows the user to run the command /nucleus save
nucleus.nucleus.setupperms.base admin Allows the user to run the command /nucleus setupperms
nucleus.nucleus.update-messages.base admin Allows the user to run the command /nucleus update-messages
nucleus.nucleuslanguage.base user Allows the user to run the command /nucleuslanguage
nucleus.setnucleuslanguage.base user Allows the user to run the command /setnucleuslanguage
nucleus.setnucleuslanguage.others admin Allows the user to target other players using the command "setnucleuslanguage".
nucleus.userprefs.base user Allows the user to run the command /nuserprefs
nucleus.userprefs.others admin Allows the user to target other players using the command "nuserprefs".
The following configuration is the default for this module:
                            # 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.
check-for-wildcard=true
# 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.
command-on-name-click="/msg {{subject}}"
# If true, commands executed by the console can affect players that normally have an exempt permission against the command.
console-overrides-exemptions=true
# Specifies the path to save nucleus data files in. By default, files are saved at the root. Paths can be relative or absolute.
# 
# BE AWARE. Changing this location has the following caveats:
# * This will only take effect after a restart.
# * Files are NOT moved from the old location, you must do this yourself.
# * Files will be in a "nucleus" subdirectory of your selected location.
# * If the path indicated cannot be found, this will be ignored. It **must** exist beforehand.
# * Minecraft data (as opposed to Nucleus data) is unaffected.
# 
# Common areas that you might want to put the data directory in are (using UNIX paths):
# * "config/nucleus" for data in the Nucleus config data directory
# * "world" for storing data in the primary world directory.
# 
# 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".
data-file-location=default
# Enables debug mode, which will cause stack traces from commands to be printed to the console.
debug-mode=false
# 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:
# 
# * /nucleus setupperms will exist, but will be unnecessary for those using this permission structure
# * Any specific permissions WILL override these permissions (so, setting `nucleus.home.base` to `false` should override `nucleus.user` being true for that specific permission.
# 
# 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.
enable-parent-perms=true
# 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.
enable-partial-name-matching=true
# If true, then the default user group (or non-ops if no permission plugin is installed) will act as if they have the default user permissions. Changing this requires a restart of your server.
give-default-group-user-permissions=false
kick-on-stop {
    # If true, Nucleus will kick all users just prior to the server stopping.
    enabled=false
    # The message to display to players when restarting the server. Overridden when using the /stop [reason] command.
    message=null
}
# 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.
more-accurate-visitor-count=false
# Determines the maximum number of offline user entries that are returned for Nucleus commands that allow offline user targeting.
offline-user-tab-limit=20
# 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".
# 
# Community translation support is being explored. Please visit us on Discord to ask how you can help translate Nucleus into your own language.
override-language=default
# Prints to console when a Nucleus save is occurring.
print-on-autosave=false
# 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.
safe-teleport-check {
    height=3
    width=9
}
# 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.
show-warning-on-startup=true
# If true, Nucleus will try to use the client locale when sending messages wherever possible and the translations exists.
use-client-locale-where-possible=false
# If true, a "messages.conf" file will be generated and used to define custom messages.
use-custom-message-file=false
# If true, cancel a user's warmup on...
warmup-canceling {
    # running a command
    cancel-on-command=true
    # movement
    cancel-on-move=true
}
# 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:
# 
# "123e4567-e89b-12d3-a456-426655440000"="world"
# 
# "123e4567-e89b-12d3-a456-426655440000"="1b671a64-40d5-491e-99b0-da01ff1f3341"
# 
# Other plugins will be able to check this map to perform their own migrations, support for that is up to those plugins.
world-uuid-migration {}

                        
Search

Downloading search database, this won't take long...