Home - Rumsfield/konquest GitHub Wiki

Konquest

Official Spigot Link

Official Discord

Konquest API Javadoc

Plugin Summary

Konquest is a team-based land claiming and territory control plugin for survival Minecraft. Groups of players are organized into kingdoms, which can be created by players on the fly or by admins during server setup. A kingdom controls towns in the game world, and has a primary town that acts as the capital. Players can settle multiple towns in the world and control which kingdom members can build in town land. Towns are regions of the world that belong to a kingdom, and are composed of an area of chunks. The center chunk of every town contains a special server-spawned block structure called a Monument. If players from an enemy kingdom destroy the critical parts of the Monument, the town is captured by the attacker’s kingdom. Every kingdom and player has a score which is based on the number of towns, claimed land and economy.

Plugin concepts, configuration, commands and more details are broken out into their own wiki pages, which can be accessed in the navigation pane to the right. Next, see the Concepts page.

For frequently asked questions, see FAQ.

Versions

The latest Konquest version only supports the following Spigot/Paper versions. Other server versions have not been tested and are not guaranteed to work. Konquest is only a Spigot plugin, and is not designed to work with mods like Fabric.

Minecraft Version Works with Konquest
1.16.5 Yes
1.17.1 Yes
1.18.2 Yes
1.19.4 Yes
1.20.1 Yes
1.20.4 Yes
1.20.6 Yes
1.21.5 Yes

It is highly recommended to use Paper servers, which improve chunk load times especially in Minecraft 1.17.

Dependencies

These are other plugins that must be included on the server which Konquest relies upon. A "Hard Dependency" is a plugin that must be included, or Konquest will not work. A "Soft Dependency" is a plugin which can provide additional features to Konquest but is optional.

Hard Dependencies - You must have these!

Plugin Recommended Version
ProtocolLib Latest
Vault 1.7.3
Any economy plugin which uses Vault (like EssentialsX) Latest

Soft Dependencies - Optional add-ons

Plugin Recommended Version
QuickShop-Hikari 6.2.*
ChestShop 3.12.*
LuckPerms 5.4.*
PlaceholderAPI Latest
squaremap 1.3.*
Dynmap 3.4.*
BlueMap 2.6.*
DiscordSRV 1.27.*

First-Time Installation

  1. Download the current plugin JAR file from the Spigot resource page and place it into the server's "plugins" folder.
  2. Ensure that all hard dependencies listed above are also included in the "plugins" folder.
  3. Run the server, then stop the server. Konquest will create its default configuration files in the "plugins/Konquest" folder.
  4. Edit the core.yml and upgrades.yml configuration files to your liking. Then start the server again.
  5. Follow the Konquest Setup Guide page on how to set up your kingdoms on the server.

A Note on Server Online-Mode

Konquest has only been tested with online-mode set to TRUE. The server's online-mode setting in server.properties must not change once the Konquest plugin has been installed and players have joined the server. Konquest keeps track of players by their UUID, and the online-mode setting affects how UUIDs are provided.

  • When online-mode is set to true, a player's UUID is fetched from their Mojang account and is always the same.
  • When online-mode is set to false, a player's UUID is newly generated based on their current name. When a player changes their name, their offline UUID changes too. The offline UUID is always different than the online Mojang UUID.

When online-mode is changed after Konquest is installed and players have already joined, the data storage files become corrupted. You must then shut down the server and delete the plugins/Konquest folder. Upon server start, Konquest will create new default files.

Installing Updates

  1. Stop the server.
  2. Replace the previous Konquest JAR file in the "plugins" folder with the newer version.
  3. Run the server and then stop the server. Konquest backs up your original core.yml and other config files to include the original version in the name. The plugin also saves new core.yml and other config files with your non-default values.
  4. Edit core.yml and other configuration files to your liking if there are new settings.
  5. Start the server.

WARNING! Updating to version 0.11.0 requires extra review!

Konquest version 0.11.0 changes a lot of features and internal data related to kingdoms. Konquest will attempt to migrate old data, but some things may break! You MUST ensure that the server is still set up the way you want. It is recommended to start fresh and move/remove your plugins/Konquest folder. The following will change when you update an existing server to 0.11.0:

  1. All existing kingdoms become Admin Kingdoms with the option open = true, and no master.
  2. All existing kingdom capitals will become Sanctuaries, with their Monument Templates preserved.
  3. Every kingdom will turn its largest town (by land, then population) into its new capital.

Metrics

As of Konquest version 0.4.1, the plugin uses bStats to gather anonymous statistics about your server using open-source software. This helps provide insight into how Konquest is being used and aids in the future development of the plugin. To disable bStats metrics gathering, open the file /plugins/bStats/config.yml in your server directory and set enabled: false.

The Konquest bStats statistics page is here. Only servers using version 0.4.1 or newer will contribute to the statistics page.