Skip to main content

What is the Altis Plugin?

Altis is caBRAPI’s official plugin for Spigot/Paper Minecraft servers. It automatically connects purchases made in your caBRAPI store to the server, delivering products automatically — with no manual intervention required.

Features

  • Automatic product delivery to the player when they join the server
  • Execution of custom commands in the console or as a player
  • Inventory full check before delivering physical items
  • nLogin support for servers with authentication
  • Notifications via Discord Webhook
  • Periodic check of pending payments (console mode)
  • Duplicate prevention with processed payment records
  • Support for versions 1.16.x through 1.21.x and 26.x

📦 Requirements

Plugin Download

  1. Go to the Altis Releases page on GitHub.
  2. Download the .jar file of the latest version.

🚀 Installation

  1. Place the downloaded .jar file in your server’s plugins/ folder.
  2. Start or restart the server.
  3. The plugin will automatically create the following structure:
  1. Check the console to confirm the plugin loaded correctly — you will see the ALTIS by caBRAPI banner and the configuration status.

⚙️ Configuration

Edit the plugins/altis/config.yml file with your store’s data:

Full config.yml reference

Getting your credentials

  1. Access the caBRAPI panel.
  2. Navigate to Store Settings.
  3. Copy the Store ID and API Key.
  4. Paste the values into the plugin’s config.yml.
  5. Run /cabrapi reload in-game or restart the server.

🎮 Commands and Permissions

The cabrapi.admin permission is automatically granted to OPs (default: op).

🧩 Configuring Products in the Panel

For the plugin to deliver items automatically, each product needs metadata in the minecraft format. This is configured in the caBRAPI panel, in the product edit section, MetaData field.

Basic example

Available fields

💡 Tip: Use {player} in commands and in the message — it will be automatically replaced by the player’s nickname at activation time.

Execution Modes

Console Mode (run: console)

Commands are executed directly in the server console (OP level). Ideal for:
  • Any action that does not depend on the player being online
Console mode does not support inventory checks. Products in console mode are processed both on player authentication and during the periodic background check.

Player Mode (run: player)

Activation occurs when the player authenticates on the server (on join or on nLogin login). Useful for:
  • Item delivery with inventory check
  • Any action that depends on the player being online

🔄 Pending Payment Check

The plugin checks for pending payments in two scenarios:
  1. On server join — processes all pending payments for that player automatically.
  2. Periodically (every check-interval minutes) — processes payments for products configured as run: console, even if the player is offline.
Processed payments are stored in plugins/altis/data/processed.yml to prevent duplicates.

🔐 nLogin Support

If your server uses the nLogin plugin for authentication, Altis detects it automatically and waits for the player to log in (NLoginLoginEvent) before processing pending payments. If nLogin is not present, the plugin uses the default PlayerJoinEvent.
No additional configuration is needed — detection is fully automatic.

🌐 Discord Webhook (optional)

To receive Discord notifications whenever a player buys something:

Available placeholders

🎨 Available Colors in Messages

Combine with formatting: &l (bold), &n (underline), &o (italic), &k (magic), &m (strikethrough).

📘 Practical Examples

Example 1: Starter kit with physical items

The plugin checks if the player has 4 empty slots before delivering. If the inventory is full, a warning message is sent. Inventory check works only in player mode.

Example 2: VIP rank with LuckPerms

Example 3: Command executed as an authenticated player

The player needs to be authenticated on the server to receive it, since the commands are executed as them. Activation occurs at login/join time.

🔧 Troubleshooting