39 lines
2.1 KiB
Markdown
39 lines
2.1 KiB
Markdown
# 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
|
|
[](https://gyazo.com/4266d01941e71fef41819ea8a6b6592e)
|
|
[](https://gyazo.com/697a58b8e7ffd3df86a2944b6abbaa92)
|
|
- View stats (HP, XP, coins)
|
|
- View to do's, dailies, and habits
|
|
- Tab for active/completed tasks and dailies
|
|
|
|
#### Check off tasks/dailies in the view, modify habit counters (+/-)
|
|
[](https://gyazo.com/5759e12bc5267711c5e03485a6d72c2f)
|
|
- Can uncheck completed habits/todos as shown above
|
|
|
|
## 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
|
|
- **Due date format:** Format in which the due date is displayed
|
|
- **Show Checklist items:** Toggles the checklist items for a task.
|
|
|
|
|
|
## Roadmap
|
|
We will be implementing additional features including:
|
|
- Add/delete/customize tasks and habits
|
|
|
|
*Feel free to support us and donate!*
|
|
|
|
<a href='https://ko-fi.com/leonardandran' target='_blank'><img height='35' style='border:0px;height:46px;' src='https://az743702.vo.msecnd.net/cdn/kofi3.png?v=0' border='0' alt='Buy Me a Coffee at ko-fi.com' />
|
|
|