EndyDev Read the docs
Esc

Installation

The jar

  1. Download eRankGenerator.jar from BuiltByBit, put it in plugins/ and restart the server.
  2. The console says License verified successfully. You’re ready.

On its first start eRankGenerator creates plugins/eRankGenerator/ with config.yml. It has no other dependency: Geyser, Floodgate, PlaceholderAPI and the pack plugins are used when they’re there.

Your first badge

  1. In game, run /erank editor and click the link. The editor opens in your browser, already linked to your server.
  2. Click + next to Ranks, type the rank name (Owner) and pick a template.
  3. Change the text and colours, add an icon if you like. The chat preview at the bottom shows how it looks.
  4. Click Deploy. The editor gives you a command such as /erank apply AB12CD34: copy it.
  5. Run it in game or in the console, within 10 minutes. The badges are live: Java players online get the new pack at once (or your pack plugin reloads with it), Bedrock players when they reconnect.

Then put the badge in a prefix: /erank list, click the badge to copy it, and paste it into /lp group owner meta setprefix 100 "<paste> ". More in Using the badges.

The first tour of the editor walks you through steps 2 to 4. Replay it any time with Tour, top right.

License

The jar you download from BuiltByBit already holds your license key: there’s nothing to set.

  • On startup the server checks the key online and gets a permit that lasts 7 days. It renews it every 12 hours. If the license server can’t be reached, everything keeps working while the permit lasts.
  • A license covers 3 servers. A server that hasn’t been seen for 7 days frees its place on its own.
  • A key that’s unknown, revoked or already on 3 servers stops the plugin, with the reason in the console.
  • A key you got another way (from support): put it in license-key in config.yml and restart.

The server’s identity is kept in plugins/eRankGenerator/data.json. Copying the folder to another server copies that identity too; delete data.json on the copy so it registers as a server of its own.

What it writes

FileWhat it is
config.ymlYour settings (Configuration)
data.jsonThis server’s id, the license permit and the hosted pack’s address. Don’t share it
project.jsonThe last version you applied: the ranks, their characters and pictures
output/java.zipThe Java resource pack
output/bedrock.mcpackThe Bedrock resource pack
output/<Plugin>/The files for ItemsAdder, Nexo, Oraxen and CraftEngine, ready to copy
bedrock.mcpackThe copy Geyser gives to Bedrock players

Updating

Download the new jar, replace the old one and restart. Your ranks, config.yml and license stay as they are.