osrlib 2.3.0__tar.gz → 2.4.0__tar.gz

{osrlib-2.3.0 → osrlib-2.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: osrlib
-Version: 2.3.0
+Version: 2.4.0
 Summary: B/X (1981 Basic/Expert) tabletop RPG rules engine for turn-based dungeon crawlers
 Keywords: basic-expert,bx,dungeon-crawler,game-engine,osr,rpg,srd,ttrpg
 Author: Marsh Macy

{osrlib-2.3.0 → osrlib-2.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "osrlib"
-version = "2.3.0"
+version = "2.4.0"
 description = "B/X (1981 Basic/Expert) tabletop RPG rules engine for turn-based dungeon crawlers"
 readme = "README.md"
 # The wheel ships Open Game Content (osrlib/data/*.json and its LICENSE-OGL.md

{osrlib-2.3.0 → osrlib-2.4.0}/src/osrlib/core/ruleset.py

@@ -263,3 +263,14 @@ class Ruleset(BaseModel):
     in a ten-foot passage, and osrlib uses the lower number. Turn the flag off and there's
     no cap, so every combatant may melee.
     """
+
+    failed_trap_removal_springs: bool = True
+    """Spring a treasure trap on the thief who fails to remove it. An adaptation, on by default.
+
+    The SRD says a thief may try only once to remove a treasure trap, and it doesn't say what
+    a failure does. Turn the flag off and a failed
+    [`RemoveTreasureTrap`][osrlib.crawl.commands.RemoveTreasureTrap] leaves the trap armed.
+    The party still knows where it is. That thief can't try again, another thief in the
+    party can, and the trap still gets its 2-in-6 chance to spring when someone takes the
+    treasure.
+    """

{osrlib-2.3.0 → osrlib-2.4.0}/src/osrlib/crawl/commands.py

@@ -1030,7 +1030,10 @@ class RemoveTreasureTrap(Command):
     isn't enough. A member must already have found the trap with
     [`InspectTreasure`][osrlib.crawl.commands.InspectTreasure]. Only a member with thief
     skills can try, and each member gets one attempt at each trap. A failed attempt springs
-    the trap on the thief who tried. Once the trap is removed,
+    the trap on the thief who tried, unless
+    [`Ruleset.failed_trap_removal_springs`][osrlib.core.ruleset.Ruleset.failed_trap_removal_springs]
+    is off. With the flag off, the trap stays armed and found, and another thief in the party
+    can try. Once the trap is removed,
     [`TakeTreasure`][osrlib.crawl.commands.TakeTreasure] empties the cache safely.
 
     Modes:
@@ -1054,7 +1057,8 @@ class RemoveTreasureTrap(Command):
     Events:
         [`DetectionRolledEvent`][osrlib.crawl.events.DetectionRolledEvent] with the
         skill roll, then a [`TrapEvent`][osrlib.crawl.events.TrapEvent]:
-        `exploration.trap.removed` on success, `exploration.trap.sprung` on failure.
+        `exploration.trap.removed` on success. A failure gives `exploration.trap.sprung`, or
+        `exploration.trap.removal_failed` when `failed_trap_removal_springs` is off.
         The sprung trap resolves at once against the thief, or against every living
         member when the trap catches the whole party. Each step is a separate event:
         a [`SavingThrowRolledEvent`][osrlib.core.events.SavingThrowRolledEvent] when

{osrlib-2.3.0 → osrlib-2.4.0}/src/osrlib/crawl/dungeon.py

@@ -1040,7 +1040,8 @@ class FeatureSpec(BaseModel):
     party opens the cache. A thief finds it with
     [`InspectTreasure`][osrlib.crawl.commands.InspectTreasure] and takes it out with
     [`RemoveTreasureTrap`][osrlib.crawl.commands.RemoveTreasureTrap]. Each character gets one try at
-    each, and a failed removal springs the trap."""
+    each. A failed removal springs the trap, unless
+    [`Ruleset.failed_trap_removal_springs`][osrlib.core.ruleset.Ruleset.failed_trap_removal_springs] is off."""
 
     @model_validator(mode="after")
     def _trap_kind_matches(self) -> FeatureSpec:
@@ -1893,7 +1894,8 @@ class DungeonState(BaseModel):
     feature reference. Each character gets one try at each cache."""
     removal_attempts: dict[str, list[str]] = {}
     """Which characters have tried to remove each treasure trap, as lists of character ids keyed by
-    feature reference. Each character gets one try at each trap, and a failed try springs it."""
+    feature reference. Each character gets one try at each trap. A failed try springs the trap, unless
+    [`Ruleset.failed_trap_removal_springs`][osrlib.core.ruleset.Ruleset.failed_trap_removal_springs] is off."""
     lock_failures: dict[str, dict[str, int]] = {}
     """Which thieves failed to pick each lock, keyed by [`edge_ref`][osrlib.crawl.dungeon.edge_ref].
     Each value maps a character id to the thief's level at the time. A thief who failed a lock can

{osrlib-2.3.0 → osrlib-2.4.0}/src/osrlib/crawl/events.py

@@ -448,7 +448,7 @@ class SearchCompletedEvent(Event):
 
 
 class TrapEvent(Event):
-    """A trap sprang, was found, was removed, or was known and didn't spring.
+    """A trap sprang, was found, was removed, resisted removal, or was known and didn't spring.
 
     Emitted by the commands that can set a trap off or look for one:
     [`MoveParty`][osrlib.crawl.commands.MoveParty],
@@ -478,14 +478,29 @@ class TrapEvent(Event):
     [`RemoveTreasureTrap`][osrlib.crawl.commands.RemoveTreasureTrap], because finding a
     treasure trap doesn't disarm it. That is why `exploration.trap.safe`, a known trap
     getting its chance and not springing, appears only for a treasure cache.
+
+    A thief who fails to remove a treasure trap springs it, unless
+    [`Ruleset.failed_trap_removal_springs`][osrlib.core.ruleset.Ruleset.failed_trap_removal_springs]
+    is off. With the flag off, the failure emits `exploration.trap.removal_failed` and the trap
+    stays armed and found.
     """
 
     allowed_codes: ClassVar[frozenset[str]] = frozenset(
-        {"exploration.trap.sprung", "exploration.trap.safe", "exploration.trap.found", "exploration.trap.removed"}
+        {
+            "exploration.trap.sprung",
+            "exploration.trap.safe",
+            "exploration.trap.found",
+            "exploration.trap.removed",
+            "exploration.trap.removal_failed",
+        }
     )
     """`exploration.trap.sprung` when a trap goes off, `.found` when a search or inspection
-    reveals one, `.removed` when a thief disarms one, and `.safe` when a trap the party already
-    knows about got its chance and didn't fire, which only a treasure trap does."""
+    reveals one, `.removed` when a thief disarms one, `.removal_failed` when a thief fails to
+    disarm one and it doesn't spring, and `.safe` when a trap the party already knows about got
+    its chance and didn't fire, which only a treasure trap does. A failed removal gives
+    `.removal_failed` only when
+    [`Ruleset.failed_trap_removal_springs`][osrlib.core.ruleset.Ruleset.failed_trap_removal_springs]
+    is off. Otherwise the trap springs."""
 
     event_type: Literal["trap"] = "trap"
     """The event type, `trap`, which identifies this class in serialized form."""
@@ -501,8 +516,9 @@ class TrapEvent(Event):
     tried to remove the trap. For a trap that springs when the party enters its area or opens its
     door with [`OpenDoor`][osrlib.crawl.commands.OpenDoor], it's the first living member in
     marching order. It's set even when the trap hits the whole party. For
-    `exploration.trap.removed`, and for a treasure trap found with
-    [`InspectTreasure`][osrlib.crawl.commands.InspectTreasure], it's the thief."""
+    `exploration.trap.removed` and `exploration.trap.removal_failed`, and for a treasure trap
+    found with [`InspectTreasure`][osrlib.crawl.commands.InspectTreasure], it's the thief who
+    tried."""
     direction: str | None = None
     """The direction of the door a room trap was found through, from the searched cell, as a
     [`Direction`][osrlib.crawl.dungeon.Direction] value. Set for that find alone: it is `None` on a

{osrlib-2.3.0 → osrlib-2.4.0}/src/osrlib/crawl/exploration.py

@@ -2452,9 +2452,13 @@ def _handle_remove_treasure_trap(session, command: RemoveTreasureTrap) -> tuple[
     if result.passed:
         state.removed_traps.append(ref)
         events.append(TrapEvent(code="exploration.trap.removed", trap_ref=ref, character_id=member.id))
+    elif not session.ruleset.failed_trap_removal_springs:
+        # RAW says only "attempted once per trap". With failed_trap_removal_springs off, a
+        # failure leaves the trap armed and found, and only this thief is barred from retrying.
+        events.append(TrapEvent(code="exploration.trap.removal_failed", trap_ref=ref, character_id=member.id))
     else:
-        # A failed removal springs the trap on the thief, the classic reading.
-        # RAW says only "attempted once per trap".
+        # With failed_trap_removal_springs on (the default), a failed removal springs the trap
+        # on the thief, the classic reading. RAW says only "attempted once per trap".
         state.sprung_traps.append(ref)
         events.append(TrapEvent(code="exploration.trap.sprung", trap_ref=ref, character_id=member.id))
         events.extend(_resolve_trap(session, feature.trap, triggerer=member))

{osrlib-2.3.0 → osrlib-2.4.0}/src/osrlib/messages.py

@@ -296,6 +296,9 @@ _TEMPLATES: dict[str, Callable[[Any], str]] = {
     "exploration.trap.removed": lambda event: (
         (event.character_id or "The party") + f" removes the trap ({event.trap_ref})."
     ),
+    "exploration.trap.removal_failed": lambda event: (
+        (event.character_id or "The party") + f" fails to remove the trap ({event.trap_ref})."
+    ),
     "exploration.item.acquired": lambda event: (
         f"{event.character_id} acquires "
         + (", ".join(event.item_ids) if event.item_ids else "")