Skip to content

SuperChamp234/habitica-sync

Repository files navigation

Habitica Sync in Obsidian

This plugin for Obsidian incorporates a view to display and interact with the task management app Habitica.

Please open issues for any bugs/functionality requests :)

Usage

The plugin's view is enabled by clicking on the "Open Habitica Pane" option in the side ribbon (default hotkey is Ctrl+Shift+H).

To sync your Habitica account, go to the settings page of the plugin and enter your user ID and API token credentials.

Features

Pane View

View stats (HP, XP, coins)

Views

Task Information:

  • Title, description, subtasks
    • Markdown and emoji support

Tabs:

  • To Do's
    • Active/Completed
  • Dailies
    • Due/Not Due/Completed
    • Image from Gyazo
  • Habits
    • Image from Gyazo
  • Rewards

Interactivity

  • Check off tasks/dailies in the view
    • Can uncheck completed habits/todos
    • Image from Gyazo
  • modify habit counters (+/-)

Settings

The following two inputs help fetch your user data to be displayed in the Obsidian view:

  • Habitica User ID: You can find this by clicking on the "User" icon in the top right of the Habitica webapp, "Settings", then "API"
  • Habitica Token API: You can find this by clicking on the "User" icon in the top right of the Habitica webapp, "Settings", then "API"
  • Show Task Descriptions: Toggles whether description/notes for tasks will be shown or not
  • Show Subtasks: Toggles whether subtasks for to do's/dailies will be shown or not

Roadmap

Feel free to support us and donate!

Buy Me a Coffee at ko-fi.com