docs(design): define Tree Feller user stories

2026-08-11 17:07:13 -04:00
commit de27d6519e
12 changed files with 333 additions and 0 deletions
@@ -0,0 +1,28 @@
+---
+type: User Story
+title: "US-006: Announce tree unlocks"
+description: Celebrate each newly earned species and explain how to control or undo automatic felling.
+status: backlog
+---
+
+# US-006: Announce tree unlocks
+
+As a **player**, I want visible and actionable feedback when I unlock a species so that I notice the achievement and understand Tree Feller's safety controls.
+
+## Acceptance criteria
+
+- [ ] Earning a species unlock displays a configurable on-screen title and subtitle naming the species.
+- [ ] Earning a species unlock also sends a configurable chat message that explains that sneaking prevents automatic felling and names `/treefeller undo`.
+- [ ] Title text, subtitle text, fade-in time, display time, fade-out time, and chat text are configurable.
+- [ ] Messages support the project's chosen Spigot formatting convention and a documented species placeholder.
+- [ ] The boss bar for the newly unlocked species is removed when its unlock announcement is shown.
+- [ ] An earned species produces its unlock announcement exactly once unless an administrator later resets that species and the player earns it again.
+- [ ] An administrative grant clearly informs an online target that access was granted but does not falsely present it as a mined-block achievement.
+- [ ] Invalid or cancelled breaks never generate an unlock announcement.
+
+## Related
+
+- [US-001: Earn tree-type unlocks](us-001-earn-tree-type-unlocks.md)
+- [US-002: View tree progress](us-002-view-tree-progress.md)
+- [US-007: Administer Tree Feller](us-007-administer-tree-feller.md)
+- [US-008: Configure and persist Tree Feller](us-008-configure-and-persist-tree-feller.md)