Skip to content

Commit fb36155

Browse files
CopilotNonSwag
andcommitted
Update ServiceIO placeholders documentation with complete list from source code
Co-authored-by: NonSwag <[email protected]>
1 parent ff86f2c commit fb36155

File tree

1 file changed

+57
-12
lines changed

1 file changed

+57
-12
lines changed

content/docs/serviceio/placeholders.mdx

Lines changed: 57 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -26,25 +26,48 @@ All ServiceIO placeholders follow the format:
2626
- `%serviceio_suffix%` - Player's suffix from the permission service
2727
- `%serviceio_displayname%` - Player's display name
2828

29-
### Economy (Bank)
30-
- `%serviceio_bank%` - Alias for `bank_balance`
31-
- `%serviceio_bank_balance%` - Player's current balance (raw number)
32-
- `%serviceio_bank_balance_formatted%` - Player's current balance (formatted with currency)
29+
### Economy (Standard)
30+
- `%serviceio_balance%` - Player's current balance (raw number)
31+
- `%serviceio_balance_<world>%` - Player's balance in a specific world (raw number)
32+
- `%serviceio_balance_formatted%` - Player's current balance (formatted with currency)
33+
- `%serviceio_balance_formatted_<world>%` - Player's balance in a specific world (formatted with currency)
34+
35+
<Callout title="Economy Placeholders">
36+
Economy placeholders require an economy service provider to be installed and configured with ServiceIO.
37+
</Callout>
38+
39+
### Economy (Bank System)
40+
- `%serviceio_bank%` - Name of the player's current bank
41+
- `%serviceio_bank_balance%` - Player's current bank balance (raw number)
42+
- `%serviceio_bank_balance_formatted%` - Player's current bank balance (formatted with currency)
43+
- `%serviceio_bank_<world>%` - Name of the player's bank in a specific world
44+
- `%serviceio_bank_<world>_balance%` - Bank balance in a specific world (raw number)
45+
- `%serviceio_bank_<world>_balance_formatted%` - Bank balance in a specific world (formatted with currency)
46+
- `%serviceio_banks%` - List of all available banks (comma-separated)
47+
- `%serviceio_banks_<world>%` - List of banks available in a specific world (comma-separated)
3348

3449
<Callout title="Bank Placeholders">
35-
Bank placeholders require an economy service provider to be installed and configured with ServiceIO.
50+
Bank placeholders require an economy service provider with bank support to be installed and configured with ServiceIO.
3651
</Callout>
3752

3853
### Permission Groups
3954
- `%serviceio_group%` - Player's primary permission group
4055
- `%serviceio_groups%` - All of player's permission groups (comma-separated)
4156

42-
### Additional Placeholders
57+
### VaultUnlocked Compatibility
4358

44-
More placeholders may be available depending on your installed service providers and ServiceIO configuration. The complete list depends on:
45-
- Installed economy plugins
46-
- Permission plugins
47-
- Other service providers registered with ServiceIO
59+
ServiceIO also provides VaultUnlocked-compatible placeholders using the `%vaultunlocked_*%` format for advanced economy features:
60+
61+
- `%vaultunlocked_balance%` - Player's balance
62+
- `%vaultunlocked_balance_<world>%` - Balance in a specific world
63+
- `%vaultunlocked_balanceformatted%` - Formatted balance
64+
- `%vaultunlocked_balance_currency_<currency>%` - Balance in a specific currency
65+
- `%vaultunlocked_accounts%` - List of accounts the player is a member of
66+
- `%vaultunlocked_accounts_count%` - Number of accounts the player belongs to
67+
68+
<Callout title="VaultUnlocked Placeholders">
69+
VaultUnlocked placeholders provide advanced multi-currency and account management features. See the [VaultUnlocked documentation](https://github.com/TheNewEconomy/VaultUnlocked) for the complete list of available placeholders.
70+
</Callout>
4871

4972
## Usage Examples
5073

@@ -59,14 +82,36 @@ format: "%serviceio_prefix%%player_name%%serviceio_suffix%: %message%"
5982
# Example scoreboard using economy data
6083
title: "Server Info"
6184
lines:
62-
- "Balance: %serviceio_bank_balance_formatted%"
85+
- "Balance: %serviceio_balance_formatted%"
86+
- "Bank: %serviceio_bank_balance_formatted%"
6387
- "Rank: %serviceio_group%"
6488
```
6589
90+
### World-Specific Economy
91+
```yaml
92+
# Show balance for specific world
93+
balance-message: "Your balance in %world%: %serviceio_balance_formatted_world%"
94+
95+
# Bank balance in a specific world
96+
bank-info: "Your bank in the nether: %serviceio_bank_nether_balance_formatted%"
97+
```
98+
99+
### Multi-Bank Setup
100+
```yaml
101+
# List all available banks
102+
bank-list: "Available banks: %serviceio_banks%"
103+
104+
# Show player's current bank
105+
current-bank: "Your current bank: %serviceio_bank%"
106+
```
107+
66108
### In MOTD or Other Text
67109
```yaml
68110
# Welcome message with player data
69-
welcome-message: "Welcome %serviceio_displayname%! Your balance: %serviceio_bank_balance_formatted%"
111+
welcome-message: "Welcome %serviceio_displayname%! Your balance: %serviceio_balance_formatted%"
112+
113+
# Group-based welcome
114+
group-welcome: "Hello %serviceio_prefix%%player_name%! You belong to: %serviceio_groups%"
70115
```
71116
72117
## Troubleshooting

0 commit comments

Comments
 (0)