Placeholders

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 name
• uuid: player's UUID
• ip_address: player's IP address
• health: player's health, integer
• max_health: player's max health, integer (ex.: 20)
• food: player's food level, integer (max: 20)
• level: player's experience level, integer
• xp: player's experience amount, integer
• gamemode: player's gamemode (ex.: adventure)
• ping: player's ping in milliseconds, integer
• ping_format: formatted ping with color
• language_id: player's language's ID
• language_display_name: player's language's display name
• locale: 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)
• last_login: last login time (ex.: 1 hour, 36 minutes)
• time_played: time played on current server
• world: player's world's name
• online_world: online players excluding vanished ones in current world
• vanished_world: vanished players in current world

Storage stats

• player_id: player's ID in the storage, integer
• player_bans: player's bans in the storage
• player_warnings: player's warnings in the storage
• player_kicks: player's kicks in the storage
• player_mutes: player's mutes in the storage
• messages_sent: player's messages sent in the storage
• player_anticheat_bans: player's anticheat bans in the storage
• player_anticheat_warnings: player's anticheat warnings in the storage
• player_anticheat_kicks: player's anticheat kicks in the storage
• player_anticheat_mutes: player's anticheat mutes in the storage

Location

• x: player's X coordinate, integer
• y: player's Y coordinate, integer
• z: player's Z coordinate, integer
• yaw: player's head's yaw, float (ex.: 90.0)
• pitch: player's head's pitch, float

Rank

• rank: player's rank's ID
• prefix: player's rank's prefix
• suffix: player's rank's suffix
• tag_prefix: player's rank's tag's prefix
• tag_suffix: player's rank's tag's suffix
• tag_color: player's rank's tag's color (ex.: &e&l)
• chat_color: player's rank's chat color
• rank_description: player's rank's description

IP lookup

• isp: player's Internet Service Provider
• continent: player's continent
• country: player's country
• subdivisions: geo-subdivisions (ex.: France's depts.)
• city: city; may be null: "unknown location"
• country_code: country code; may be null: "unknown country code"
• postal_code: postal code; may be null: "unknown postal code"
• latitude: player's latitude coordinate (ex.: 23.834)
• longitude: player's longitude coordinate
• accuracy_radius_km: accuracy radius in kilometers
• accuracy_radius_mi: accuracy radius in miles
• accuracy_radius_nm: accuracy radius in nautical miles 😆

Server placeholders

Misc

• online: local online players excluding vanished ones
• online_total: global online players (proxy's total)
• max_players: max players amount
• vanished: vanished players amount
• date_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 amount
• enabled_managers: enabled/loaded managers amount
• startup_time: plugin's startup time in milliseconds
• last_reload_time: plugin's last reload's time in milliseconds
• uptime: server's uptime (ex.: 5 hour, 29 minutes)

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-id in config.yml
• server_display_name: server's display name @ multi-instance-mode.server-display-name
• main_language_id: server's main language's ID @ languages.main-language-id
• main_language_display_name: server's main language's display name

Storage stats

• total_players: total players in the storage, integer
• total_bans: total bans in the storage
• total_warnings: total warnings in the storage
• total_kicks: total kicks in the storage
• total_mutes: total mutes in the storage
• total_staff_bans: total bans by Staff members in the storage
• total_staff_warnings: total warnings by Staff members in the storage
• total_staff_kicks: total kicks by Staff members in the storage
• total_staff_mutes: total mutes by Staff members in the storage
• total_anticheat_bans: total bans by the anticheat in the storage
• total_anticheat_warnings: total warnings by the anticheat in the storage
• total_anticheat_kicks: total kicks by the anticheat in the storage
• total_anticheat_mutes: total mutes by the anticheat in the storage

Memory & storage

• max_memory: max RAM the JVM will attempt to use
• total_memory: allocated RAM for the server
• used_memory: currently used RAM (total - free)
• free_memory: available RAM amount
• total_storage: SSD/HDD max capacity in GB (ex.: 240.0)
• used_storage: used storage amount in GB
• free_storage: free storage amount in GB

RAM-related placeholders' format can be customized at settings.displayed-memory in config.yml.

TPS

• tps_1_min: last 1 minute's average TPS (ex.: 19.95)
• tps_5_min: last 5 minutes' average TPS
• tps_15_min: last 15 minutes' average TPS
• tps_1_min_format: formatted last 1m TPS with color
• tps_5_min_format: formatted last 5m TPS with color
• tps_15_min_format: formatted last 15m TPS 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 (usually 2x 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.punishments in discord-integration.yml
• discord_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 complete yet lightweight plugin which handles just too many features!
© 2024  Remigio07

This wiki is currently updated to version 1.9.4.
Please report any errors, mistakes and misspellings as described at Home/Reporting issues.