Skip to content

Modules

A module is a helper that runs next to one server in its own container: a web map of the world, for example. Each server’s Modules tab (administrators and owners) lists its modules and the kinds there are to add.

Modules run on the panel’s own machine only for now. A server with modules can’t be moved to another machine until they’re removed.

Pick a module under Add a module, give it a name (its folder is modules/<name> in the server’s folder), and fill in its settings. Runs chooses when it runs:

  • With the server: starts when the server is running, and stops when the server stops, crashes or sleeps.
  • All the time: keeps running whatever the server does. NetherNode starts it again when it starts.
  • Only when started: starts and stops only from its Start and Stop buttons.

Each module gets a memory limit, its own log (the scroll button), and a settings dialog. Saving settings restarts a running module with them. A module that stops with an error shows Failed and why.

  • Files: modules/<name>/ in the server’s folder, so backups carry them. What a module makes again on its own, such as a map’s rendered tiles, goes in modules/<name>/cache/, which backups leave out. A copy of the server gets the folder but not the module; add it again with the same name to use it.
  • Container: nethernode-<slug>.<name> (the server’s slug), never privileged, without the Docker socket, and with only the folders its template lists (the server’s world is read-only where that’s all it needs).
  • Network: a private network, nethernode-<slug>.modules, holds the server’s modules and the server itself (as minecraft), so modules that talk to the server can, and other servers’ modules can’t.
  • Web pages: published on the panel machine’s backend_ip (127.0.0.1 unless you use bridge networking), from ports 8100–8199 ([docker] module_port_range_start/end). Open them from that machine for now; showing them through the panel comes next.

Remove takes away the container and leaves the folder, so adding the module again picks up where it left off; tick the box to delete the folder too. Deleting a server removes its modules.

BlueMap renders a 3D map of the world from its region files and serves it as a web page.

  • It needs the game’s textures, which it downloads from Mojang under the Minecraft EULA: the Download Minecraft’s textures from Mojang box has to be ticked.
  • It runs all the time by default, so the map stays up while the server sleeps, and reads the world (the server’s level-name) without changing it.
  • The first render takes a while and uses a lot of CPU; Render threads sets how much. After that it updates what changes.
  • modules/bluemap/config/core.conf is written from the settings each start; BlueMap’s other config files are its own to change.
  • Vanilla, Fabric and Forge worlds get Overworld, Nether and End maps. Paper and Purpur keep the Nether and End in separate folders, so only the Overworld map shows anything there.
  • The server must have started once so its world exists.