PlaceholderAPI
PlaceholderAPI allows you to display clan information in chat, scoreboards, holograms, and other plugins.Installation
Clan Information Placeholders
Display information about a player’s clan:| Placeholder | Description | Example Output |
|---|---|---|
%clanplus_clan_name% | Clan name | Warriors |
%clanplus_clan_customname% | Colored custom name | &6&lWarriors |
%clanplus_clan_formatname% | Custom name or regular name | Warriors |
%clanplus_clan_owner% | Clan owner’s name | Steve |
%clanplus_clan_message% | Clan message/MOTD | Welcome! |
%clanplus_clan_score% | Current clan score | 1500 |
%clanplus_clan_warpoint% | Clan war points | 5000 |
%clanplus_clan_warning% | Warning count | 0 |
%clanplus_clan_maxmembers% | Maximum member slots | 20 |
%clanplus_clan_createddate% | Creation date (milliseconds) | 1678901234567 |
%clanplus_clan_format_createddate% | Formatted date | 03/15/2023 |
%clanplus_clan_members% | List of members | [Steve, Alex] |
%clanplus_clan_allies% | List of allied clans | [Defenders] |
%clanplus_clan_discordchannelid% | Discord channel ID | 123456789 |
%clanplus_clan_discordjoinlink% | Discord invite link | discord.gg/abc123 |
Player Information Placeholders
Display information about a player’s clan membership:| Placeholder | Description | Example Output |
|---|---|---|
%clanplus_player_rank% | Player’s rank | LEADER |
%clanplus_player_format_rank% | Formatted rank | &c&lLeader |
%clanplus_player_joindate% | Join date (milliseconds) | 1678901234567 |
%clanplus_player_format_joindate% | Formatted join date | 03/15/2023 |
%clanplus_player_scorecollected% | Score contributed | 450 |
%clanplus_player_lastactivated% | Last activity (milliseconds) | 1678901234567 |
%clanplus_player_format_lastactivated% | Formatted last activity | 03/15/2023 |
Skill Level Placeholders
Display clan skill levels:<skillid> with the skill ID from skills.yml:
%clanplus_clan_skilllevel_1%- Critical Hit level%clanplus_clan_skilllevel_2%- Life Steal level%clanplus_clan_skilllevel_3%- Dodge level%clanplus_clan_skilllevel_4%- Boost Score level
Permission Placeholders
Display clan permission requirements:<subject> with permission name (lowercase):
%clanplus_clan_subjectpermission_invite%- Returns:LEADER%clanplus_clan_format_subjectpermission_invite%- Returns:&c&lLeader
Top Clans Placeholders
Display clan leaderboards:<number> with position (1, 2, 3, etc.):
%clanplus_top_score_name_1%- First place clan name%clanplus_top_score_value_1%- First place clan score%clanplus_top_score_name_2%- Second place clan name%clanplus_top_score_value_2%- Second place clan score
If a position doesn’t exist or no clan is found, placeholders return the value configured in
soft-depend.placeholderapi.no-clan.Customizing Placeholder Output
Customize placeholder formats inconfig.yml:
%value% placeholder is replaced with the actual data.
Usage Examples
In Chat Format (with ChatControl, EssentialsX, etc.):[Warriors] Steve: Hello!
In Scoreboard (with FeatherBoard, AnimatedScoreboard, etc.):
Discord Webhook Integration
Send clan events and war event updates to Discord channels using webhooks.Setup
Create Discord webhook
In your Discord server:
- Go to Server Settings → Integrations → Webhooks
- Click “New Webhook”
- Configure name and channel
- Copy the webhook URL
War Event Messages
Starting Message (discordsrv-warevent-starting.json):
discordsrv-warevent-ending.json):
Available Placeholders
Starting message:%timeLeft%- Event duration remaining%players%- Current online players
%topScoreClaimed_<N>_name%- Clan name at position N%topScoreClaimed_<N>_score%- Clan score at position N%topDamage_<N>_name%- Top damage dealer name%topDamage_<N>_score%- Damage dealt%topTank_<N>_name%- Top damage taker name%topTank_<N>_score%- Damage taken%totalDamagesCaused%- Total damage in event%totalDamagesCollected%- Total damage taken%totalScoreCollected%- Total score earned
Set
maxtop in the JSON to control how many top positions are shown. The placeholder system will use the unknown value for positions without data.Implementation Details
FromDiscordSupport.java:24-36, messages are sent asynchronously:
Vault / Economy Integration
Vault provides economy integration for clan creation costs and skill upgrades.Installation
Install economy plugin
Install an economy plugin like:
- EssentialsX
- CMI
- BetterEconomy (for Folia servers)
Folia Users: Standard Vault doesn’t work on Folia. Use VaultUnlocked and BetterEconomy instead.
Configuration
Enable Vault currency for various features: Clan Creation:upgrade.yml):
Currency Validation
FromUpgradeManager.java:42-51, Vault integration checks balances:
Money is withdrawn from the player initiating the action (e.g., the player creating the clan or purchasing the upgrade).
PlayerPoints Integration
PlayerPoints provides an alternative currency system.Installation
Configuration
Clan Creation:Implementation
FromUpgradeManager.java:53-63:
Other Soft Dependencies
SuperVanish / PremiumVanish
Integration with vanish plugins:- Vanished players don’t appear in invite lists
- Vanished members show as OFFLINE in member lists
- Configurable in
config.yml:
MythicMobs
Custom mob integration:- MythicMobs can award points in war events
- Configure scores in
events.yml:
- Automatically detected if MythicMobs is installed
- Falls back to vanilla mobs if MythicMobs is not present
Floodgate (GeyserMC)
Bedrock player support:- Full compatibility with Bedrock Edition players via Floodgate
- Economy transactions work correctly for Bedrock players
- No special configuration needed
ClansPlus automatically handles Floodgate players. Version 1.4 fixed currency issues for Floodgate players.
Troubleshooting Integrations
PlaceholderAPI Issues
Placeholders show as text:- Verify PlaceholderAPI is installed:
/papi version - Check expansion is registered:
/papi list - Reload ClansPlus:
/clansplusadmin reload
- Player is not in a clan
- Or customize the message in
config.ymlundersoft-depend.placeholderapi.no-clan
Vault/Economy Issues
“Vault plugin is missing” error:- Install Vault plugin
- Install an economy plugin (EssentialsX, etc.)
- Restart server
- Verify:
/vault-info
- Check player has sufficient balance
- Verify economy plugin is working:
/balance - Check ClansPlus console for errors
Discord Webhook Issues
Messages not sending:- Verify webhook URL is correct in
config.yml - Check Discord channel permissions
- Look for errors in console starting with
[Discord Web Hook] - Test webhook with a tool like Postman
- Validate JSON syntax in webhook files
- Use a JSON validator: jsonlint.com
- Check placeholder spelling is correct
