PolyPaw/habitica-sync
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
ransurf 2021-10-23 14:54:50 -06:00 • committed by GitHub
parent 68eff40b6b
commit 2aa6c949fb
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

22
README.md
View file

@ -1,13 +1,23 @@
# 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. To sync your account, go to the settings page of the plugin and enter your user ID and API token credentials.
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
- View current HP and XP
- View todos, dailies, and habits
- Check off tasks/dailies in the view, which sync to habitica website
- Modify habit counters (+/-)
### Pane View
#### View HP, XP, todos, dailies, and habits
[![Image from Gyazo](https://i.gyazo.com/4266d01941e71fef41819ea8a6b6592e.png)](https://gyazo.com/4266d01941e71fef41819ea8a6b6592e)
[![Image from Gyazo](https://i.gyazo.com/697a58b8e7ffd3df86a2944b6abbaa92.png)](https://gyazo.com/697a58b8e7ffd3df86a2944b6abbaa92)
- Tab for active/completed tasks
#### Check off tasks/dailies in the view, modify habit counters (+/-)
[![Image from Gyazo](https://i.gyazo.com/5759e12bc5267711c5e03485a6d72c2f.gif)](https://gyazo.com/5759e12bc5267711c5e03485a6d72c2f)
- Can uncheck completed habits/todos as shown above
## Settings
- **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"
@ -19,6 +29,6 @@ We will be implementing additional features including:
- Add/delete/customize tasks and habits
- View/claim rewards
Feeling generous?
*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' />