This page lists some of the more frequently asked questions about the Nucleus Project, specifically the Essentials like plugin that we publish for Sponge servers.
/help command!/back telling me there is nowhere to warp to?/rtp or some other teleport to a place no player has gone before!Nucleus is, quite simply, the Ultimate Essentials Plugin for Sponge! Nucleus was born to bring a modern, modular and feature-rich Essentials style plugin that makes Sponge a viable choice for all server owners to cover the basics, whether they be vanilla servers or modded servers. It lets you get on with making your server unique with a solid base you can trust!
If you want more information on Sponge, see their website and documentation.
You sure can get that help! Come visit us on Discord - click here and you’ll be with us in no time! But please, take the time to read the rest of this FAQ too.
No, not at this time.
Not yet, but it is being worked on - v2 will contain the backbone for this.
Unfortunately so. See our compatibility page for more details - we will update this list as we find more.
No. You will need a separate permissions plugin if you wish to use permissions to manage your server.
Yeah, 1000 permission nodes can be daunting, and there is nothing stopping you, but we honestly recommend you do not. If you do so, the following things will happen:
nucleus.afk.exempt.toggle)nucleus.connectionmessages.disable)nucleus.vanish.onlogin)nucleus.inventory.keepondeath)Other plugins may also not function as intended, a good example is GriefPrevention. So, please, don’t use the wildcard.
For more information on why this is bad, read this article on why you shouldn’t use it, including background information on what Bukkit did
Instead, Nucleus offers a way to setup our suggested permission sets, that should get you off the ground. You can read more about it at this documentation page, but the gist of it is that you should setup your user, mod and admin groups, then run the following command on each:
/nucleus setupperms [USER|MOD|ADMIN] <groupname>
You can then tweak your permissions as you see fit. The permissions that get loaded with the NONE set are highly specialised, we do not
recommend you actually grant these unless you are SURE you know what you are doing.
USER gives permissions to:
/afk, allowing themselves to be marked as AFK/me, to be able to write “action chat” (such as dualspiral wrote these docs)/time)/helpop to message staff/suicide/realname to find out what a player’s IGN is from a nickname/list/rules/itembuy and /itemsell)/spawn and /firstspawn/tpa, accept and deny requests, and use /tptoggle to blanket deny requests./warp to teleport to any available warp point (but if enabled, only to those they are given explicit permissions for)./getpos to get their own positionMOD gives permission to:
/tpahere to request someone to teleport to them.ADMIN gives permission to:
As the ADMIN set spans about 900 permission nodes, please forgive me for not listing it all here!
If you are using FTB, FTB Utilities also tries to format the chat, with the result that player names appear twice. If you wish to use Nucleus’ chat formatting,
you should turn off FTB Utilities handling. The ranks config file is in the local directory, set the following options to false:
B:override_chat=falseB:override_commands=falseThen reload the FTB Utilities plugin or restart your server.
Yes! Nucleus has a system which wraps up the functions into units called “modules”. So, if you have a better banning plugin, turn off the ban module! Something else does chat? Turn off the chat module!
The modularisation of Nucleus allows for exciting plugin combinations
To turn off a module, in /config/nucleus/main.conf, scroll to the modules section and set the module to DISABLED. Then restart your server.
/help command!Nucleus does not touch the /help command. /help is a Sponge command - please see the Sponge Docs for more information (and permissions).
It’s important to note that no minecraft command is actually turned off. To access a vanilla Minecraft command hidden by Nucleus, you can use /minecraft:<command>, such as
/minecraft:kill.
If you would rather have Minecraft use the command, but keep Nucleus’ available, use Sponge’s command alias feature.
In Sponge’s global.conf file, find the sponge.command.aliases section, and add <command>=minecraft to the list.
So, to set /kill to redirect to Minecraft, your aliases section should look like this:
aliases {
kill=minecraft
}
Nucleus’ kill is then available through /nucleus:kill
If you want to turn off Nucleus’ command completely without turning off the whole module, you can turn it off in commands.conf.
A BungeeCord plugin is probably taking over the command. The only thing you can do in this case is disable the command on your proxy, which might involve disabling the whole plugin.
In these scenarios, you can still use /nucleus:[command], /n[command] (replacing [command] with the name of the command),
or if it has an alias, the alias.
Most of Nucleus’ commands support warmups, cooldowns or costs. All the settings are in the /config/nucleus/commands.conf file, see
our page on this for more information.
Note that you can either do this on a global basis by changing the commands.conf file, or on a per
player/group basis using permission options.
Yes, you can. This is described in the Connection Messages module documentation.
This is entirely dependent on your Permissions plugin. While Nucleus has a lot more to offer in terms of chat formatting, and we recommend that you look at the chat module documentation pages, by default, Nucleus will display prefixes, display names and suffixes in the chat message. Therefore, you just need the to set the prefix options in your prefix options, select commands for sample permission plugins are provided here.
For a user:
For a group:
This is implemented as the permission option/meta home-count, rather than a specific permission for performance reasons.
Consult your permission plugin on how to set this option, but for reference, commands for popular permission managers are shown below:
For users:
For groups:
You can read more about the home module here.
/back telling me there is nowhere to warp to?/back was designed to be more flexible than previous plugins, but that also means that configuring it can take a few more steps. If it
isn’t working, make sure you check the following:
nucleus.back.targets.death, nucleus.back.targets.portal, nucleus.back.targets.teleportmain.conf at back.* are set as you expect them to be.By default, Nucleus overrides this behaviour if you have custom spawn rules set. If you want bed spawns to override other
respawn logic, set spawn.affect-bed-spawn to false and reload the config.
Minecraft has a special spawn logic for new players:
You can fix this by running /gamerule spawnRadius 0 (shoutout to Karaga for discovering this!)
Have you got any chat management plugins installed? These plugins tend to override what Nucleus is doing, and while Nucleus tries to be as compatible as possible, some plugins do interfere, from duplicating sections to completely blowing away all of Nucleus’ formatting.
Before reporting this to the Nucleus issue tracker (see below), please remove ANY chat management plugin and test without. SimpleChat and UltimateChat, to name some of the more popular plugins, do alter the chat and can cause surprise to the server owners! While we can try to give you help in these scenarios, please bear in mind that anyone in the Nucleus Discord channel are there for Nucleus. That said, developers of some of these other plugins are also in our Discord channel and can help you directly too.
/rtp or some other teleport to a place no player has gone before!Chunk generation is slow. A general recommendation by most of the community is to do what is known as “pre-generation” of your world. Pre-generation creates chunks in your world before they are needed, so when someone does reach that chunk, it just has to be loaded, rather than generated first. This, in general, offers a moderate performance gain, however, do be careful to not pregenerate a large world!
Nucleus offers a way to do this in the world module. If you’re running a 1.10.2 server, we recommend installing the
Nucleus Mixins plugin before attempting this, as this can provide moderate speedup of pre-generation.
The command /world border gen [-a] [--save <time>] [world] allows you to pre generate
up to your world border. We recommend setting your world border to be about a 4000 block diameter around your spawn point (using the command
/world border set 4000 when stood at the centre), and then running /world border gen. This will generate your world, using 80% of the tick
time and save every 20 seconds.
If you want to try to run the pre-generation faster, you can change the same interval to be much higher, and run in “aggressive” mode. Adding
-a to the command indicates aggresive mode, where 90% of tick time is dedicated to the generation routines, and memory checks are turned off.
To increase the save interval, add --save <time> to your command, many server owners choose save intervals of two minutes.
Some configurations are:
/world border gen -a --save 1m - aggressive mode, 1 minute save intervals./world border gen -a --save 5m - aggressive mode, 5 minute save intervals./world border gen --save 2m - normal mode, 2 minute save intervals, usually used for live servers (which we do not recommend).We recommend you do this on a server with no players on!
If you get an error that states “An error occurred while running this command”, or Nucleus does something weird when you perform an action, please do the following (make sure you have console and filesystem access):
main.conf, set core.debug-mode to true and run /nucleus reload./nucleus info on your server, and get the file it generates.That’s it! The developers may ask for more information, they will direct you on how to get this info if it’s needed.
Absolutely, we’d love to have you on board. We have JavaDocs for our API, but if the API you want doesn’t exist, or you want help with the integration, the developers are frequently on Discord.
We certainly do! This information is posted on all feature release notes where the API will have changed.
The repo is available at https://repo.drnaylor.co.uk/artifactory/minecraft/, you want the nucleus-api artifact, which contains the API
interfaces we will keep stable.
You can also use JitPack as your repo too, be sure to select the nucleus-api artifact.