Installation

System Requirements

Installing the plugin is quite easy. It's the same as any other plugin. It doesn't need internet access or any other (hard) dependencies.

• Java - It'd be better if you use the JDK. If your host uses the JRE instead of JDK, conditional GUIs will not work. If you use Java 11 you're definitely using the JDK, because there is no JRE for Java 11. You'll need the latest Java version for versions 1.17+
• Minecraft Edition: This plugin is only compatible with Minecraft Java Edition the plugin will/can't make no attempt to support other editions that are linked by other softwares.
• Server Version - The plugin is compatible with 1.9+ up to the latest version that is supported is on the Spigot page, but only for the latest server version of that minor update. For example, the plugin doesn't support 1.14, 1.14.1, 1.14.2 and 1.14.3 It only supports 1.14.4 which is the latest (patch) version of 1.14 minor version. You'll get all the plugin features only on the latest Minecraft version that the plugin supports.
• Software - Your server must be a Spigot or Paper server. The plugin will not work on Bukkit, however it should work on Paper or any other Spigot forks. If it doesn't, it's a bug with that fork, not the plugin. Note that it might not function properly on Forge+Bukkit server softwares (specially Magma and Mohist which are extremely buggy)
• Hardware: Kingdoms tend to sacrifice memory for performance, so you need at least 1GB for a medium-sized server (around ~100 players).
  The only resource-intense system that kingdoms has is turrets. The plugin tries its best to make turrets as fast as possible, however due to the single-threaded nature of Minecraft Java edition, it has its own limitations for old/low-budget CPUs.
  Note: These numbers are just estimates and they're given regardless of your server version and other plugins.
• Clients: The plugin is supposed to work with all modded clients, but if for some reason, somehow, the plugin didn't work on modded clients, but it did work on the official non-modded client, you'll have to report this issue to the client devs.

Setup

Kingdoms default settings are designed in a way that most owners would prefer. All the needed permissions are given by default that you can remove as well.
The plugin is pretty much just Plug and Play for the latest Minecraft version. It might need a few tweaks for older versions as not all features are available in older versions. Not doing so can even result in errors.
Each config option is explained in its file, join the discord server if you have any questions.

Note that kingdoms does not have any dependencies or any official add-ons. All the features in the plugin are included in the main JAR. It does support a few other plugins, but these are merely for compatibility and doesn't directly make any new features available for Kingdoms plugin itself.

It is important to disable certain features that you want to disable before publishing your server since disabling them after the plugin started to save players data can cause errors or even data corruptions.
One example is that you can't disable a structure/turret type (or more technically referred to as a "style") since they're already placed and removing them doesn't remove the block or hologram from the world and the plugin will start yelling at you because it doesn't know how to handle them.

Reloading

NEVER use /reload command or PlugMan
For 90% of the changes in the configs, you do not need to do anything. Yes, you heard that right. The plugin will automatically reload the specific file that you made changes too.
However some complicated changes might need a plugin reload (/k reload) or even a server restart.
Almost 99% of the features can be reloaded properly using /k reload command.
Please note that the automatic reload performance is much better than the command as the command reloads everything. There is no reason to use the command unless the changes aren't applied.
These automatic reloads can take up to 5 seconds until it detects the changes.
If an option requires a restart to change, it's commented above them.

Updating

If you're upgrading Minecraft versions, that's totally fine, however you can't downgrade Minecraft versions, it'll corrupt your world. Updating plugin versions should be fine as well. If anything breaks, you can still use the backups provided.
New language options will be added automatically to your language file, for other configs, if the option is missing it'll use the default option in the plugin. However that's not the same for GUIs as they're 100% customizable.

You could however update your config manually by checking the version history of configs or you could also use a file difference checker tool such as diffchecker to compare your config to the latest version. There are plans to automate this process.

Uninstallation

Kingdoms plugin can't be removed from your server safely if structures or turrets are used. The turret and structure blocks and holograms will stay in the world.
So if you're planning to remove Kingdoms, be prepared to reset your world and player inventories.

If you for some reasons dismissed this warning or wanted to reuse the same world, you have to remove all structures and turrets one by one and remove their hologram by standing near them and using /k admin hologram command. For example /k admin hologram 5

Compatibility

Only compatible with the latest version of the plugins mentioned below (except WorldGuard that supports v6 and v7+):

• WorldGuard: Disallow claiming in regions. Supports 16*255*16 chunk cuboid check. It's also used for other minor stuff such as land indicators in a WorldGuard region and used for Outpost regions. The only difference between v6 and v7 support is that v7 support is extremely more optimized (from kingdoms plugin side) than v6 Also, the v7 support adds a flag called claimable that treats a chunk in a protected region as wilderness.
• DiscordSRV: Sends private chat channels messages (such as kingdoms and allies chat) to a specific channel and sends global chat to another channel. Also used for announcements such as invasions.
• Citizens: Stops turrets from shooting NPCs.
• MyPet: Stops turrets from shooting friendly pets.
• Vault: For taxes and economy like Kingdoms and Nations bank. It's also used for some prices like claiming a land. Don't forget that you need to have an economy plugin (like Essentials) for this to work.
• AuthMe: Checking for online kingdom members limit before invading. (The enemy members can join as one of the invaded kingdom members without logging in)
• LuckPerms: Context support for current land territory. Self, allies, truces, enemies and nations. The context name is territory
• BlueMap & Dynmap: Map markers and icons. Every kingdom can set their own flag and marker color from nexus settings.
• MythicMobs: Support for kingdoms champion.
• PlaceholderAPI & MVdWPlaceholderAPI: For plugin placeholders, they also support short, fancy and relational placeholders.
• Regionerator Technically Regionerator is the plugin that's supposed to support Kingdoms, however the developer doesn't want to do that. Stops the plugin from deleting chunks that are claimed.