Installation - CryptoMorin/KingdomsX GitHub Wiki
Installing the plugin is quite easy. It's the same as any other plugin. Simply just put the downloaded file inside your plugins folder. Your plugins folder should be in the same folder where your server JAR file and other files like eula.txt, ops.json, bukkit.yml, logs and etc are. If you don't see the folder or any of those files, run the server once and it should generate the files.
Note
If you put the plugin's file while the server is running, you need to restart the server for it to become enabled. Force enabling the plugin with PlugMan or any other plugin loader will cause issues.
While the plugin doesn't have any dependencies that you need to download manually, it does need internet connection for the first time you run the plugin. It also needs internet connection for additional optional content.
- Java - 1.8 or above.
- 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.2or1.14.3. It only supports1.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 (or most likely not function at all) on Forge+Bukkit, Java+Bedrock server softwares or any other kind of software that adds cross-platform support like these (specially Magma, Mohist and GeyserMC which are extremely incompatible.)
-
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.
- Internet Connection:
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. All core features of the plugin are included in the main JAR. It does support a few other plugins, but these are merely for compatibility and don't directly make any new features available for Kingdoms plugin itself.
The plugin, however, has a few official addons which add extra features to it. Refer to the Addons page for more info.
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.
The files in the plugin's libs folder, some of these libraries are required for the plugin to function and others are optional.
To avoid Spigot's file upload limit, they're not included with the plugin. Also, it helps by not downloading
useless content that are not required by certain configurations
You can delete the files, but if you're going to do that, delete all of them. The plugin will download them all back again.
You can move these files when you're moving kingdoms folder, they'll continue to work correctly.
Caution
NEVER use /reload command or PlugMan with KingdomsX installed.