Placeholders Plugin

All information about this project can be found in our detailed documentation.

The placeholder plugin allows you to use all important parameters of the Cloud API as placeholders with the help of the PlaceholderAPI. This allows you to retrieve all information about a server or group as a placeholder.

The plugin supports Paper, Purpur, and Folia. Folia installations require PlaceholderAPI 2.11.7 or newer.

Targeting other resources

The existing placeholders continue to return information about the current server, group, or persistent server:

%simplecloud_server_player_count%
%simplecloud_group_player_count%
%simplecloud_persistent_server_player_count%

You can target another resource by inserting its selector before the property:

%simplecloud_group_<group-name>_<property>%
%simplecloud_persistent_server_<persistent-server-name>_<property>%
%simplecloud_server_<group-name>:<numerical-id>_<property>%
%simplecloud_server_id:<server-id>_<property>%

For example:

%simplecloud_group_Lobby_player_count%
%simplecloud_persistent_server_MainLobby_is_active%
%simplecloud_server_Lobby:1_state%
%simplecloud_server_id:550e8400-e29b-41d4-a716-446655440000_player_count%

Group and persistent-server names may contain underscores. If the selected resource does not exist or the selector is invalid, the placeholder cannot be resolved.

Contributing

Contributions to SimpleCloud are welcome and highly appreciated. However, before you jump right into it, we would like you to read our Contribution Guide.

License

This repository is licensed under Apache 2.0.