FAQs

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 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 config file is in the local directory, and you want to set the following options under “ranks”:

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:

You will not be able to go AFK (permission: nucleus.afk.exempt.toggle)

Logging in/out of your server will never generate a connection message (permission: nucleus.connectionmessages.disable)

Other plugins may also not function as intended, a good example is GriefPrevention. So, please, don’t use the wildcard.

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.

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.

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.

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.

This probably means you’re running Minecraft 1.10.2, and you’re not using Nucleus Mixins as well. This is an optional (but
recommended) plugin that changes Minecraft’s internals to allow you to use /invsee from further than 8 blocks away from your target. Minecraft 1.11.2 users don’t need this plugin, a better fix is in Sponge API 6 for 1.11.2.

The location they log in will always be on the surface, and always a grass block

The location will be around spawn, to provide a random-ish start point.

Nucleus can employ some tricks to force players to start at your spawn point if you use the
spawn module. Use the command /setfirstspawn at the location you want new players to spawn
at (which can be the same as the normal spawn point), and set spawn.force-first-spawn to true.
Then, use /nucleus reload if your server is running. Players will now spawn exactly on the first
spawn point that you set.

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.

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.

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):