Skip to content
This repository has been archived by the owner on Nov 22, 2023. It is now read-only.

Compatibility

Matej Pacan edited this page Dec 21, 2020 · 27 revisions

ChatControl Pro is developed with stability and performance in mind. It has been optimized since 2013 to run as efficiently and flawlessly as possible. I aim to provide compatibility for as many systems as possible while keeping the plugin clean and easy to maintain.

Plugins

You may install the following plugins alongside ChatControl. ChatControl automatically detects them on server launch and will offer extra features available from them.

When updating ChatControl, please also check if your dependencies are up-to-date. I do my best to make sure ChatControl runs fine, but I can't control other plugins if they are bugged.

  • BungeeControl for ChatControl functions on BungeeCord. Simply install BungeeControl from the ZIP to your BungeeCord network.
  • AuthMe for {country_name} and {country_code} variables in chat formatter and join/kick/quit messages.
  • DiscordSRV for Discord integration.
  • Essentials or EssentialsX for detecting AFK players and {nick} variable.
  • Factions MCore, FactionsUUID for {faction} placeholder. Use PlaceholderAPI for more placeholders. PS: If you are experiencing issues with chat formatter or checker, set Listener_Priority.Checker to LOWEST in settings.yml.
  • MVdWPlaceholderAPI for third party placeholders. There is no warranty on their functionality.
  • Multiverse-Core for colored world alias in chat formatter.
  • Nametags for players' prefixes (with {nametags_prefix}) and suffixes (with {nametags_suffix}). - Plugin outdated. Use your permission plugin's prefix placeholders or use ChatControl's prefix system.
  • Nicky for getting the player's {nick} - Plugin outdated. Use the placeholders {player_name} or {player_displayname} instead.
  • PlaceholderAPI for third party placeholders. There is no warranty on their functionality. Please use {variable} syntax, and not %variable% syntax!
  • ProtocolLib for packet rules (see rules/packet.txt) and preventing tab complete.
  • Towny for {nation} and {town} variables in chat formatter.
  • Vault to use players' prefixes and suffixes in chat formatter, and taking money with "then fine" operator in rules.

Variants of Bukkit

There are many variants of Bukkit which all do slightly different things that sometimes may be unexpected. Please view the list below to see if your version is compatible.

For specific Minecraft versions please see below.

Server Distribution Compatibility
Paper Supported, tested, recommended.
Spigot Unsupported, not recommended.
Craftbukkit Missing libraries require BungeeChatAPI. May work but unsupported.
Thermos 1.7.10 BROKEN! Unfortunately, Thermos replaces some fundamental parts of the Minecraft server and libraries we use, so ChatControl cannot function.
(K)Cauldron 1.7.10 Cauldron replaces many libraries we use and it is very outdated, if it breaks, there is nothing we can do about it. BungeeChatAPI is required.
Other derivatives (on a compatible Minecraft version). ChatControl accesses minimum server's internals and has several safety mechanisms to prevent data loss. It should work, but we recommend you watch your server logs thoroughly for a few days, just to make ensure no issues are raised.

Java Version

Java 8 or newer version is required to run the plugin correctly.

Minecraft Version

You can run ChatControl Pro on the following Minecraft versions. Please note that the x stands for any sub-version, for example, 1.13.0 or 1.13.2.

Many issues are often caused not by incompatible Minecraft version, but by incompatible ProtocolLib or other plugin ChatControl utilizes. To avoid trouble later, make sure all dependencies are running correctly.

Minecraft Version Compatibility
1.16.x Native.
1.15.x Native.
1.14.x Native.
1.13.x Native.
1.12.x Native.
1.11.x Native.
1.10.x Native.
1.9.x Native. Rules for books don't work here and below due to missing API.
1.8.x Native.
1.7.10 BungeeChatAPI may be required.
1.6.4 BungeeChatAPI required.
1.5.2 BungeeChatAPI required.
1.4.7 BungeeChatAPI required.
1.3.2 Compatible, but some features are missing.
1.2.5 Free version is compatible, Pro version is incompatible due to too many missing libraries.