Nucleus Documentation
Welcome to the Nucleus Documentation.
This documentation is designed for users of the plugin. If you are a plugin developer wishing to integrate with Nucleus, or contribute to Nucleus in general, click here.
Can't find what you're looking for? Click here or press "s" on your keyboard to search the documentation.
General Information
Compatibility Issues
Mods and Plugins that do not work well with Nucleus
Frequently Asked Questions
Simple answers to frequently asked questions
Translating Nucleus
Translate Nucleus into your own language
Tutorials
Step by step tutorials
Installing and Configuring
Learn how to install Nucleus and tailor it to your needs
Command Management
Learn how to set cooldowns, warmups and costs on your commands
Creating and Managing Kits
Learn how to create and manage kits
Creating and Managing Warps
Learn how to create and manage warps
How To
Quick articles that resolve specific, common tasks
Migrating from Nucleus v1
Things you need to do when upgrading from v1 to v2.
Using /nucleus setupperms
One way to set up Nucleus' recommended permissions automatically
Using role permissions
Another way to set up Nucleus' recommended permissions automatically
Module Management
Enabling and disabling modules
Customising Player Chat
Customise chat formatting on a per player, group and server-wide basis
First Join Kits and Spawns
Supporting new players with a first spawn location and an initial inventory
World Pre-Generation
Pre-generating chunks on the world to improve server performance
General Reference
Lists of commands, permissions and placeholder tokens
Commands
Nucleus Commands
Permissions
Nucleus Permissions
Links & Placeholders
Links and Placeholders in Nucleus
Essentials Command Equivalence
Migrating from Essentials to Nucleus
Module References
Core
Core Nucleus functions
Admin
Administrative commands
AFK
Idle player management
Back
Returning to last waypoint
Ban
Banning players
Chat
Server chat management
Chat Logging
Logging server chat to a separate file
Connection
Reserved slots and configurable whitelist messages
Connection Messages
Login and logout messages
Death Messages
Controls whether death messages are sent
Environment
Manages world environment, including weather and time
Experience
Enables manipulation of experience
Fly
Allow survival players to fly
Home
Personal warps
Ignore
Ignore players in chat
Info
In game MOTDs and server info pages
Inventory
Looking at and manipulating other's inventories
Item
Item manipulation
Jail
Jailing players
Jump
Short range teleportation
Kick
Kicking players from the server
Kit
Sets of items and commands players can redeem
Sending messages to personal inboxes
Message
Private messaging
Miscellaneous
A collection of misc. goodies!
Mob
Mob spawning control
Mute
Player chat suppression
Name Ban
Banning names, rather than accounts
Nickname
Player nicknames
Note
Attaching administrative notes to players
Notifications
Broadcasts, titles and action bar messages
Player Info
Information about players, including listing all players
Powertool
Personal binding of commands to items
Protection
Basic protection of crop tramping and mob griefing
RTP
Random location teleportation
Rules
Displaying rules
Server List
Control over the server listing on the Join a Server window
Sign
Coloured text on signs
Spawn
Customise server spawn
Staff Chat
Chat Channel for staff
Teleport
Player teleportation
Vanish
Player vanishing
Warp
Server defined waypoints
World
World and border management