Habsiad 1.5.2

Your Obsidian ⚡ Habitica Bridge

A productivity plugin for Obsidian that bridges the gap between note-taking and gamified habit tracking through Habitica.

📦 Installation

Method 1: BRAT (Beta Reviewer's Auto-update Tool) - Recommended

Install BRAT from the Community Plugins
Add this repository: https://github.com/dotMavriQ/Habsiad
Enable the plugin in Community Plugins settings

Method 2: Manual Installation

Download the latest habsiad.zip from Releases
Extract to your vault's .obsidian/plugins/ directory
Enable the plugin in Community Plugins settings

Note: Version 1.5.2 includes BRAT compatibility improvements. Earlier versions (1.5.1) required manual installation.

What is Habsiad?

Habsiad is an opinionated productivity plugin that establishes predefined standards to operate efficiently while remaining as modular as possible within these confines.

Originally developed as a bridge between Obsidian and Habitica, Habsiad is a complete productivity suite that functions regardless of whether you use Habitica daily, often, or at all.

Core Philosophy

Habitica handles three main productivity stacks:

Habits: Things that are generally good to do as often as possible
Dailies: Things you want to be penalized for not achieving every day
TODOs: Unique one-off tasks that can have subtasks

Habsiad addresses Habitica's biggest flaw: it doesn't store your progress over time. With Habsiad, you can import your achieved Habits & Dailies FROM Habitica INTO your Obsidian journal entries.

🚀 Getting Started

Requirements

Obsidian vault with a folder called Journal, journal, or JOURNAL in your vault root
Daily journal files named in YYYY-MM-DD.md format (use Calendar plugin for convenience)
Template structure following Habsiad standards

For Habitica Integration (Optional)

Template Setup

Create a template file in TEMPLATES/journal with this structure:

---
3meals:
bed:
book:
trash:
walk:
workout:
steps:
weight:
---
# {WEEKDAY}
## WORK:
###### Summary:

### Goals for Today:
- [ ] Task 1
- [ ] Task 2
- [ ] Task 3

## LIFE:

### FOOD:
| ⌚         | MEAL | EST.CALORIES |
| --------- | ---- | ------------ |
| Breakfast |      |              |
| Lunch     |      |              |
| Dinner    |      |              |
| Snacks    |      |              |

### TODO:

## Reflections:

🎯 Features

Core Tabs

🏡 Home Tab

Plugin information and version number
Quick access to settings and Habitica
Elegant Greek vase logo with carved-out H design

🔎 Data Quality Diagnostics

Birds-eye view of journal entries and their data quality
Dynamically generated insights about your daily notes
Identify missing or incomplete entries

⬆️ Frontmatter Glossary

Map Habitica Keys to Frontmatter Keys for synchronization
"Sync Habitica to Frontmatter" button for batch processing
Enable data visualization with plugins like Tracker

🏷️ Labels Tab (New in 1.5.1)

Track anything with emoji-based labels in your journal entries:

* Today I ate eight waffles again... `🧇: 8`
* Indoor temperature was perfect today `🌡️: 22`
* Bathroom visits (don't judge) `🚽: 4`

Automatically scans and aggregates label data
Chronological rundown when clicked
Perfect for tracking temperature, humidity, habits, or any quantifiable data

📔 Logs Tab (New in 1.5.1)

Create specialized logs using Obsidian Callouts:

> [!DREAM] #### Underwater Nightmare
> I was navigating a tunnel underwater with people from high school...
> 
> ![[Dream_20240205_underwaternightmare.png]]

> [!WORKOUT] #### Morning Run
> 5K run in 25 minutes. Felt great despite the rain!

Supports any callout type: DREAM, WORKOUT, MEETING, etc.
Chronological organization of related logs
Click to navigate back to original journal entry

Optional Tabs

👟 Steps (Optional)

Manual step count input from fitness apps
Data stored in frontmatter for visualization
Supports Google Fit, Samsung Health, Zepp Life, etc.

⚖️ Weight (Optional)

Simple weight tracking in kilograms
Frontmatter storage for trend analysis

🍔 Calories (Optional)

Track calorie intake with "Calculate totals" button
Automatically extracts and sums EST.CALORIES from food tables
Integrates with your meal tracking workflow

🍺 Alcohol Tracker (Optional)

Scans journal entries for alcohol-related emojis
Graphical representation of consumption patterns
Linear listing by date for awareness tracking

🎮 Habitica Integration

Sync Features

Import Habits & Dailies: Bring completed items into your journal
TODO Sync: One-way sync from Habitica to Obsidian
Automatic Weekday Updates: Template placeholders like {WEEKDAY} auto-update
Progress Preservation: Store your Habitica achievements permanently in Obsidian

The Retrotagger

Emancipate yourself from Habitica dependency!

Retroactively enter Habits & Dailies at the end of any journal entry
Perfect for when you forget to log in Habitica
Enables "productivity without gamification" while maintaining achievement-based format
Stores your own Habits & Dailies list for consistent tracking

⌨️ Keyboard Shortcuts

All commands are fully customizable in settings:

Generate Habits & Dailies: Ctrl/Cmd+Shift+H
Replace {WEEKDAY} with Actual Day: Ctrl/Cmd+Shift+D
Sync Habitica TODO: Ctrl/Cmd+Shift+Y
Sync Habitica to Frontmatter: Ctrl/Cmd+Shift+Q
Calculate Calorie Totals: Ctrl/Cmd+Shift+C

🔧 Configuration

Journal Setup

Journal folder: Configurable (default: Journal)
File naming: YYYY-MM-DD.md format required
Template structure: Follow Habsiad standards for best results

Optional Features

Toggle any optional tabs on/off based on your needs:

Steps tracking
Weight monitoring
Calorie calculation
Alcohol tracking

Habitica API (Optional)

User ID and API Token from your Habitica account
Required only for Habitica integration features
Plugin works fully without Habitica credentials

💡 Pro Tips

Use Emoji Toolbar plugin for convenient emoji entry
Combine with Calendar plugin for seamless daily note creation
Leverage Tracker plugin to visualize your frontmatter data
Set consistent daily journaling times for best habit formation

📈 What's New in 1.5.2

✨ New Features (1.5.1)

Labels Tab: Emoji-based tracking for any quantifiable data
Logs Tab: Organized callout-based logging system
Greek Vase Logo: Beautiful carved-out H design
Enhanced UI: Improved Home tab with responsive design

🔧 Improvements (1.5.2)

BRAT Compatibility: Fixed plugin packaging for Git-based installation
Streamlined Deployment: Simplified release pipeline
Better Documentation: Updated README with comprehensive wiki content

🤝 Contributing

Contributions are welcome! Feel free to:

Open issues for bugs or feature requests
Submit pull requests for improvements
Share your Habsiad workflows and templates

Visit our GitHub repository and Wiki for more information.

💖 Support

If you benefit from Habsiad, please consider supporting its development:

📞 Contact

Issues & Support: GitHub Issues
Email: habsiad+dotmavriq@gmail.com
Documentation: Wiki

<div align="center"> Made with ❤️ by <a href="https://github.com/dotMavriQ">dotMavriQ</a> </div>

Habsiad

Install / Use

README