Documentation Guide

Plugin Setup

How to install and activate AxLore.

Initial Setup

Follow these steps to get AxLore running on your Paper/Spigot server.

1. Dashboard Installation

To ensure maximum security and compatibility, AxLore uses a Smart Installation system. We don't provide a generic file; instead, we generate a unique JAR for your account.

  1. Access axxtrial.space/dashboard.
  2. Log in and go to the Licenses section.
  3. Find your active AxLore license and click Download Plugin.
  4. Important: The system automatically "stamps" your license inside the .jar file. This ensures the plugin is uniquely compatible with your account and simplifies activation.
Pro Tip By downloading from the dashboard, you will always get the latest version compatible with your server, without needing constant manual updates.

2. Plug & Play Activation

Thanks to our "stamping" system, activation is fully automatic.

  • No Commands Needed: When you start your server for the first time, AxLore will detect the license embedded in the JAR.
  • Asynchronous Validation: The plugin communicates with our API in the background to validate your access without affecting server performance.
  • Silent Configuration: A .key file will be generated in the plugin folder to persist activation even if you change the JAR in the future.
Important Notice Do not share your downloaded JAR file with anyone. It includes a unique token linked to your license.

3. Credential Security

AxLore uses a separate file called credentials.yml to store your private keys (ElevenLabs API Key, Dropbox Tokens).

  • Auto-migration: If you place your keys in config.yml, the plugin will automatically move them to credentials.yml and wipe the config for security.
  • Privacy: Never share your credentials.yml with anyone.

4. Requirements and Dependencies

To ensure AxLore works correctly, you must meet these requirements:

  • ProtocolLib: (Required) Version compatible with your server.
  • Java 17+: AxLore is optimized for modern Minecraft versions.
  • WorldGuard (Optional): Needed if you want to use REGION triggers for your narrative scenes.

5. Hosting Configuration

By default, AxLore uses an internal NanoHTTPD server to host the resource pack.

  • Ensure the port (default 8090) is open in your firewall.
  • If you use a panel like Pterodactyl, you may need to map an additional port and update hosting.port in config.yml.
Important Notice To use cloud sync, run `/axlore dropbox auth` and follow the link to link your Dropbox account.

Was this helpful?

Help us improve our documentation.(Anonymous & any language)