Updated for version 0.12.1

Konquest Setup Guide

This page outlines the steps necessary to use Konquest on a Spigot or Paper server. You should have completed the first-time installation steps on the Home page, and included Vault and your desired economy plugin on your server. This guide will continue assuming the default core.yml configuration file.

The overall steps for setup are:

1. Create a sanctuary territory
2. Claim land for the sanctuary
3. Build a monument structure within the sanctuary
4. Create the monument template
5. Save & repeat as desired

Allowed worlds

By default, all worlds are allowed to have kingdoms except for those worlds listed in the world blacklist. This list is specified in the core.yml config option core.world_blacklist. When core.world_blacklist_reverse is set to false, world names in the list cannot contain kingdoms or towns. Else, if core.world_blacklist_reverse is true, then only the world names in the list can contain kingdoms and towns. Note that these worlds can still contain Sanctuaries, Monument Templates, and Ruins.

core:
  world_blacklist:
  - world_nether
  - world_the_end
  - example_world_name
  world_blacklist_reverse: false

Ignored Worlds

There is another list of world names in the core configuration, core.world_ignorelist, which will disable all Konquest features in those worlds. Use this list to include the names of worlds that you don't want players to use most Konquest commands in, like settling towns, creating barbarian camps, or travelling. By default, the list is empty: core.world_ignorelist: []. Add world names using a list format to ignore them:

core.world_ignorelist:
- world_the_end
- spawn_world

1. Create a Sanctuary

• Join the server and op yourself, or give yourself the konquest.* permission, then go to a suitable location to place the sanctuary territory.
• Stand at the spot where you want the sanctuary to be centered, and type /k admin sanctuary create (name).

• The chunk you're standing in will be claimed for the new sanctuary, and you should see particles on the ground showing where the border is.

• You can optionally edit the property flags of the sanctuary by using the command "/k admin flag (name)".

• In order to ignore all Konquest protections, type /k admin bypass to enter Admin Bypass Mode. When you're finished setting up, type this command again to disable it.

2. Claim Land

• While standing in the single claimed chunk, type /k map to view the text map of your surrounding chunks. You are the arrow in the center, and it points in the appropriate cardinal direction of the world. Different territory types show different symbols, as well as colors based on kingdom relationships.

• Next, type /k admin claim radius (value) to claim an area of land around your current location.

• Use the map command again to see the increase in claimed area.

3. Build a Monument Structure

• Find an area within the sanctuary to create a 16x16 block area of land. This will be the base for the monument structure. It does not need to be aligned with chunk boundaries.

• Build the monument structure on the plot. It must contain at least 12 obsidian blocks (configurable in core.yml), and may optionally include chests. See the Monument Template guide for more details and tips. Some guidelines for building monuments:
  • Separate the spawn area from the critical block area. Players will teleport into the monument when there's a raid, and you don't want defenders spawning on top of attackers trying to break the critical blocks. Either split the area in half, like in the example image, or build multiple levels with the spawn area above the critical block area.
  • Provide multiple entry points to the critical block area. You don't want to make it too difficult for the attackers.
  • Keep in mind that attackers can break any monument block, but defenders cannot. Neither group can place blocks.

• In the example images, the structure uses half of the area for the spawn (bedrock block) and includes two single-chests as loot chests. Inside of the structure in the other half of the plot are 12 critical (obsidian) blocks.

4. Create a Monument Template

• Once the structure is built, place a block in an upper corner of the plot. This will be used to help define the template region. In the example images, these are the gold blocks.
• Type /k admin monument (name) create to begin creating the monument template.

• Left-Click on the lower corner opposite of the upper corner block. Particles will display the cuboid region based on your movement. They are colored orange when a dimension is too short, and red when too long. Green means just right.

• Move to the upper corner block and look at it. The particles should turn green.

• If the particles are not green, then adjust your mouse or click on air to cancel and re-adjust the upper corner block.

• When the particles are green, Left-Click on the upper corner block. The particles should now be stuck in place.

• Left-Click on the block for the travel/spawn point of the monument. In the example image, the bedrock block in the grass is the travel point.

• Monument template setup is now complete!
• You may edit the blocks within the monument template region if you want to change the monument, without re-creating the region. All town monuments will update to the current monument template when its chunk loads, or after a server restart. Only re-create the region if you need to change its height for a taller monument, or if you move the physical structure of the monument template in the world.
• When editing a monument template, it becomes unavailable and broadcasts a message. The example image shows the broadcast when the corner gold blocks are removed.

• Viewing the kingdom templates menu (/k kingdom templates) shows that the monument template is temporarily unavailable while being edited.

• After 60 seconds, the template becomes available again.

5. Save & Repeat

• After successfully creating a new monument template, save to file by typing /k admin save. Players may now create kingdoms using this template.
• To double-check a monument template location, type /k admin monument show (name) to display the particle box around a valid template for a short duration of time.
• You can also use /k admin monument status (name) to print details about a monument template.
• Repeat these steps for every monument template that you want to include in your server. They can all be in a single sanctuary, or you can create multiple sanctuaries. Each monument template can have a unique amount of critical blocks, loot chests, favor cost, and structural complexity. Players can then choose which template to use for their kingdoms.

Final Setup

Once you've created some sanctuaries with monument templates, you can continue building within the sanctuary and use the territory as a server spawn area. You can control which Konquest protections are enabled in each sanctuary by using the /k admin flag command.

• Use /k admin flag (name) to list all of the property flags of a sanctuary.
• Use /k admin flag (name) (flag) true/false to set a flag.
• To set the travel point of a sanctuary, use /k admin settravel.