Add Coal Cents economy

coalgov-wiki-pages/admin.txt

@@ -0,0 +1,115 @@
+====== Admin Guide ======
+
+===== Permissions =====
+
+  * coalgov.admin - admin commands; default op. Gameplay bypass is toggled with ''/coalgov admin bypass on''.
+  * coalgov.coal - coal economy commands; default true.
+  * coalgov.claim - claim commands; default true.
+  * coalgov.permit - permit commands; default true.
+  * coalgov.land.info - land info commands; default true.
+  * coalgov.market - market trading; default true.
+  * coalgov.police - police fine commands; default op.
+
+===== Creating Land Regions =====
+
+Stand at the center of the intended area and run:
+
+  /land create <name> <landClass> <radius>
+
+Examples:
+
+  /land create ministry-yard GOVERNMENT 24
+  /land create north-pit MINING_CONCESSION 40
+  /land create wall-east BORDER_ZONE 12
+  /land create old-grove PROTECTED_PRESERVE 32
+
+The command creates a square X/Z region centered on the admin.
+
+===== Spawn Setup =====
+
+Stand where the public spawn should be and run:
+
+  /coalgov admin spawn setup
+
+This sets the world spawn to your current block, creates or replaces a GOVERNMENT land region named ''spawn'', and places guide signs nearby. Normal players cannot modify the spawn guide because unclaimed government land is protected.
+
+Default spawn guide text can be changed in ''plugins/CoalGov/config.yml'' under ''spawn.guide.lines''.
+
+===== Starter Homesteads =====
+
+By default, each player gets one free homestead if it fits within radius 12 and they do not already own a claim:
+
+  claims:
+    homestead:
+      first_claim:
+        free: true
+        max_radius: 12
+
+Free starter homesteads store purchase value 0. Their resale appraisal can still count resources left on the property, but extracted or damaged land can create a depletion charge.
+
+===== Economic Controls =====
+
+Admins can inspect and modify balances:
+
+  /coalgov admin balance <player>
+  /coalgov admin grant <player> <amount>
+  /coalgov admin take <player> <amount>
+
+Money amounts accept whole coal, decimal coal, or a ''cc'' suffix. For example, ''1.25'' and ''125cc'' are both 1 coal 25cc.
+
+Admins can inspect and spend the treasury:
+
+  /coalgov admin treasury balance
+  /coalgov admin treasury grant <player> <amount>
+
+Admins can exempt players from transaction taxes:
+
+  /coalgov admin tax exempt <player> on
+  /coalgov admin tax exempt <player> off
+  /coalgov admin tax exempt <player> status
+
+Police can issue payable fines:
+
+  /police fine <player> <amount> <reason>
+
+Admins can grant a divining rod for testing:
+
+  /coalgov admin rod
+
+===== Admin Bypass Mode =====
+
+Admins normally play under the same build, marker, and mining restrictions as citizens.
+
+Use bypass mode only when you need the old god-power behavior:
+
+  /coalgov admin bypass on
+  /coalgov admin bypass off
+  /coalgov admin bypass status
+
+Bypass mode is per-player and lasts until it is turned off or the plugin/server restarts.
+
+===== Market Controls =====
+
+The market is configured in ''plugins/CoalGov/config.yml'' under ''market''. Admins can tune base prices, target stock, the starting stock for new materials, min/max price movement, and the buy/sell spread.
+
+After editing market config, run:
+
+  /coalgov admin reload
+
+Existing market stock is stored in SQLite and is not reset by reload.
+
+===== Reloading Config =====
+
+After editing plugins/CoalGov/config.yml, run:
+
+  /coalgov admin reload
+
+===== Server Files =====
+
+The plugin stores data in:
+
+  plugins/CoalGov/coalgov.db
+
+The plugin config is:
+
+  plugins/CoalGov/config.yml