Guide
Main Menu
The main menu provides quick access to either Manual or Automatic mode.
Automatic mode will ask you a few questions, then configure the server accordingly. We recommend you start here, then use manual mode to change things slightly if you need to.
Manual mode allows you to fine-tune configuration options to your liking.
Run /kos
Select 'Automatic'
If you have pre-generated your world, click the green button. If not, click red. Pre-generation refers to generating all the chunks in your world using a plugin such as Chunky.
Select the profile you'd like to use.
Restart your server.
Automatic
Automatic mode uses profiles to automatically apply many optimisations at once. These give you a good starting point to work from. Sometimes you might want to adjust these using Manual mode.
Manual
Run /kos
Select 'Manual'
Select the configuration you'd like to modify.
Select the value you'd like to modify (left click = down 1, right click = up 1, see below for more info).
Restart your server.
Changing Values
To change values, simply click on the value you'd like to change! Left clicking will decrease the value by 1, and right clicking will increase the value by 1.
You can hold the shift key whilst clicking to change the value by 10 either way (depending on which mouse key you click). For example Shift+Left click will decrease the value by 10.
You don't have to have all the blocks green, if your server is running fine with some red - leave it! If it begins to lag, consider reducing the red blocks until it's less laggy.
Block Colours
We use block colours to show the ideal values for each option, some ideal values may have a range, so you can typically go a few spaces either way.
Hovering over the block will give you more information about what the value is, and what we recommend.
You don't have to have all the blocks green, if your server is running fine with some red - leave it! If it begins to lag, consider reducing the red blocks until it's less laggy.
Colour | Meaning |
|---|---|
Green | This is an ideal value for this option. Please note that ideal values may be in a range, so you can sometimes go a few options either way. |
Red | This value will likely impact the performance of your server. Hovering over the block will tell you if it's too high or too low. |
Orange | This value will likely impact the experience your players have on your server, as it may differ too far from typical Minecraft behaviour. This may include some features not working as expected, or certain technical skills such as mob farms being broken. Hovering over the block will tell you if it's too high or too low. |
White | This value is ambiguous. This means that it may have been set by another configuration file, and also setting it here may become confusing or cause unexpected behaviors. Hovering over the block should tell you what to do instead. |
Barrier Icon | Something went wrong, please send a screenshot to github.com/lewmc/kryptonite/issues so that we can investigate it. Deleting the affected config file then restarting your server should fix this. |
When you're done
You must restart your server for values set in KOS to be applied. This is because most configuration files are cached so that their values cannot change whilst the server is running. This is done to ensure the server does not have any errors or break.
Optimisations applied in KOS will not take effect until the server has restarted.
Do not use the /reload command or reloading plugins - This is highly flawed and can cause more problems, especially with permissions and other plugins.
If you're happy with your optimisations you can uninstall Kryptonite. It is not required to stay on the server, and all your optimisations will remain.
If you'd prefer, you can keep it. You'll be notified if we push any updates, and you'll be able to modify your configuration later as well should you require any changes.
We also have the Exploit Database that is part of Kryptonite as well, you might like to try that next.
"Your server does not support this"
If you see this in the menus, it is because your server does not have the required configuration files present to be able to manage them.
If automatic or manual mode is listed as unsupported it is because no configuration files could be found.
To resolve this, please try to restart your server. If this does not help, please check that configuration files are present. You'll need to be using Bukkit or a fork of it (for example: Spigot, Paper, Pufferfish, Purpur, etc.), if you're not you may run into some issues.