93 lines
4.0 KiB
Plaintext
93 lines
4.0 KiB
Plaintext
====== Land, Claims, and Government Regions ======
|
|
|
|
CoalGov separates land into government-defined land regions and player-owned claims. Land regions describe what the government says the land is. Claims describe who owns a specific private plot.
|
|
|
|
===== Land Classes ======
|
|
|
|
* FREEHOLD - private land can exist here. If no land region matches, this is the default unless config changes it.
|
|
* LEASE - reserved for lease and expiration rules.
|
|
* GOVERNMENT - state land. Coal mining is denied unless the player has admin permission.
|
|
* PUBLIC - public government land. It is protected and cannot be privately claimed.
|
|
* MINING_CONCESSION - coal mining requires a valid mining permit for that named region.
|
|
* PROTECTED_PRESERVE - protected land. Coal mining is denied unless the player has admin permission.
|
|
* BORDER_ZONE - border land. Coal mining is denied unless the player has admin permission.
|
|
|
|
===== Claim Types =====
|
|
|
|
* HOMESTEAD
|
|
* INDUSTRIAL
|
|
* MINING_CONCESSION
|
|
|
|
The current player commands support buying homestead and industrial claims. Admins define mining concessions as land regions.
|
|
|
|
===== Radius Claims =====
|
|
|
|
Players can buy a rectangular claim centered on their current location:
|
|
|
|
/claim buy <homestead|industrial> <radius>
|
|
|
|
The plugin rejects overlapping claims and land classes that cannot be privately claimed, such as government land, public land, protected preserves, border zones, and mining concessions.
|
|
|
|
Claim cost comes from config:
|
|
|
|
cost = base_cost + area * cost_per_block
|
|
|
|
===== Starter Homestead =====
|
|
|
|
Each player can receive one small starter homestead for free if they do not already own a claim. By default, the free starter size is radius 12, or a 25x25 block square. Polygon starter claims are also free if their bounding box fits inside that size.
|
|
|
|
Free starter land cannot be flipped for land value. CoalGov stores the actual purchase price on the claim. A free starter homestead has purchase value 0, so selling it refunds only resource value left on the property, minus any depletion charge for extracted or damaged land.
|
|
|
|
===== Polygon Wand Claims =====
|
|
|
|
Players can draw a claim shape with a wand:
|
|
|
|
/claim wand
|
|
|
|
Right-click blocks to add polygon points. The plugin displays temporary particles between points and temporary gold marker block previews at selected points so the player can see the outline while drawing. Sneak right-click with the wand to clear the current selection.
|
|
|
|
After selecting at least three points, buy the claim without a radius:
|
|
|
|
/claim buy homestead
|
|
/claim buy industrial
|
|
|
|
The claim uses the polygon itself for ownership checks. The bounding box must still fit within the configured maximum size for the claim type.
|
|
|
|
===== Claim Markers =====
|
|
|
|
Purchased claims place protected marker blocks at their corners or polygon vertices. These marker blocks are immutable for normal players and make boundaries visible without needing claim IDs.
|
|
|
|
Players can also run:
|
|
|
|
/claim show <id>
|
|
|
|
This displays a temporary particle outline for the claim.
|
|
|
|
===== Protected Unclaimed Land =====
|
|
|
|
Players can only build or break inside claims they own. Unclaimed land is protected by default. Admins with ''coalgov.admin'' follow the same rules unless they enable bypass mode with ''/coalgov admin bypass on''.
|
|
|
|
===== Claim Info =====
|
|
|
|
Players run:
|
|
|
|
/claim info
|
|
|
|
This reports the land class or named land region at the current location, plus any claim at the same spot.
|
|
|
|
===== Appraisal and Sale =====
|
|
|
|
Players can appraise or sell land without remembering IDs if they stand inside their own claim:
|
|
|
|
/claim appraise
|
|
/claim sell
|
|
|
|
The command also accepts an ID when needed:
|
|
|
|
/claim appraise <id>
|
|
/claim sell <id>
|
|
|
|
Sale value depends on land condition and configured resources stored on the property. Intact land keeps more of its original purchase value. Extracted or damaged land refunds less. Counted resources on the property add value according to configured resource prices.
|
|
|
|
For free starter homesteads, extracted land value can become a charge instead of a refund. This discourages claiming free land, stripping it, and selling it back.
|