https://github.com/gsejas/breath_master

VSCode Ext game with animated breathwork guide, ethically concious, privacy first, /w gamified features
https://github.com/gsejas/breath_master

breathing focus game gamified theory

Last synced: 4 months ago
JSON representation

VSCode Ext game with animated breathwork guide, ethically concious, privacy first, /w gamified features

• Host: GitHub
• URL: https://github.com/gsejas/breath_master
• Owner: GSejas
• License: other
• Created: 2025-08-12T04:22:32.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2025-08-25T09:22:35.000Z (10 months ago)
• Last Synced: 2025-08-25T11:38:29.444Z (10 months ago)
• Topics: breathing, focus, game, gamified, theory
• Language: HTML
• Homepage: https://marketplace.visualstudio.com/items?itemName=GSejas.breath-master
• Size: 22.3 MB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README-BREATH-MASTER.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# 🧘‍♀️ Breath Master - Mindful Coding with Ethical Gamification

Are you? The next Breath Master? Transform your coding experience with gentle breathing guidance and optional progress tracking that respects your privacy and autonomy. Gamify, gently, and add flow into your workflow.

## ✨ Features

### **Core Breathing**

- **5 Preset Patterns**: Chill, Medium, Active, Boxing, Relaxing

- **Custom Patterns**: Create your own with simple format: `4-4-4-4` (inhale-hold-exhale-pause)

- **Visual Breathing Cues**: Subtle status bar animation guides your breath

- **Dual Indicators**: Left (breathing) and right (pattern controls) status bar items

### **Ethical Gamification** (Opt-in)

- **Privacy-First**: All data stays on your machine, never uploaded

- **Meditation Tracking**: Track mindful moments with breathing cycles

- **Level Progression**: From Mindful Rookie to Breath Master

- **Daily Streaks**: Gentle encouragement without pressure

- **Session Timer**: See today's meditation progress

### **Privacy & Control**

- **Local-Only Storage**: Data never leaves your computer

- **Full Export**: JSON export of your progress anytime

- **Complete Control**: Clear data, adjust privacy settings

- **No Accounts**: Works entirely offline

### **Onboarding & Engagement**

- **Welcome Tour**: Gentle introduction to all features

- **Exponential Backoff**: Messages become less frequent over time

- **User-Controlled**: Set engagement to off/subtle/moderate/active

- **12 Principles Compliant**: Follows ethical design principles

## 🚀 Quick Start

1. **Install**: Search "Breath Master" in VS Code extensions

2. **Breathe**: Watch the gentle pulse in your status bar

3. **Cycle Patterns**: Click the right status bar item to try different rhythms

4. **Optional Tour**: Run "Breath Master: Show Welcome Tour" from command palette

5. **Optional Tracking**: Enable gamification in settings if desired

## ⚙️ Settings

```json

{

  "breathMaster.pattern": "chill",           // Breathing pattern

  "breathMaster.customPattern": "4-4-4-4",   // Custom timing (seconds)

  "breathMaster.intensity": 0.6,             // Visual intensity

  "breathMaster.enableGamification": false,  // Opt-in tracking

  "breathMaster.dataPrivacy": "local-only"   // Privacy control

}

```

## 🎯 Commands

- `Breath Master: Toggle` - Start/stop breathing animation

- `Breath Master: Cycle Pattern` - Try different breathing patterns

- `Breath Master: Show Welcome Tour` - Replay the introduction

- `Breath Master: Toggle Meditation Session` - Start/stop tracking

- `Breath Master: Export Your Data` - Save your progress

- `Breath Master: Clear All Data` - Fresh start

## 🧘‍♂️ Breathing Patterns

| Pattern | Timing | Purpose |

|---------|--------|---------|

| **Chill** | 6-0-8-0 | Relaxation and stress relief |

| **Medium** | 5-0-5-0 | Coherent breathing balance |

| **Active** | 4-2-4-1 | Energy and focus boost |

| **Boxing** | 4-4-4-4 | Tactical breathing for concentration |

| **Relaxing** | 4-7-8 | Deep relaxation technique |

| **Custom** | Your choice | Create your perfect rhythm |

## 🏆 Level System (Optional)

Progress through mindful titles as you build a breathing practice:

🌱 **Mindful Rookie** → 🌿 **Breathing Novice** → 🍃 **Calm Coder** → 🌳 **Zen Developer** → ✨ **Mindful Master** → 🧘 **Breathing Sage** → ⭐ **Code Mystic** → 🌌 **Breath Master**

## 🔐 Privacy Promise

Breath Master follows the [12 Principles of Ethical Design](./12-PRINCIPLES-ANALYSIS.md):

- ✅ **Transparent**: You know exactly what data exists

- ✅ **User Control**: You decide what features to use

- ✅ **Local-First**: No cloud, no accounts, no tracking

- ✅ **Consensual**: Clear opt-in for any data collection

- ✅ **Respectful**: No manipulation or dark patterns

## 🛠️ For Developers

### Custom Patterns

Format: `"inhale-hold-exhale-pause"` in seconds

- Example: `"4-4-4-4"` = 4 seconds each phase

- Example: `"6-0-8-0"` = 6 second inhale, 8 second exhale

- Validation ensures safe breathing patterns

### Data Export Format

```json

{

  "exportDate": "2025-08-11T...",

  "breathMaster": {

    "meditation": {

      "totalXP": 150,

      "currentStreak": 5,

      "todaySessionTime": 600000

    },

    "onboarding": {

      "hasSeenTour": true,

      "gamificationOptIn": true

    }

  }

}

```

## 🤝 Contributing

This extension demonstrates ethical technology design. Contributions should maintain:

- User agency and control

- Privacy-first approach

- Respectful engagement

- Transparent functionality

## 📄 License

MIT License - Build mindful technology freely

---

> *"Code with breath, build with intention, ship with mindfulness."*

**Made with 🫁 for developers who care about well-being and ethical tech.**