Installation - Minecraft-Maxmc/KingdomsX-ChineseTranslation GitHub Wiki

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

However you have to have the basic requirements a Spigot plugin needs.

  • Java 8, 11 or 16 - 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 obviously need JDK16 for 1.17
  • Minecraft Version - The plugin is compatible for 1.9-1.16 note that you'll get all the plugin features only on the latest Minecraft version.
  • Spigot - Your server must be a Spigot 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.

Setup

Kingdoms default config and settings are designed in a way that most owners prefer. All the needed permissions are given by default that you can remove them too. The plugin is pretty much just Plug and Play.
Each config option is explained in its file, join the discord server if you have any questions.

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.

Uninstallation

Kingdoms plugin can be removed from your server safely, however 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 just want to do a simple reset for players to start over again, other than resetting world and inventories, you just need to remove the Players, Kingdoms, Nations and Lands folders in the plugin folder.

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
  • DiscordSRV: Sends private chat channels messages (such as kingdoms and allies chat) to a specific channel and sends global chat to another channel.
  • 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
  • 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.