Skip to main content

Quarters Plugin Guide

Overview

The Quarters plugin allows players to claim and manage private areas within towns. These areas, known as quarters, can be used for various purposes like building, setting spawn points, or customizing private spaces. Below is a detailed guide on how to create and manage quarters, including the essential commands and permissions required.


Creating a Quarter

To create a quarter, you must first define the boundaries using a wand item, which can be obtained using the /q wand command. The default item for the wand is Flint.

If the wand is unavailable, you can manually set positions using the following commands:

  • /q pos one [x] [y] [z] — Set the first position.
  • /q pos two [x] [y] [z] — Set the second position.

You can also omit the coordinates, and the positions will be set relative to your current location.

Steps to Create a Quarter:

  1. Select the Boundaries:

    • Use the wand to click on two opposing corners: left-click for the first corner and right-click for the second corner.
    • Make sure the area is within a single town and does not overlap with wilderness or other quarters.
  2. Highlight Selection:

    • The area you selected should be highlighted with particles. If the particles are not visible, adjust your selection.
  3. Add to Selection:

    • Type /q selection add to add the selected area to your current cuboids. Alternatively, use /q create to create a quarter immediately with your current selection.
  4. Remove or Adjust Selections:

    • Use /q selection remove to remove a cuboid from the selection.
    • /q selection clear will clear all selections made.
    • You can also copy and paste selections using /q selection copy and /q selection paste.
  5. Finalize Creation:

    • Once the area is selected and adjusted, type /q create to finalize the creation of your quarter.

Restrictions and Limits

While creating quarters, there may be server-imposed restrictions, such as:

  • Maximum number of cuboids per quarter.
  • Maximum number of quarters per town.
  • Maximum block volume per cuboid.

The plugin will notify you if any limits are exceeded.


Commands & Permissions

Standard Commands

CommandDescriptionPermission
/q claimClaim a quarter as your own.quarters.command.quarters.claim
/q createCreate a quarter based on your current selection.quarters.command.quarters.create
/q deleteDelete the quarter you're standing in.quarters.command.quarters.delete
/q delete allDelete all quarters in your town.quarters.command.quarters.delete
/q delete plotDelete all quarters in your current plot.quarters.command.quarters.delete
/q editEdit the cuboids within an existing quarter.quarters.command.quarters.edit
/q edit addselectionAdd selections to the current quarter.quarters.command.quarters.edit
/q edit removeRemove a cuboid from the quarter.quarters.command.quarters.edit
/q evictEvict the owner of a quarter.quarters.command.quarters.evict
/q infoView plugin info.quarters.command.quarters.info

Managing Selections

CommandDescription
/q selection addAdd a cuboid to your selection.
/q selection clearClear your selection.
/q selection copyCopy your selection to clipboard.
/q selection pastePaste your selection from the clipboard.

Quarter Settings

CommandDescription
/q set nameChange the name of a quarter.
/q set colourChange the colour of a quarter.
/q set anchorSet the "anchor" for internal distance measurements.
/q set particlesizeChange the particle size for quarter outlines.

Toggle Features

CommandDescription
/q toggle constantoutlinesToggle whether quarter outlines are always shown.
/q toggle entrynotificationsToggle notifications when entering a quarter.
/q toggle sellondeleteAutomatically sell the quarter when its owner is deleted.

Quarter Types

There are different types of quarters, each with specific features:

Apartment

  • The default quarter type. Owners can set trusted users, and both the owner and trusted players can alter the quarter.

Inn

  • Players can use beds inside the inn to set their spawn point. You can extend this functionality to players outside the town by toggling embassy mode.

Station

  • The station quarter type allows players to place, destroy, and use boats and minecarts. This can also be extended to non-town residents by toggling embassy mode.

Permissions

Here are the key permissions related to quarters:

PermissionDescription
quarters.wandAllows the use of the wand item to select positions for quarters.
quarters.landlordAllows town staff to perform actions like changing the name or color of quarters.
quarters.landlord.receive_command_feedback_from_town_membersAllows town staff to receive command feedback from town members.

Common Permission Settings

SettingDescription
TrueThe permission is granted to all players.
FalseThe permission is restricted to town staff (e.g., mayors, assistants).
True (with an asterisk)*The permission is granted to all players but will only work if they own the quarter or have permission in the town.