Claims
KyuubiSoft Claims protects land in chunks. Players pick chunks on a map and claim them, give other players a role and decide with checkboxes what visitors, trusted players and co-owners may do. Parts of a claim can become zones with their own rules. Admins mark places like spawn or a market as server zones that nobody can claim, and manage every claim and rule in one window.
How it works
Section titled “How it works”- Chunks. Land is claimed in chunks of 32 × 32 blocks. A claimed chunk is protected from the bottom of the world to the top.
- Claims. A claim is a group of connected chunks in one world, with one owner, a name, a greeting and an optional home. Chunks that touch one of your claims make it grow. Chunks that touch none of your claims start a new claim. Claims never merge by themselves.
- Quota. Every player starts with 25 chunks and up to 5 claims. Admins can raise the quota per player, with permission tiers or with play time. When the admin switches the economy on, claiming costs money and extra chunks can be bought.
- Roles. Everyone without a role is a Visitor. The owner gives players the role Trusted or Co-owner. The Owner may always do everything.
- Rights. Twelve rights, from “Build and break” to “Manage people and settings”. Per claim, a checkbox per role decides who may do what. Higher roles always keep what the lower ones may.
- Zones. A zone is a part of a claim with its own rules for visitors and trusted players. Each right is “like the claim”, “allowed” or “forbidden” there.
- Bans. Banned players cannot enter the claim. They are pushed back to its edge.
- Server zones. Admins mark chunks as server zones, for example spawn, an arena or a market. They belong to nobody, nobody can claim them, and their own rules apply: enter, build, containers, doors, benches, fights between players and explosions.
- Data. Everything is stored in JSON files in the mod’s data folder. No database is needed.
Features
Section titled “Features”Claim on a map
Section titled “Claim on a map”/ksclaimopens the claims window on its map: 19 × 15 chunks around you, with your land, land where you have a role, foreign land, guild land and server zones in their own colours.- The map shows the terrain of the world map under the claims: each chunk as 4 × 4 colour squares taken from the world map image, with the state of the chunk laid on top as a light tint and a thin ring. So you see what you really claim. Admins can switch it off (
display.mapTerrain); then the map is flat as before. - Click free chunks and claim them in one go (up to 64 at once). The window tells you before you click what happens: how much of your quota is used then, which claim grows or that a new one is made, and the price.
- Choose chunks of your claim to release them, or chunks to turn into a zone.
- Without the window:
/ksclaim claimclaims the chunk you stand in,/ksclaim unclaimreleases it.
Who may do what
Section titled “Who may do what”- A rights table per claim: visitors, trusted players and co-owners, one checkbox per right. Inherited ticks are shown dimmed.
- Add people with a role, switch between Trusted and Co-owner, remove roles and ban players, in the window or with commands.
- Co-owners help manage the claim, but only the owner releases chunks, dissolves the claim, hands it over or decides about co-owners.
- See Rights and Roles.
Zones inside a claim
Section titled “Zones inside a claim”- Pick chunks of your claim on the map and make them a zone, for example a shop where visitors may use the doors, or a garden with its own rules for trusted players.
- Up to 10 zones per claim. A mini map on the Zones tab shows where the zone is.
Protection
Section titled “Protection”- Breaking and placing blocks, harvesting, carrying blocks away, containers, doors, workbenches, switches, seats, buckets, fire, hoes and hammers, by players and by creatures.
- Explosions do not destroy claimed land, unless the claim allows it.
- Nobody can attach a chest or door to yours from outside, the block under your containers at the border stays, and a workbench next to your land does not take from your chests.
- Fights between players are off in claims by default, from both sides of the border. Animals and other peaceful creatures can only be hurt with the right to do so. Monsters can always be fought.
- Admins can ignore the protection with
ks.claims.admin.bypassor, until they log out, with/ksclaimadmin bypass.
Notices and the border
Section titled “Notices and the border”- When something is not allowed, a short notice at the top names the claim and the missing right, and one chat line names the owner.
- Entering a claim shows its name and greeting at the top of the screen, leaving it shows “No man’s land”. Server zones get their own notice.
- Show border: golden light pillars mark the edge of the claim for 10 seconds. Only you see them.
Claim settings and home
Section titled “Claim settings and home”- Name, greeting, fights between players, explosions, who may light fire, flying for trusted players and keeping the inventory on death (both only when the server allows them), and the notices when someone enters.
- A home in the claim. The trip starts after 3 seconds of standing still and then has a 10 second cooldown. Others need the right “Use the home”.
- Every claim keeps 30 days of what was refused and what was changed, so you know who tried to open your chests. The Log tab shows every claim you manage.
Quota and economy
Section titled “Quota and economy”- Start quota, a maximum, claims per player, growth with play time and a distance to foreign land, all set by the admin.
- Permission tiers such as
ks.claims.chunks.100andks.claims.claims.10. - Economy (off by default): a price per chunk and per world, a refund when you release a chunk (only what was paid for it) and buying extra quota with
/ksclaim buychunks <amount>. - Abandoned claims (off by default): claims whose owner and co-owners have not logged in for a set number of days are dissolved. Blocks stay.
World map
Section titled “World map”- Claims, their zones and server zones are tinted on the world map, with a stronger line at their edges. Players only receive the map parts they can see.
- The tint has the colour of the legend. (The overlay of Claims 1.x mixed up the colour channels, so claimed chunks came out in wrong colours; 2.0.0 fixes this.)
Admin window
Section titled “Admin window”/ksclaimadminopens it. Four pages: Overview with live numbers and the latest refusals and changes, Claims with search, filters and tools, Server zones with their own map, and Rules and protection with every server-wide setting.- From the Claims page an admin travels to a claim, shows its border, changes the owner or the quota, releases chunks, reads the log, lifts a ban or turns the claim into a server zone.
- See UI Pages.
Languages
Section titled “Languages”- Nine languages: English, German, Spanish, French, Italian, Polish, Portuguese (Brazil), Russian and Turkish. Every message follows the player’s language, chosen with
/kslang.
Requirements
Section titled “Requirements”- Hytale server 0.7.x (built against 0.7.6) and Java 25.
- No other mod is required.
Optional KyuubiSoft mods
Section titled “Optional KyuubiSoft mods”| Mod | What it adds |
|---|---|
| Core | A Claims tile in the /ksadmin hub (opens the admin window, reloads the files), notices that take a row of Core’s shared card row, prices and refunds through Core’s economy bridge, and the claims windows on showcase NPCs |
| Guilds | Guild land: a guild member turns their own claim into land of the guild with /ksguild land add. Guild members get rights there by guild rank, at most what Trusted may do. The map and the claim list show it as Guild land |
| Player Shops | With playerShops.requireClaim on, a shop can only be opened in a claim by its owner, trusted players, co-owners and guild members who may build there. In a server zone only when the zone allows building |
| Server Events | A server zone can be the build field of a building contest. Events switches the zone’s building rule on for the build time and off again; each switch shows in the zone’s log under the name “Events” |
Claims runs fully without any of them.
What cannot be stopped yet
Section titled “What cannot be stopped yet”The game has no hook for these yet, so Claims cannot block them:
- Fire that spreads by itself can still burn wood in a claim. Lighting a fire is protected.
- Flowing water and lava can still flow into a claim. Placing them is protected.
- Picking up items by walking over them. Picking up on purpose is protected.
- Combat pets. A combat pet can still hurt players or animals inside a claim. This follows once the pet mod hands its hits over to the owner.
- Monsters appearing. There is no switch for it, because the game cannot stop spawns per chunk.
Where to go
Section titled “Where to go”| Page | Read it for |
|---|---|
| Getting Started | Installing, the files, your first claim, trusting people, zones, first steps for admins, taking over an older Claims database |
| Commands | Every /ksclaim and /ksclaimadmin command with syntax and permission |
| Rights and Roles | Roles, every right, zone rules, server zone rules and guild land |
| Permissions | Every permission node and its default |
| Configuration | Every key of config.json with its default |
| UI Pages | The claims window, the notices, the border and the admin window |
| FAQ | Practical questions and error messages |
| Changelog | What changed in each version |
Quick reference
Section titled “Quick reference”| Item | Details |
|---|---|
| Plugin | KyuubiSoft Claims (manifest kyuubisoft:claims) |
| Version | 2.0.0 (not released yet) |
| Jar | KyuubiSoftClaims-2.0.0.jar |
| Player command | /ksclaim (aliases /claim, /claims) |
| Admin command | /ksclaimadmin (alias /claimadmin) |
| Permissions | ks.claims.user.<action> (allowed by default), ks.claims.admin, ks.claims.admin.bypass, ks.claims.chunks.<n>, ks.claims.claims.<n> |
| Data folder | mods/kyuubisoft_claims/ |
| Config | mods/kyuubisoft_claims/config.json |
| Required | nothing else |
| Optional | KyuubiSoft Core, Guilds, Player Shops |