Plugins
Placeholders Plugin
Use Controller API parameters for servers and groups as placeholders in your server
Overview
The placeholders plugin integrates with PlaceholderAPI to expose all important parameters from the Controller API as placeholders. This allows you to access server and group information dynamically in your server configurations.
Supported Software
| Server Type | PlaceholderAPI | This Plugin |
|---|---|---|
| Paper & Forks | ✅ Yes | ✅ Yes |
| Spigot & Forks | ✅ Yes | ✅ Yes |
| Other | ❌ No | ❌ No |
Quick Setup
- Download the plugin from GitHub
- Download PlaceholderAPI
- Place both plugins in your server's plugins folder
- Start your server
Available Placeholders
You can use parameters from both the current server and its associated group as placeholders.
Server Placeholders
| Placeholder | Description |
|---|---|
%simplecloud_server_id% | Unique identifier (UUID) |
%simplecloud_server_type% | Server type (UNKNOWN_SERVER, SERVER, PROXY) |
%simplecloud_server_state% | Server state (UNKNOWN_STATE, PREPARING, STARTING, AVAILABLE, INGAME, STOPPING) |
%simplecloud_server_host% | Host machine identifier |
%simplecloud_server_numerical_id% | Numerical ID within group |
%simplecloud_server_ip% | Server IP address |
%simplecloud_server_port% | Server port |
%simplecloud_server_max_players% | Maximum allowed players |
%simplecloud_server_min_memory% | Minimum RAM allocation in MB |
%simplecloud_server_max_memory% | Maximum RAM allocation in MB |
%simplecloud_server_player_count% | Current player count |
Group Placeholders
| Placeholder | Description |
|---|---|
%simplecloud_group_name% | Unique identifier for the group |
%simplecloud_group_type% | Server type (UNKNOWN_SERVER, SERVER, PROXY) |
%simplecloud_group_min_memory% | Minimum RAM allocation in MB |
%simplecloud_group_max_memory% | Maximum RAM allocation in MB |
%simplecloud_group_max_players% | Maximum players per server |
%simplecloud_group_player_count% | Current players count |
These placeholders can be used in any plugin or configuration that supports PlaceholderAPI. For example, you can use them in chat formats, scoreboards, or hologram plugins.
Example Usage
Here's an example using placeholders in a chat format plugin:
Or in a scoreboard configuration: