License key

Where a licensed NusaPack build expects your license key, how to add it, and how to see that it is active.

On this page

Licensed builds of NusaPack need your license key before they start working. This page shows where the key goes, the alternative for hosts with environment variables, and how to check that the license is active. If your build does not create a license file, you can skip this page.

Add your key

  1. Start the server once with NusaPack installed. The first start creates plugins/NusaPackBridge/nusa-license.properties.
  2. Open that file in a text editor.
  3. Put your license key after license-key= on that line, replacing the placeholder text. Do not add spaces or quotes around the key.
  4. Save the file.
  5. Restart the server.

The Geyser extension reads the same nusa-license.properties file, so you only add the key once.

Use an environment variable instead

If your host lets you set environment variables for the server, you can put the key in the variable NUSAPACK_LICENSE_KEY instead of the file. This is the recommended way on shared hosts.

When NUSAPACK_LICENSE_KEY is set, its value is used and the file is not read. NusaPack uses its own variable and file names, so a key for another product on the same machine is never used by mistake.

Check that the license is active

There are two places to look:

WhereWhat you see
The startup summary in the console (lines start with NusaPack »)A License row with the license state. It says locked when no valid license was found.
/npb status, or the nether star at the top of the /npb panelA License row at the top of the Pack group.

When the license is active, all /npb commands and panel buttons work normally.

When NusaPack is locked

Without a valid license, the plugin disables itself at startup, and every /npb command and menu button answers "NusaPack Bridge is locked". Nothing from NusaPack is registered in Geyser either.

To fix it:

  1. Read the license lines in the console. They say what is wrong, for example that no key was found.
  2. Fix the key in nusa-license.properties (or in NUSAPACK_LICENSE_KEY). Check that you copied the whole key and that the placeholder text is gone.
  3. Restart the server.

If NusaPack stays locked after a restart with the correct key, contact support.

Next steps

Nusa product documentation · NusaPackPaper 1.21.x · Java 21

Loading the index…