README file from
Github🐉 Gamified Writing Suite for Obsidian (AuDHD Author Edition)
A low-demand, hyperfocus-friendly writing suite designed by and for AuDHD women authors.
Standard writing advice tells you to "write 1,000 words every single day at 5:00 AM." But if your brain relies on interest-led momentum, cycle-aware energy levels, and hyperfocus bursts, rigid rules just lead to burnout.
This Obsidian plugin replaces shame-based productivity with a 900-Level Legendary Prestige loop inspired by Stardew Valley farming and D&D combat mechanics. It tracks your words, honors your energy reserves, and rewards every single interaction with your manuscript.
⚡ Built for Your Brain & Your Cycle
- Cycle & Energy Syncing: Easily track your daily energy (1–5 stars) and hormonal phase (Menstruation, Follicular, Ovulation, Luteal). Honor low-estrogen rest phases just as much as high-estrogen drafting surges.
- Friction-Free XP & Word Tracking: Real-time session monitoring that tracks words added, net speed (WPM), character counts, and pause intervals—without punishing you for taking breaks.
- Dynamic Gamification Tiers: Earn tier-based rewards as you level up from Level 1 all the way to Level 900!
- Crops & Animals Mode (Stardew Style): Harvest Parsnips, Strawberries, and Sweet Gem Berries, or care for Tier 3 Barn Animals.
- Monster Slayer Mode (D&D Style): Slay Imps, Goblins, Trolls, and Dragons.
- AuDHD Affirmation Engine: Built-in encouraging prompts written specifically to validate neurodivergent writing habits, sensory limits, and non-linear momentum.
- Automated Log Vaulting: Automatically exports detailed Markdown session reports to your designated vault folder so you can keep a low-effort record of your progress over time.
- Notes: There are currently only 3 tiers. Tier 1 is the first 300 levels. Tier 2 are levels 300 - 600. Tier 3 (final) are 600 - 900 levels.
🎮 How It Works
- Set Your Vibe: Open the sidebar tab (
Gamepadicon) and choose your theme mode (Crops & Animals or Monsters). - Log Energy & Cycle: Select your current cycle phase and daily energy level before starting.
- Start Writing: Hit Start Writing Session while working in any Markdown note. The plugin silently monitors your progress in real time.
- Claim Your Rewards: Finish your session to earn XP, unlock inventory collectibles, and auto-export a comprehensive progress log into your vault.
🛠️ Installation
Option 1: Via BRAT (Recommended for Easy Updates)
- Install the Obsidian42 - BRAT community plugin in Obsidian.
- Open BRAT settings and click Add Beta Plugin.
- Paste this repository's GitHub URL:
https://github.com/YOUR_USERNAME/YOUR_REPO_NAME - Click Add Plugin and enable Gamified Writing Suite under your installed plugins!
Option 2: Manual Installation
- Download the latest release files (
main.js,manifest.json,styles.css). - Create a folder named
gamified-writing-suiteinside your vault at.obsidian/plugins/. - Move the downloaded files into
.obsidian/plugins/gamified-writing-suite/. - Reload Obsidian (
Ctrl + R/Cmd + R) and enable the plugin in Settings > Community plugins.
🛡️ License
Distributed under the MIT License. Free for all neurodivergent creators to use, adapt, and build upon.
Remember: Your non-linear momentum is a high-level trait, not a bug in your code. Step up to the table—it's your turn to play. 👑