Skip to content

INITIAL RELEASE

Latest
Latest
Compare
Choose a tag to compare
@dotMavriQ dotMavriQ released this 03 Nov 17:38
· 2 commits to main since this release
1.0
e853aad
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Learn about vigilant mode.

Obsitica Plugin - Version 1.0.0 Release Notes

Release Date: October 27, 2024

Overview

Obsitica is an Obsidian plugin that integrates Habitica with Obsidian, allowing you to track your habits and dailies directly within your Obsidian vault. This plugin combines the power of Habitica's gamified habit tracking with the flexibility of Obsidian's note-taking and journaling capabilities.

Current Features

1. Generate Habits & Dailies

  • Description: Fetch your completed habits and dailies from Habitica and insert them into your daily journal notes in Obsidian.
  • How It Works:
    • Command: Use the "Generate Habits & Dailies" command from the command palette or via the shortcut Ctrl+Shift+H (Cmd+Shift+H on Mac).
    • Data Retrieval: The plugin utilizes the Habitica API to securely fetch your tasks, including habits and dailies.
    • Data Insertion: Inserts a formatted list of your completed habits and dailies into the currently open daily journal note.
    • Requirements:
      • Your Habitica User ID and API Token must be set in the plugin settings.
      • The command must be run within a note located in your specified journal folder and named in the YYYY-MM-DD.md format.

2. Customizable Journal Folder

  • Description: Specify the folder where your daily journal notes are stored.
  • How It Works:
    • Settings: In the Obsitica settings tab, you can set the "Journal Folder Name" to match your preferred folder.
    • Case-Insensitive: The folder name check is case-insensitive, accommodating folder names like "Journal", "JOURNAL", or "journal".
    • Usage: The plugin uses this folder name to locate your daily journal notes and ensure commands are executed in the correct context.

3. Obsitica Sidebar View

  • Description: Access plugin information and future features via the Obsitica sidebar.
  • Tabs:
    • ℹ️ Info Tab:
      • Displays plugin details, version, and available shortcuts.
      • Provides a brief overview and additional information about the plugin.
    • 🔎 Data Quality Diagnostics (Coming Soon):
      • Placeholder for future functionality to analyze data quality within Obsidian.
    • ⬆️ Frontmatter Glossary (Coming Soon):
      • Placeholder for future functionality to manage frontmatter properties across your notes.
  • How It Works:
    • The sidebar is activated when the plugin is loaded.
    • You can navigate between tabs using the emoji icons.
    • The Info Tab is fully implemented in this release.

4. Enhanced User Interface

  • Custom Styles: The plugin includes a styles.css file to enhance the appearance of the sidebar and its components.
  • Frontmatter Collapse: Provided CSS to ensure the frontmatter section is collapsed by default when opening notes.

How It Delivers These Features

  • Integration with Habitica API:
    • Utilizes Habitica's public API to securely fetch user data.
    • Requires users to input their Habitica User ID and API Token in the plugin settings.
  • Commands and Hotkeys:
    • Provides commands accessible via the command palette.
    • Includes keyboard shortcuts for quick access to core functionalities.
  • Settings Configuration:
    • Accessible settings tab within Obsidian to configure plugin options.
    • Allows users to specify their journal folder name and Habitica credentials.
  • User Interface Enhancements:
    • Custom CSS styles improve the visual appeal and user experience.
    • The sidebar view offers easy navigation between different plugin features.

Planned Features for Future Implementation

1. Data Quality Diagnostics (🔎)

  • Description: Analyze and report on the data quality of your notes within Obsidian.
  • Planned Functionality:
    • Identify missing or inconsistent frontmatter properties.
    • Highlight notes that lack certain tags or links.
    • Provide actionable suggestions to improve note-taking consistency.

2. Frontmatter Glossary (⬆️)

  • Description: Manage and standardize frontmatter properties across your notes.
  • Planned Functionality:
    • Create and maintain a glossary of frontmatter keys and their intended uses.
    • Provide templates or suggestions when creating new notes.
    • Automate the addition of standardized frontmatter to existing notes.

3. Two-Way Sync with Habitica

  • Description: Enable two-way synchronization between Habitica and Obsidian.
  • Planned Functionality:
    • Allow creating and updating Habitica tasks from within Obsidian.
    • Reflect changes made in Obsidian back to Habitica in real-time.
    • Provide conflict resolution strategies when discrepancies arise.

4. Improved Mobile Support

  • Description: Enhance the plugin's usability on mobile devices.
  • Planned Functionality:
    • Optimize the sidebar view and UI elements for smaller screens.
    • Ensure all features are accessible and functional on mobile versions of Obsidian.

Installation and Setup

1. Download the Plugin

  • Clone or download the Obsitica plugin repository from GitHub.

2. Build the Plugin

  • Navigate to the plugin directory in your terminal.

  • Install dependencies:

    npm install

  • Build the plugin:

    npm run build

3. Install in Obsidian

  • Copy the following files to your Obsidian plugins directory:

    YourVault/.obsidian/plugins/obsitica/
    • main.js
    • manifest.json
    • styles.css (optional, for custom styles)
    • main.js.map (optional, for debugging)

4. Enable the Plugin

  • Open Obsidian.
  • Navigate to Settings > Community Plugins.
  • Disable Safe Mode if it's enabled.
  • Enable the Obsitica plugin.

Configuration

Set Habitica Credentials

  • Go to Settings > Obsitica.
  • Enter your Habitica User ID and Habitica API Token.
    • You can find these in your Habitica account settings under API Settings.

Specify Journal Folder Name

  • Set the Journal Folder Name to match the folder where your daily journal notes are stored.
  • Note: This folder name is case-insensitive due to the recent update.

Usage

Generate Habits & Dailies

  • Open a daily journal note within your specified journal folder.
  • Ensure the note follows the YYYY-MM-DD.md naming convention.
  • Use the command palette (press Ctrl+P or Cmd+P) and select Generate Habits & Dailies, or use the shortcut Ctrl+Shift+H (Cmd+Shift+H on Mac).
  • The plugin will fetch your completed habits and dailies from Habitica and insert them into the note.

Access the Obsitica Sidebar

  • Open the Obsitica sidebar by clicking on the Obsitica icon in the sidebar.
  • Navigate between tabs:
    • ℹ️ Info Tab: View plugin information and shortcuts.
    • 🔎 Data Quality Diagnostics: (Coming Soon).
    • ⬆️ Frontmatter Glossary: (Coming Soon).

Feedback and Contributions

Feedback, bug reports, and contributions are highly welcome. Please submit issues or pull requests via the GitHub repository:

Acknowledgments

  • Obsidian Community: For their support and contributions.
  • Habitica Developers: For providing an excellent API to integrate with.
  • Special Thanks: To my partner for collaborating on our journey with Habitica.

Note: This release focuses on integrating Habitica's habit and daily tracking into Obsidian's journaling workflow. Future updates will expand on data analysis and management features to further enhance productivity and note-taking efficiency.

Thank you for using Obsitica! If you have any questions or need further assistance, feel free to reach out.

Happy Note-Taking and Habit Tracking! 📓✅

Assets 2
Loading