From 5498ddf358cff675fe80f571d8295b36d48c3481 Mon Sep 17 00:00:00 2001 From: tastybento Date: Mon, 16 Nov 2026 21:40:12 -0800 Subject: [PATCH] docs(MagicCobblestoneGenerator): 2.10.1 cooldown behaviour and changelog The exhaustion section described the pre-2.10.1 behaviour, where a cooldown shorter than the period had no effect. 2.10.1 starts a new period when the cooldown ends. Update "How it works", the cooldown description and the example, keep a note about older versions, and add the 2.10.1 changelog entry. Co-Authored-By: Claude Opus 5.5 --- .../addons/MagicCobblestoneGenerator/index.md | 24 ++++++++++++++++--- 1 file changed, 21 insertions(+), 3 deletions(-) diff --git a/docs/addons/MagicCobblestoneGenerator/index.md b/docs/addons/MagicCobblestoneGenerator/index.md index 8471b974..e5cc101b 100644 --- a/docs/addons/MagicCobblestoneGenerator/index.md +++ b/docs/addons/MagicCobblestoneGenerator/index.md @@ -184,7 +184,7 @@ Restart the server after editing so the new values are loaded. === "exhaustion.cooldown" !!! summary "Description" - How long, in **minutes**, a generator stays on cooldown after reaching its exhaustion limit. Applies to every generator tier. Set it to `0` to have no extra cooldown: the generator simply stops until the current period ends. A cooldown shorter than the period does not end the pause early (see [How it works](#how-it-works)). + How long, in **minutes**, a generator stays on cooldown after reaching its exhaustion limit. Applies to every generator tier. Set it to `0` to have no extra cooldown: the generator simply stops until the current period ends. Default: `1440` (24 hours) @@ -202,10 +202,13 @@ Each island counts blocks separately for every generator tier it has active. 2. Each generated block adds 1 to the count. 3. If the count reaches the limit **before the period ends**, the next attempt puts the tier on **cooldown** for `exhaustion.cooldown` minutes. Island members get the `generator-exhausted` message, which shows the minutes left. 4. While a tier is on cooldown it does not replace any blocks: lava and water make plain vanilla cobblestone, stone or basalt. -5. The count goes back to 0 only when the **period** ends. If the cooldown is over but the period is still running, the count is still at the limit, so the tier goes straight back on cooldown. In practice the generator stays stopped until the cooldown is over **and** the period has ended, whichever is later. +5. When the cooldown is over, a new period starts and the count goes back to 0. If the period ends without the limit being reached, the count also goes back to 0. + +!!! note "Before 2.10.1" + In versions before **2.10.1**, the count only reset when the period ended, so a cooldown shorter than the period had no effect: the generator stayed stopped until the period was over. !!! example - With `limit: 10`, `period: 60`, `cooldown: 1440`: if an island makes 10 blocks within an hour, the generator then stops for 24 hours. To let players make 10 blocks per hour and then just wait for the hour to finish, set `cooldown: 0`. For a shorter break overall, make both values smaller, e.g. `period: 10` and `cooldown: 10`. + With `limit: 10`, `period: 60`, `cooldown: 1440`: if an island makes 10 blocks within an hour, the generator then stops for 24 hours. To let players make 10 blocks per hour and then just wait for the hour to finish, set `cooldown: 0`. For a short break, set something like `cooldown: 30`. !!! tip "Seeing the current state" The placeholders `[gamemode]_magiccobblestonegenerator_generator_exhaustion_status` (blocks made / limit for each active generator) and `[gamemode]_magiccobblestonegenerator_exhausted_generator_names` (generators on cooldown) show where an island stands. @@ -416,6 +419,21 @@ Since **2.10.0** a generator tier can produce **custom blocks** from ItemsAdder, ## Changelog +??? warning "What's new in v2.10.1 — fixes, including database import data loss" + **Released:** 2026-11-17 + + A fix release. + + - 🔺 **Database import no longer wipes generators on a bad file.** `/[admin_command] generator database import ` removed all of a game mode's generator tiers before loading the file, so a mistyped name or an empty file left the game mode with no generators. The file is now loaded first, and the admin is told in chat if it is not found. + - ⚙️ **Exhaustion cooldown shorter than the period now works.** An expired cooldown now starts a new period with the count reset to 0. `cooldown: 0` still means "wait until the period ends". Nothing changes with the default settings. See [Generator exhaustion](#generator-exhaustion-rate-limiting). + - 🔡 **Generator Type button explained.** The button now says which lava mechanic each type responds to. All translated locale files gained the keys they were missing, and translations that hid the height range and requirement lines are fixed. + - 🐛 **Crashes fixed** when buying a generator on a spawn or unowned island, and when activating a generator with `overwrite-on-active` while a deleted generator was active. + - 🐛 **Height range checks.** Min height can no longer be set above max height in the generator edit panel, and the height range error messages now appear. + - 🐛 **Admin panel titles** no longer run past the edge of the window: generator, bundle and island panels show just the name, cut off with "…" if needed. + - 🔡 **Locale note:** BentoBox does not overwrite locale files it has already copied to `plugins/BentoBox/locales/MagicCobblestoneGenerator/`. Rename or delete that folder (after backing up any edits) to pick up the changed text. + + [Release v2.10.1](https://github.com/BentoBoxWorld/MagicCobblestoneGenerator/releases/tag/2.10.1) + ??? warning "What's new in v2.10.0 — custom blocks, requires BentoBox 3.19.1" **Released:** 2026-07-11