Integrations

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

Warning: When installing an external plugin, make sure the API version is the same as Homestead API version. For example, do not use Squaremap based on the 1.19.x API while you are using Homestead based on the 1.21.x API.

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:

protect-worldguard-regions: true

WorldEdit

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

Caution: This feature may have bugs, and it's not recommended to keep it enabled when your server has very active players. It takes a lot of memory when regenerating chunks, especially when a player or operator deletes a region with over 10 claimed chunks.

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

regenerate-chunk-after-unclaim: true

PlaceholderAPI

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

There is no need to use /papi ecloud download Homestead, Homestead automatically registers the placeholders on startup.

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_taxes_amount%: Displays the required amount to pay for taxes.

• %homestead_taxes_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-values:
  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's name that the player is currently in.
  taxes_amount: "0,00" # The amount that the player must pay for taxes.
  taxes_at: "Never" # When the player must pay for taxes.

dynmap, Pl3xMap, and Squaremap

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

dynmap-config:
  enabled: true # Enable or disable dynmap integration.

  operator-chunk-color: 0xFF0000 # The chunk's color. RGB; Red, Green, Blue: 255, 0, 0
  operator-chunk-description: "<div style='font-size:16px;'><b>[Operator] {region}</b></div><br><b>Owner</b>: {region-owner}<br><b>Members</b>: {region-members}<br><b>Chunks</b>: {region-chunks}" # The chunk's information (supports HTML syntax)

  chunk-color: 0x00FF00 # The chunk's color. RGB; Red, Green, Blue: 0, 255, 0
  chunk-description: "<div style='font-size:16px;'><b>{region}</b></div><br><b>Owner</b>: {region-owner}<br><b>Members</b>: {region-members}<br><b>Chunks</b>: {region-chunks}" # The chunk's information (supports HTML syntax)
  
pl3xmap-config:
  ... # Same configuration as dynmap
  
squaremap-config:
  ... # Same configuration as dynmap

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

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

BlueMap

Same as dynmap, Pl3xMap, and Squaremap, but it shows the region's spawn locations instead of claimed chunks.

bluemap-config:
  enabled: true # Enable or disable BlueMap integration.