Integrations/Plugins

Homestead uses multiple plugins' APIs, including WorldGuard, WorldEdit, PlaceholderAPI, dynmap, BlueMap, Pl3xMap, Squaremap, and Vault.

WorldGuard

WorldGuard is another grief prevention plugin mostly used to protect spawns, PVP arenas... etc.

To prevent players from claiming chunks inside a WorldGuard-protected area, enable this feature:

worldguard:
  protect-existing-regions: true

WorldEdit

Homestead uses a unique feature that only exists in WorldEdit, which is regenerating chunks.

To enable the feature, you must install WorldEdit and have this configuration enabled in config.yml:

worldedit:
  regenerate-chunks: false

PlaceholderAPI

PlaceholderAPI is a plugin that allows server owners to display information from various plugins in a uniform format.

Available placeholders:

  • %homestead_region_bank%: Displays the region's bank balance.

  • %homestead_region_name%: Shows the name of the region.

  • %homestead_region_current%: Shows the name of the region that the player is currently inside.

  • %homestead_region_claimed_chunks%: Indicates the total number of claimed chunks in the region.

  • %homestead_region_max_chunks%: Displays the maximum number of chunks a player can claim.

  • %homestead_region_trusted_members%: Indicates the total number of members in the region.

  • %homestead_region_max_members%: Displays the maximum number of chunks a player can claim.

  • %homestead_upkeep_amount%: Displays the required amount to pay for taxes.

  • %homestead_upkeep_at%: Shows when the region's owners must pay their taxes.

Some placeholders may display a null value. To replace the null values, edit the following default values:

placeholderapi:
  default:
    region_bank: "None" # The player's region's bank.
    region_name: "None" # The player's region's name.
    region_claimed_chunks: "0" # The player's region's claimed chunks count.
    region_max_chunks: "0" # The player's maximum chunks to claim.
    region_trusted_members: "0" # The player's region's trusted members count.
    region_max_members: "0" # The player's maximum members to add.
    region_current: "&2Wilderness" # The region where the player is currently inside.
    upkeep_amount: "0,00" # The amount that the player must pay for taxes.
    upkeep_at: "Never" # When the player must pay for taxes.

dynmap, Pl3xMap, Squaremap, and BlueMap

dynmap, Pl3xMap, Squaremap, and BlueMap are Google Maps-like plugins that show all claimed chunks in marked boxes.

Install one of these plugins, and restart the server. You should be able to see all claimed chunks via these links:

Region owners may change their regions' chunks' color via the command /region set mapcolor [color].

The colors set in config.yml are the default colors for the chunks.

dynamic-maps:
  # Enable this feature? "true" to enable, "false" to disable.
  enabled: true

  # The interval to update the regions on the web, use seconds.
  update-interval: 60 # 60 seconds (1 minute)

  # The icons for regions.
  # NOTE: ".png"s are the only supported image format.
  icons:
    # Enable this feature? "true" to enable, "false" to disable.
    # NOTE: If you enable icons, players can set custom icons for their regions.
    enabled: true

    # The default icon.
    default: ...

    # The size for icons, must be a valid integer.
    size: 20 # 20x20

    # The list of icons that players can use. You can add as many icons as you want!
    list: ...
  
  # Customization; HTML syntax is supported!
  # Available variables:
  # - {region}: The region that owns the chunk
  # - {region-owner}: The region's owner
  # - {region-members}: The region's members
  # - {region-chunks}: The region's claimed chunks count
  chunks:
    # For chunks that are owned by a server operator.
    operator-color: 0xFF0000 # RGB; Red, Green, Blue: 255, 0, 0
    operator-description: "<div style='font-size:16px;'><b>[Operator] {region} (#{global-rank})</b></div>{region-description}<br><br><b>Owner</b>: {region-owner}<br><b>Members</b>: {region-members}<br><b>Chunks</b>: {region-chunks}<br><b>Size</b>: {region-size} blocks"

    # For chunks that are owned by ordinary players (non operators).
    color: 0x00FF00 # RGB; Red, Green, Blue: 0, 255, 0
    description: "<div style='font-size:16px;'><b>{region} (#{global-rank})</b></div>{region-description}<br><br><b>Owner</b>: {region-owner}<br><b>Members</b>: {region-members}<br><b>Chunks</b>: {region-chunks}<br><b>Size</b>: {region-size} blocks"

Last updated