Skip to content

Compatibility

Matej edited this page Sep 19, 2024 · 7 revisions

Protect is developed with stability and performance in mind. Instead of hiding poor code behind async, we optimized the code at the base. Protect aims to support a vast range of Minecraft versions including legacy versions.

Incompatibilities

  • Protect is compatible with per-world inventory plugins because it waits until they have refreshed the player's inventory before scanning it.
  • Protect is compatible with custom GUIs as it ignores non-vanilla inventory titles by default and lets you ignore container types or custom inventories by name manually too.

Custom Item/Enchants Plugins

  • 1.16+: Protect ignores items containing any custom persistent metadata keys, which are typically only added by plugins. Ask your developer to add a persistent metadata tag to the custom item. This can be disabled in Ignore.Custom_Persistent_Tags key in settings.yml.
  • 1.14+: Protect ignores items having custom model data. This can be disabled in Ignore.Custom_Model_Data key in settings.yml.
  • 1.8.8+: You can also use "ignore tag" operator in your checks which will ignore items containing the given custom NBT tag at the root level. Developers can use open source libraries such as NBT-API to add a custom persistent tag to an ItemStack.
  • Additionally, we routinely test Protect with popular plugins such as ExcellentEnchants to ensure they are compatible. In general, if a custom enchants plugin uses proper API methods, Bukkit will recognize the enchant correctly and we won't confiscate it.
  • However, we are happy to work with you if Protect confiscates a custom item and navigate you on adding an exclusion, just open a ticket! Please make a backup before installing Protect if you have a heavily modified server.

Java Version

Java 8 or greater.

Database (Optional)

Database is supported with customizable driver for SQLite, MySQL, MariaDB and others. If you decide to use MySQL or MariaDB - your database need to support the "utf8mb4" charset (use utf8mb4_unicode_520_ci) otherwise it can not work with non-English item names.

Plugin Dependencies

Optional plugins:

  • To fine a player, you need Vault and an economy plugin.
  • For network features, install ChatControl Red. Then, if you're on BungeeCord, install BungeeControl Red or VelocityControl for Velocity. We understand these are premium plugins so we are preparing a free simple addon instead.

Supported plugins:

  • BlueShop
  • ChestShop
  • ExcellentShop
  • ShopGUI
  • Shop
  • SignShop
  • EconomyShopGUI
  • QuickShop
  • more plugins you suggest!

Minecraft Server

Server Distribution Compatibility
Paper Officially tested and supported.
Folia Beta support for core features only.
Spigot, Purpur, UniverseSpigot, PandaSpigot, JesusSpigot, and others Should work, untested. Protect accesses minimum NMS and has several safety mechanisms to prevent data loss. We recommend you watch your server logs for errors for 1-2 days. When having issues, always test on Paper first before opening a ticket to save our time. We don't have the capacity to test our software on dozens of forks.
Craftbukkit Supported for Minecraft <1.16. For newer versions, use Paper.
Thermos/Cauldron 1.7.10 Partial support for core features.

Minecraft Version

You can run Protect on the following Minecraft versions below. Please note that the x stands for any sub-version, for example, 1.20 or 1.20.5.

Many issues are often caused by incompatible other plugins such as ProtocolLib and not by your Minecraft version. Make sure all dependencies are up-to-date. We reserve the right to close tickets with startup log with errors from other plugins since they might interfere.

Minecraft Version Compatibility
1.21.x Native.
1.20.x Native.
1.19.x Native.
1.18.x Native.
1.17.x Native.
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.
1.8.8 Native.
1.7.10 BungeeChatAPI required.
Clone this wiki locally