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.xthrough1.21.xand26.x
📦 Requirements
Plugin Download
- Go to the Altis Releases page on GitHub.
- Download the
.jarfile of the latest version.
🚀 Installation
- Place the downloaded
.jarfile in your server’splugins/folder. - Start or restart the server.
- The plugin will automatically create the following structure:
- Check the console to confirm the plugin loaded correctly — you will see the ALTIS by caBRAPI banner and the configuration status.
⚙️ Configuration
Edit theplugins/altis/config.yml file with your store’s data:
Full config.yml reference
Getting your credentials
- Access the caBRAPI panel.
- Navigate to Store Settings.
- Copy the Store ID and API Key.
- Paste the values into the plugin’s
config.yml. - Run
/cabrapi reloadin-game or restart the server.
🎮 Commands and Permissions
Thecabrapi.adminpermission is automatically granted to OPs (default: op).
🧩 Configuring Products in the Panel
For the plugin to deliver items automatically, each product needs metadata in theminecraft 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:- On server join — processes all pending payments for that player automatically.
- Periodically (every
check-intervalminutes) — processes payments for products configured asrun: 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.