habitica-sync/README.md

# 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](https://i.gyazo.com/1966b17f954dcffa954922570e860a06.png)](https://gyazo.com/1966b17f954dcffa954922570e860a06)
- Habits
	- [![Image from Gyazo](https://i.gyazo.com/280494e620fc91548838d5b29a62652b.png)](https://gyazo.com/280494e620fc91548838d5b29a62652b)
- Rewards
#### Interactivity
- Check off tasks/dailies in the view
	- Can uncheck completed habits/todos
	- [![Image from Gyazo](https://i.gyazo.com/efb858cd9d54f9d9df936da1bd5858ed.gif)](https://gyazo.com/efb858cd9d54f9d9df936da1bd5858ed)
- 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!*

<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' />
Update readme 2021-10-17 18:18:08 -06:00			`# Habitica Sync in Obsidian`
Update README.md 2021-10-16 09:08:30 -07:00			`This plugin for Obsidian incorporates a view to display and interact with the task management app Habitica.`

Update README.md 2021-10-23 14:54:50 -06:00			`Please open issues for any bugs/functionality requests :)`

Update README.md 2021-10-16 09:08:30 -07:00			`## Usage`
Update README.md 2021-10-23 14:54:50 -06:00			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.`
Update README.md 2021-10-16 09:08:30 -07:00			`## Features`
Update README.md 2021-10-23 14:54:50 -06:00			`### Pane View`
Update README.md 2022-01-14 23:53:19 -06:00			`#### 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](https://i.gyazo.com/1966b17f954dcffa954922570e860a06.png)](https://gyazo.com/1966b17f954dcffa954922570e860a06)`
			`- Habits`
			`- [![Image from Gyazo](https://i.gyazo.com/280494e620fc91548838d5b29a62652b.png)](https://gyazo.com/280494e620fc91548838d5b29a62652b)`
			`- Rewards`
			`#### Interactivity`
			`- Check off tasks/dailies in the view`
			`- Can uncheck completed habits/todos`
			`- [![Image from Gyazo](https://i.gyazo.com/efb858cd9d54f9d9df936da1bd5858ed.gif)](https://gyazo.com/efb858cd9d54f9d9df936da1bd5858ed)`
			`- modify habit counters (+/-)`

			`### Settings`
Update README.md 2021-11-21 02:14:41 -06:00
			`The following two inputs help fetch your user data to be displayed in the Obsidian view:`
Update README.md 2021-10-16 09:08:30 -07:00			`- 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"`
Merge branch 'main' into dev 2022-01-15 09:51:09 +05:30			`- Show Task Descriptions: Toggles whether description/notes for tasks will be shown or not`
Update README.md 2022-01-14 23:53:19 -06:00			`- Show Subtasks: Toggles whether subtasks for to do's/dailies will be shown or not`
Update README.md 2021-10-17 05:51:51 -07:00
			`## Roadmap`
updated readme, add kofi link 2021-10-19 21:40:28 -06:00
Update README.md 2021-10-23 14:54:50 -06:00			`Feel free to support us and donate!`
updated readme, add kofi link 2021-10-19 21:40:28 -06:00
			`<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' />`
Update README.md 2021-11-21 02:14:41 -06:00