v1.0-SNAPSHOT

NxRanks

๐Ÿง  The Modern Way to Manage Ranks

Managing custom rank icons has always been more complicated than it should be.
Most setups require external tools, manual resource pack editing, and careful formatting just to get a single prefix working correctly.

NxRanks removes that entire process.

Instead of dealing with sprite sheets and JSON files, you can design your rank icons inside a simple web workspace. You draw your design visually—pixel by pixel—without needing any external software or technical setup.

 

 

Once you're done, NxRanks automatically generates a complete resource pack for both Java and Bedrock Edition, so your ranks look consistent across all platforms.

From there, everything is handled for you. The plugin connects your server to your workspace, lets you sync your designs with a simple command, and can distribute the resource pack directly to players without requiring a restart.

The goal is simple:
focus on creating your ranks, not dealing with the technical side.

๐Ÿš€ Installation

NxRanks is designed for Paper/Spigot servers and requires a valid license key to access the web workspace.


โšก Step-by-Step Setup

  • 1. Install the Plugin
    Place NxRanks.jar into your /plugins folder.

 

 

  • 3. Add Your License Key
    Open config.yml and paste your license key:
license-key: "YOUR_KEY_HERE"
  • 4. Restart the Server
    Restart your server to verify the license and enable the NxRanks API.
  • 5. Open the Editor
    Use /nxranks editor in-game to open your web workspace.

โœ… Success Check

  • The /nxranks editor command generates a clickable link
  • No license errors appear in console

โš ๏ธ Common Issues

  • License not working?
    Make sure you entered it correctly in config.yml
  • Editor link not generating?
    Ensure your server has an internet connection

๐Ÿ’ก Tip

Your license key is only shown once when claimed. Make sure to store it safely.

๐ŸŽจ Designing Your Ranks

NxRanks includes a powerful web-based workspace that lets you design custom rank icons visually—without any external tools, resource pack editing, or manual setup.


๐Ÿงฉ Workspace Features

  • Live Canvas
    Instantly preview how your rank will look in-game as you design it.
  • Pixel Editor
    Use simple tools like Brush and Eraser to draw precise pixel-based designs.
  • Advanced Styling
    Apply gradients, borders, and custom text styling to match your server’s branding.
  • Cross-Platform Output
    Automatically generates both Java and Bedrock resource pack files with correct formatting.
  • Instant Sync System
    Click Save & Sync to generate your pack and receive a download code for in-game syncing.

โš™๏ธ How It Works

  1. Open the workspace using /nxranks editor
  2. Design your rank icon visually
  3. Click Save & Sync
  4. Use the generated code with /nxranks download

โšก Important Notes

 

  • Generated packs are stored temporarily (around 60 seconds)
  • Make sure to sync your pack before the session expires
  • You can regenerate your pack at any time from the workspace

 

โš™๏ธ Commands

NxRanks provides a minimal and streamlined command system. Most functionality is handled through the web workspace and in-game automation.


Command Description
/nxranks editor Generates a secure, one-time link to open your web workspace.
/nxranks download <code> Downloads and syncs your generated resource pack using the provided workspace code.
/nxranks list Displays all created ranks with a clickable [COPY] button for their Unicode symbols.
/nxranks textureall Forces the configured resource pack to be sent to all online players.
/nxranks reload Reloads the plugin configuration and message settings.

๐Ÿ’ก Notes

  • Most rank creation and editing is done through the web workspace
  • The /nxranks download command requires a valid code generated from the workspace
  • Use /nxranks textureall only if resource pack distribution is enabled in the config

๐Ÿ” Permissions

NxRanks uses a simple permission system focused on administrative control. Most functionality is handled through the web workspace, reducing the need for complex permission setups.


Permission Description Default
nxranks.admin Grants full access to all NxRanks commands, including editor link generation, pack syncing, and management tools. OP

๐Ÿ’ก Notes

  • This permission should only be granted to trusted staff or administrators
  • Players do not need any permissions to use rank prefixes in-game
  • All rank creation and editing is handled through the web workspace

โš™๏ธ Configuration

NxRanks is designed to be simple to set up. Most of the configuration focuses on your license key, resource pack delivery, and message customization.


๐Ÿ”‘ License

license-key: "NEXO-XXXX-XXXX"

This is your unique license key required to use NxRanks.

  • You receive this after claiming your purchase
  • The plugin uses it to verify access and generate your editor session
  • If this is missing or invalid, the editor system will not work

๐Ÿ“ฆ Resource Pack Settings

resource-pack:
  enabled: true
  url: ""

Controls how your generated resource pack is distributed to players.

enabled

  • true → Allows the plugin to send the resource pack to players
  • false → Disables automatic distribution

url

  • The direct download link to your generated resource pack
  • This must be a direct file link (not a webpage)
  • You can host it on:
    • Your own server
    • Dropbox (with direct link)
    • Any static file host

๐Ÿ’ก Tip:
If this is empty, features like /nxranks textureall will not work.

โ“ Frequently Asked Questions


โณ Why did my editor link expire?

For security reasons, editor sessions are time-limited (approximately 1 hour). If your session expires, simply run /nxranks editor again to generate a new link.

๐Ÿ’ฌ How do I use the ranks in my chat plugin?

Run /nxranks list to view all available rank symbols. Click the [COPY] button to insert the Unicode into your chat box, then paste it into your chat plugin (such as LuckPerms prefixes or other formatting systems).

โš™๏ธ Does NxRanks manage permissions or ranks automatically?

No. NxRanks does not handle permissions, rank assignment, or player groups.

It is designed purely to create and provide custom rank textures. You must use a permissions plugin like LuckPerms to assign and manage ranks.

๐ŸŒ Does this work for Bedrock players?

Yes. NxRanks supports Bedrock players through GeyserMC by generating the required glyph sheets automatically, ensuring symbols display correctly across platforms.


๐Ÿ’ก Tip

Think of NxRanks as a visual rank designer, not a rank management system.