Installation guide
Open the part you need. The steps are the same for every plugin. Where a command or a folder differs, you see it for all six.
The commands on this page are admin commands. Run them as a server operator.
In game, in one click
The usual way. For any server that can reach nightbreak.io.
It needs the plugin on your server, and the server linked to a Nightbreak account. An account is free and you link a server once.
Link your server.
Run this command in game or in the server console.
/nightbreakloginIt prints a link and a short code. Open the link, sign in, check that the page shows the same code and approve the server. Then restart the server to finish.
No account yet, or not signed in? Sign in or create a free Nightbreak account (opens in a new tab).
The link works for 30 minutes. If it runs out, run the command again.
Open the setup menu.
Run the command of your plugin, in game. It opens a menu, so a player has to run it, not the console.
- EliteMobs
/em setup - BetterStructures
/bs setup - FreeMinecraftModels
/fmm setup - EternalTD
/etd setup - ResurrectionChest
/resurrectionchest setup - CannonRTP
/cannonrtp setup
- EliteMobs
Click on the item you want.
The menu lists every item with its state. A click downloads the item and installs it.
What linking gives you
- One link covers every Nightbreak plugin on that server.
- The setup menus show what your account can install, what is installed and what has an update.
- Bought on itch.io or subscribed on Patreon? Link that service on your Nightbreak account page (opens in a new tab). Your items then unlock in the setup menu.
To unlink a server, run this command on it.
/nightbreaklogoutEverything at once
Each command downloads every item of its plugin that your account can install and that is missing or out of date. The plugin then reloads itself.
- EliteMobs
/em downloadallcontent - BetterStructures
/bs downloadallcontent - FreeMinecraftModels
/fmm downloadallcontent - EternalTD
/etd downloadallcontent - ResurrectionChest
/resurrectionchest downloadallcontent - CannonRTP
/cannonrtp downloadallcontent
If the link will not start
Use a token. On your Nightbreak account page (opens in a new tab), click Generate New Token and copy the command it shows. It looks like the line below. Run it in game, then restart the server.
/nightbreaklogin <token>A new token replaces your old one. Servers that used the old token need linking again.
If the first command asks for a token and prints no link, one of your Nightbreak plugins is too old for linking. Update your plugins, or use a token.
Manual installation
For a server that cannot reach nightbreak.io, when you already have the zip, or when you move content to another server.
Get the zip.
- On itch.io: what you get there, you download there. Many free items are there too. Open the itch.io store (opens in a new tab)
- With a Patreon tier: link Patreon on your Nightbreak account page (opens in a new tab). The items in your tier then count as yours on your Nightbreak account and in game.
- From Nightbreak: the item has its download on its page on nightbreak.io.
Put the zip in the imports folder.
Use the imports folder of the plugin the item is for. It is inside your server folder. Leave the file zipped. The plugin unpacks it and puts every file in its place.
- EliteMobs
plugins/EliteMobs/ imports - BetterStructures
plugins/BetterStructures/ imports - FreeMinecraftModels
plugins/FreeMinecraftModels/ imports - EternalTD
plugins/EternalTD/ imports - ResurrectionChest
plugins/ResurrectionChest/ imports - CannonRTP
plugins/CannonRTP/ imports
No imports folder? Start the server once with the plugin installed. That creates it.
- EliteMobs
Reload the plugin.
Run the reload command of that plugin. Restarting the server works too.
- EliteMobs
/em reload - BetterStructures
/bs reload - FreeMinecraftModels
/fmm reload - EternalTD
/etd reload - ResurrectionChest
/resurrectionchest reload - CannonRTP
/cannonrtp reload
A reload stops what the plugin is doing at that moment, such as a game, a boss fight or the generation of a structure.
- EliteMobs
Check that it worked.
- Open the setup menu again. The item should show as installed.
- Look in the imports folder. If the zip is gone, it was installed. If it is still there, it was not, and the server console says why.
- If the item shows as downloaded but not installed, click on it in the menu.
Automatically updating content
Turn it on once. Each plugin then keeps its installed content up to date by itself.
Turn on Automatic Updates
Open the setup menu of a plugin and click the Automatic Updates button. It is off at first. Each plugin has its own button, so do this in every plugin you want kept up to date.
What it does
- A few minutes after the server starts, the plugin downloads the updates for its installed content.
- The server uses those updates after its next restart.
What it does not do
- It does not update while the server runs. It checks when the server starts.
- It does not install items you do not have yet.
- It does nothing on a server that is not linked.
The same button also downloads new versions of the plugin itself. Those need an active supporter membership on Patreon.
Update right now
To update without waiting for a restart, run the update command of your plugin. It updates every installed item that is out of date. The plugin then reloads itself.
- EliteMobs
/em updatecontent - BetterStructures
/bs updatecontent - FreeMinecraftModels
/fmm updatecontent - EternalTD
/etd updatecontent - ResurrectionChest
/resurrectionchest updatecontent - CannonRTP
/cannonrtp updatecontent
For one item, open the setup menu and click on an item that is marked as out of date.
Updating by hand and reimporting content
For updating with a new zip, and for content whose files were deleted or damaged.
Updating with a new zip
Get the new zip the same way as the first one, put it in the imports folder and reload the plugin, as under Manual installation. The new version replaces the old one.
An update writes over the item’s files. If you changed any of them, back them up first.
Files the new version no longer includes are moved to this folder, not deleted.
plugins/MagmaCore/outdated files If the update replaces a world that is loaded, the plugin first moves its players to another world. If it cannot, the import stops and the zip stays in the folder.
Reimporting content
In game: each command downloads the installed items of its plugin again, even when the menu says they are current. It needs a linked server.
- EliteMobs
/em forcereinstallcontent all - BetterStructures
/bs forcereinstallcontent all - FreeMinecraftModels
/fmm forcereinstallcontent all - EternalTD
/etd forcereinstallcontent all - ResurrectionChest
/resurrectionchest forcereinstallcontent all - CannonRTP
/cannonrtp forcereinstallcontent all
If the files of an item are gone completely, type the name of that item in place of all. Press Tab after the command to see the names.
With the zip: put it in the imports folder again and reload the plugin, as under Manual installation.
If it does not show up
The causes to check first, each with its fix, and where to get help.
The zip is still in the imports folder.
The import failed, and the server console says why. One cause is a zip that was unpacked and packed again, with folders at the top that the plugin does not know. The console names the folder. Download the zip again and leave it as it is.
The item is downloaded but not installed.
Open the setup menu and click on it.
The menu says you do not have access.
The server is linked, but the account does not have this item. If you got it on itch.io or through Patreon, link that service on your Nightbreak account page (opens in a new tab).
Models are missing or have no textures.
Models need FreeMinecraftModels on the server. Textures need its resource pack to reach the player, which is the job of ResourcePackManager.
Files were deleted or damaged.
Install the content again. The steps are under Updating by hand and reimporting content.
Where to get help
- The guide of each plugin on the wiki (opens in a new tab)
- Manual imports on the wiki (opens in a new tab)
- Linking a server on the wiki (opens in a new tab)
- Ask on Discord (opens in a new tab)
When you ask for help, run this command first. It uploads the server log and gives you a link to share.
/logify