Placeholders
| Module info | |
|---|---|
| Configuration | settings.storage-placeholders-update-timeout in config.yml[?] |
| Manager | PlaceholderManager |
| Support | 1.8+ |
| Free version | ? |
| Proxy-configurable | ? |
ChatPlugin offers a lot of integrated placeholders which can be used in the plugin's and in other plugins' messages using PlaceholderAPI or MVdWPlaceholderAPI; see the Integrations page to know how to use these two plugins.
There are four types of placeholders which can be specified for basically every message (example: check tablists.settings.placeholder-types in tablists.yml). You can select just the types you need to replace just certain placeholders and save resources:
JUST_NAME: it contains only the{player}placeholder which indicates a player's name.PLAYER: players-related placeholders (example:{prefix},{ip_address},{ping}...)SERVER: represents server-related placeholders (example:{online},{date},{uptime}...)INTEGRATIONS: other plugins' placeholders hooked natively; see Modules/Integrations
NOTE
Every placeholder specified in the plugin's messages must be enclosed in {}; the ones specified through PlaceholderAPI use %% instead (example: %ping%).
Player placeholders
Misc
player: player's nameuuid: player's UUIDdisplay_name: player's display nameip_address: player's IPv4 addresshealth: player's health, integermax_health: player's max health, integer (ex.: 20)food: player's food level, integer (max: 20)level: player's experience level, integerxp: player's experience amount, integergamemode: player's gamemode (ex.: adventure)language_id: player's language's IDlanguage_display_name: player's language's display namelocale: player's locale in the client's settings (ex.: en_US)version: player's version (ex.: 1.19.4)version_protocol: player's version's protocol, integer (ex. 762)client_edition: client's edition (Java/Bedrock)last_login: last login time (ex.: 1 hour, 36 minutes)time_played: time played on current serveremojis_tone: player's emojis' tone, color (ex. #C6956C)world: player's world's nameonline_world: online players excluding vanished ones in current worldvanished_world: vanished players in current world
Ping
ping: ping in milliseconds, integerping_format: ping formatted with colorping_quality_color: ping's quality's colorping_quality_text: ping's quality's text
Storage stats
player_id: player's ID in the storage, integerplayer_bans: player's bans in the storageplayer_warnings: player's warnings in the storageplayer_kicks: player's kicks in the storageplayer_mutes: player's mutes in the storagemessages_sent: player's messages sent in the storageplayer_anticheat_bans: player's anticheat bans in the storageplayer_anticheat_warnings: player's anticheat warnings in the storageplayer_anticheat_kicks: player's anticheat kicks in the storageplayer_anticheat_mutes: player's anticheat mutes in the storage
Location
x: player's X coordinate, integery: player's Y coordinate, integerz: player's Z coordinate, integeryaw: player's head's yaw, float (ex.: 90.0)pitch: player's head's pitch, float
Rank
rank_id: player's rank's IDrank_display_name: player's rank's display nameprefix: player's rank's prefixsuffix: player's rank's suffixtag_prefix: player's rank's tag's prefixtag_suffix: player's rank's tag's suffixtag_name_color: player's rank's tag's name color (ex.: &e&l)chat_color: player's rank's chat colorrank_position: player's rank's position in ranks' listrank_description: player's rank's descriptionmax_ban_duration: player's rank's max/tempbandurationmax_mute_duration: player's rank's max/muteduration
IP lookup
ip_address: lookup's IPv4 addressisp: lookup's Internet Service Providercontinent: lookup's continentcountry: lookup's countrysubdivisions: geo-subdivisions (ex.: France's depts.)city: city; may be null: "unknown location"country_code: country code; may be null: "unknown country code"inside_eu: whether the IP is inside EUtime_zone: lookup's time zonepostal_code: postal code; may be null: "unknown postal code"latitude: lookup's latitude coordinate (ex.: 23.834)longitude: lookup's longitude coordinateaccuracy_radius_km: accuracy radius in kilometersaccuracy_radius_mi: accuracy radius in milesaccuracy_radius_nm: accuracy radius in nautical miles 😆relative_date_full: lookup's relative full date (format @misc.simple-date-format.full)relative_date_day: lookup's relative day-only date (format @misc.simple-date-format.day)relative_date_hour: lookup's relative hour-only date (format @misc.simple-date-format.hour)
Server placeholders
Misc
online: local online players excluding vanished onesonline@server-id: online players in the specified serveronline_total: global online players (proxy's total)max_players: max players amountvanished: vanished players amountvanished@server-id: vanished players in the specified serverdate_full: full date (format @misc.simple-date-format.full)date_day: day-only date (format @misc.simple-date-format.day)date_hour: hour-only date (format @misc.simple-date-format.hour)enabled_worlds: enabled worlds amount (in config.yml)enabled_players: enabled/loaded players amountenabled_managers: enabled/loaded managers amountstartup_time: plugin's startup time in millisecondslast_reload_time: plugin's last reload's time in millisecondsuptime: server's uptime (ex.: 5 hour, 29 minutes)random_color: random color, hex codes on 1.16+
Version
plugin_version: ChatPlugin version (ex.: 1.3.0)server_version: current Spigot version (ex.: 1.14.4)server_version_protocol: Spigot version's protocol (ex.: 498)server_nms_version: current NMS version; Bukkit only (ex.: v1_14_R3)server_java_version: Java version (ex.: 11.1.0)
Settings
server_id: server's ID @multi-instance-mode.server-idin config.ymlserver_display_name: server's display name @multi-instance-mode.server-display-namemain_language_id: server's main language's ID @languages.main-language-idmain_language_display_name: server's main language's display name
Storage stats
total_players: total players in the storage, integertotal_bans: total bans in the storagetotal_warnings: total warnings in the storagetotal_kicks: total kicks in the storagetotal_mutes: total mutes in the storagetotal_staff_bans: total bans by Staff members in the storagetotal_staff_warnings: total warnings by Staff members in the storagetotal_staff_kicks: total kicks by Staff members in the storagetotal_staff_mutes: total mutes by Staff members in the storagetotal_anticheat_bans: total bans by the anticheat in the storagetotal_anticheat_warnings: total warnings by the anticheat in the storagetotal_anticheat_kicks: total kicks by the anticheat in the storagetotal_anticheat_mutes: total mutes by the anticheat in the storage
Memory & storage
max_memory: max RAM the JVM will attempt to usetotal_memory: allocated RAM for the serverused_memory: currently used RAM (total - free)free_memory: available RAM amounttotal_storage: SSD/HDD max capacity in GB (ex.: 240.0)used_storage: used storage amount in GBfree_storage: free storage amount in GBunallocated_storage: unallocated storage amount in GB
RAM-related placeholders' format can be customized at settings.displayed-memory in config.yml.
TPS
tps_1_min: last minute's TPS (ex.: 19.95)tps_5_min: last 5 minutes' TPStps_15_min: last 15 minutes' TPStps_1_min_format: last minute's TPS formatted with colortps_5_min_format: last 5 minutes' TPS formatted with colortps_15_min_format: last 15 minutes' TPS formatted with color
MSPT
mspt_5_sec_avg: last 5 seconds' average MSPT (ex.: 2.37)mspt_5_sec_min: last 5 seconds' minimum MSPTmspt_5_sec_max: last 5 seconds' maximum MSPTmspt_10_sec_avg: last 10 seconds' average MSPTmspt_10_sec_min: last 10 seconds' minimum MSPTmspt_10_sec_max: last 10 seconds' maximum MSPTmspt_1_min_avg: last minute's average MSPTmspt_1_min_min: last minute's minimum MSPTmspt_1_min_max: last minute's maximum MSPTmspt_5_sec_avg_format: last 5 seconds' average MSPT formatted with colormspt_5_sec_min_format: last 5 seconds' minimum MSPT formatted with colormspt_5_sec_max_format: last 5 seconds' maximum MSPT formatted with colormspt_10_sec_avg_format: last 10 seconds' average MSPT formatted with colormspt_10_sec_min_format: last 10 seconds' minimum MSPT formatted with colormspt_10_sec_max_format: last 10 seconds' maximum MSPT formatted with colormspt_1_min_avg_format: last minute's average MSPT formatted with colormspt_1_min_min_format: last minute's minimum MSPT formatted with colormspt_1_min_max_format: last minute's maximum MSPT formatted with color
System
server_os_name: current OS' name (ex.: Linux)server_os_arch: current OS' architecture (ex.: amd64)server_os_version: current OS' version (ex.: 10.0)cpu_threads: CPU's threads (multiple of the cores if using HT/SMT)active_threads: active threads amount, integer
Discord integration
discord_punishments_channel_id: punishments' channel's ID @settings.channels-ids.punishmentsin discord-integration.ymldiscord_staff_notifications_channel_id: punishments' channel's ID @settings.channels-ids.staff-notifications
Integrations placeholders
ViaVersion/ProtocolSupport
When installed, these integrations translate the version and version_protocol player placeholders described above. However, it is not necessary to include INTEGRATIONS in the placeholder types to translate those.
Essentials(X)/Vault
balance: player's balance (ex.: 1.25K)
The balance placeholder's decimals can be customized at settings.balance-placeholder.decimals in config.yml.
ChatPlugin — A feature-rich and modular chat ecosystem, lightweight and efficient by design.
This wiki is currently updated to version 1.10.4.
© 2025 Remigio07
Please report any mistakes and misspellings as described at Home/Reporting issues.
