Skip to content

About

A chunk-based land claiming plugin for Minecraft 26.1 and later

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

 
 

Repository files navigation

Spiget Downloads Modrinth Downloads Hangar Downloads GitHub Issues

Spiget Version Spiget Rating Static Badge Static Badge

Homestead

Homestead is an open-source land-claiming plugin for Minecraft, designed to give players full control over their land with multiple configurations and customizations.

The plugin offers more than 75 flags, allowing players to set specific permissions per player action or manipulate the environment of the land. Homestead provides the tools for a secure and customized experience for everyone.

Features

Protection & Security

  • Grief Prevention — Define fully customizable regions that block unauthorized building, theft, and PvP.
  • 12+ API Integrations — Native support for WorldGuard regions (spawn, arenas, events), PlaceholderAPI, and more.
  • 75+ Flags — Fine-grained control over interactions such as mob spawning, fire spread, crop trampling, and redstone.
  • Sub-Areas — Nest independent areas inside a parent region with their own permissions.
    • Create public market stalls inside private towns.
    • Lease hotel rooms, apartments, or shop plots.
    • Set per-member permissions for each sub-area.
  • Administrative Tools — Staff can moderate any region without interfering with player ownership.

Navigation & Visualization

  • Region Teleportation — Travel to any region instantly with a single command.
  • Live Map Support — Regions are rendered in real time on web maps.
    • Compatible with Dynmap, Pl3xMap, BlueMap, and Squaremap.
    • Players can set custom region colors and icons directly on the map.

Economy & Management

  • GUI Management — Rename regions, manage flags, control members, and adjust settings through menus — no commands required.
  • Regional Analytics — View member activity, transaction history, and region statistics in real time.
  • Region Bank — Deposit and withdraw funds tied to a region directly.
  • Region Market
    • Leasing — Rent land for configurable durations with automated payment collection.
    • Ownership Transfers — Player-to-player region sales with built-in fraud protection.
  • Leveling System — Regions earn XP over time, unlocking upgrades and rewards.
  • Reward System — Players earn rewards through activity and by adding trusted members.
  • Taxation — Weekly or monthly taxes based on member count or claimed chunks.
  • Upkeep Costs — Automatic maintenance fees that discourage abandoned or inactive claims.

Social & Community

  • Player Permissions — Assign specific rights to individual members within a region.
  • Private Region Chat — Members communicate through an isolated chat channel.
  • Access Control — Whitelist and blacklist players for entry, building, and interaction independently.

Integrations & Development

  • Plugin Compatibility — Full support for Vault, WorldGuard, PlaceholderAPI, LuckPerms, and major permission systems.
  • Developer API — Extend Homestead with custom integrations using the public API.

Premium Features

  • Data Safety — Migration tools prevent corruption and support switching database providers.
  • Plugin Migration — Import data from other land-claiming plugins.
  • Full Localization — Every message, menu, and configuration string is translatable within the configuration files.
  • Staff Overrides — Staff can bypass protections, edit any region, and roll back damage (with other plugins) without affecting the owner.
  • Optimized Performance — Thread-safe, memory-efficient storage ensures protection checks have no impact on server TPS.
  • MiniMessage and Legacy Chat Format Support — Edit any message string using legacy Minecraft color codes or PaperMC Adventure MiniMessage tags for advanced message components.

Prerequisites

Before installing Homestead, make sure your server runs one of the platforms below and that the matching bridge plugin is installed. Homestead uses that bridge to reach the economy and permission services provided by your other plugins — it must be present even if you do not plan to use economy features or you rely on static claim limits.

Spigot

Spigot is one of the oldest Minecraft server platforms, but it lacks the major performance improvements found in newer forks, so we recommend PaperMC. If you prefer Spigot, Homestead supports the API from 26.1 up to 26.3.

Homestead requires the Vault plugin as a bridge to connect to the economy and permission services provided by other plugins. Vault must be installed on your server even if you would rather not use economy features or you are using static limits.

The following service providers have been verified and tested with Vault:

Vault
Economy EssentialsX, iConomyUnlocked
Permissions LuckPerms

PaperMC / Purpur

PaperMC is the modern, high-performance, and more advanced Minecraft server software. Homestead supports the API from 26.1 up to 26.3.

Homestead requires the Vault plugin as a bridge to connect to the economy and permission services provided by other plugins. Vault must be installed on your server even if you would rather not use economy features or you are using static limits.

The original Vault plugin has been outdated for over 6 years but may still work. Alternatively, you can use VaultUnlocked or ServiceIO instead.

The following service providers have been verified and tested with Vault, VaultUnlocked, and ServiceIO:

Vault VaultUnlocked ServiceIO
Economy EssentialsX, iConomyUnlocked iConomyUnlocked EssentialsX, iConomyUnlocked
Permissions LuckPerms (none) LuckPerms

Folia

Folia is a fork of PaperMC that introduces region-based multithreading. It is significantly more performant than PaperMC, but many plugins have not been updated to support it. Homestead is one of the exceptions: it supports the API from 26.1 up to 26.3.

On Folia, Homestead requires either the VaultUnlocked or iConomyUnlocked plugin, because one of them acts as a bridge to connect to the economy and permission services provided by other plugins. One of these plugins must be installed on your server even if you would rather not use economy features or you are using static limits.

The following service providers have been verified and tested with VaultUnlocked and ServiceIO:

VaultUnlocked ServiceIO
Economy iConomyUnlocked iConomyUnlocked
Permissions (none) LuckPerms

Developer API

Homestead exposes a public API so other plugins can manage regions, chunks, members, and flags programmatically and listen to Homestead events. All API versions are published on GitHub Packages, and full JavaDoc is available online at tayebyassine.github.io/Homestead/javadoc.

Authentication

GitHub Packages requires authentication for every download — including public packages. A request without a token gets 401 Unauthorized, which Gradle usually surfaces as Could not resolve ... 401, so this step is not optional.

Create a personal access token with the read:packages scope. A token without that scope returns 404 Not Found instead, which makes the package look like it does not exist.

Maven: Add a <server> to ~/.m2/settings.xml. Its <id> must match the <id> of the <repository> below, or Maven silently ignores it:

<settings>
  <servers>
    <server>
      <id>homestead-github</id>
      <username>YOUR_GITHUB_USERNAME</username>
      <password>YOUR_PERSONAL_ACCESS_TOKEN</password>
    </server>
  </servers>
</settings>

Gradle: Put the credentials in ~/.gradle/gradle.properties so they never reach version control, then bind them to the repository in your build script (see below):

GitHubPackagesUsername=YOUR_GITHUB_USERNAME
GitHubPackagesPassword=YOUR_PERSONAL_ACCESS_TOKEN

Maven

Add the repository and dependency:

<repository>
  <id>homestead-github</id>
  <url>https://maven.pkg.github.com/TayebYassine/Homestead</url>
</repository>

<dependency>
  <groupId>me.tayebyassine.homestead</groupId>
  <artifactId>homestead</artifactId>
  <version>6.0.0.0</version>
  <classifier>api</classifier>
  <scope>provided</scope>
</dependency>

Gradle

repositories {
    maven {
        url = uri("https://maven.pkg.github.com/TayebYassine/Homestead")
        credentials {
            username = providers.gradleProperty("GitHubPackagesUsername").orNull
            password = providers.gradleProperty("GitHubPackagesPassword").orNull
        }
    }
}

dependencies {
    compileOnly("me.tayebyassine.homestead:homestead:6.0.0.0:api")
}

Always use the api classifier — the classifier-less artifact is the shaded server jar, not the API you compile against.

See the Developer API docs for the full event list, troubleshooting, and usage examples.

Metrics

Homestead collects anonymous usage data and sends it to bStats and FastStats, two well-known metrics services in the Minecraft plugin industry. No personal data is collected.

Metrics are enabled by default. You can disable them entirely in the plugin's configuration files if you prefer.

Metrics Embedded Images

Contributing

Contributions are welcome! Whether you are fixing a bug, improving the documentation, or adding a feature, feel free to open a pull request.

Please read the guidelines before you open one: CONTRIBUTING.md

License

Homestead is released under the Apache License 2.0.

About

A chunk-based land claiming plugin for Minecraft 26.1 and later

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages