diff --git a/source/_integrations/habitica.markdown b/source/_integrations/habitica.markdown index c5db4a87d03..03faae79d25 100644 --- a/source/_integrations/habitica.markdown +++ b/source/_integrations/habitica.markdown @@ -20,40 +20,42 @@ ha_config_flow: true ha_integration_type: integration --- -This integration allows you to monitor and manage your Habitica profile. This integration exposes the [Habitica's API](https://habitica.com/apidoc/) as a Home Assistant service. It supports multiple users and allows you to automate checking out your habits and daily tasks or casting magics using Home Assistant. +The Habitca {% term integration %} enables you to monitor your adventurer's progress and stats in Home Assistant and seamlessly integrates your to-do's and daily tasks. {% include integrations/config_flow.md %} -There is currently support for the following device types within Home Assistant: +## Sensors -## Player data - -Allows you to view and monitor your player data from [Habitica](https://habitica.com/) in Home Assistant. The following sensors will be available: - -- Player's name -- Player's health points -- Player's max health -- Player's mana points -- Player's max mana points -- Player's experience -- Player's experience to the next level -- Player's level -- Player's gold pieces -- Player's class +- **Class:** Indicates the class of your character (Warrior, Rogue, Healer, or Mage). +- **Display name:** Shows the character's display name. +- **Experience:** Displays the current experience points of the character (for example, "144 XP"). +- **Gold:** Shows the amount of gold owned by your character (for example, "22.29 GP"). +- **Health:** Shows the current health points of the character (for example, "42 HP"). +- **Level:** Displays the current level of the character. +- **Mana:** Displays the current mana points of your character (for example, "61 MP"). +- **Max. mana:** Indicates the maximum mana points your character can have at the current level (for example, "70 MP"). +- **Next level:** Indicates the remaining experience points needed to reach the next level (for example, "440 XP"). +- **Habits:** Shows the number of habits being tracked (for example, "4 tasks"). +- **Rewards:** Displays the rewards that can be redeemed (for example, "1 task") ## To-do lists The following Habitica tasks are available as to-do lists in Home Assistant. You can add, delete, edit and check-off completed tasks -- To-do's -- Dailies +- **To-Do's:** Displays a comprehensive list of active and completed to-dos. Each to-do includes its due date if applicable, allowing you to check them off, edit them, delete them, and create new to-dos seamlessly. +- **Dailies:** Shows the daily tasks that need to be completed today or in the future. Tasks completed yesterday can still be marked off as "yesterdailies" until a new day starts. -## Tasks +## Button controls -Allows you to view and monitor your tasks from [Habitica](https://habitica.com/) in Home Assistant. The following sensors will be available: +- **Start my day:** Initiates daily routine actions in Habitica, including resetting your dailies, deal damage from unfinished dailies and quest bosses, habits adjustment, buff expiration, and mana regeneration based on completed dailies. +- **Revive from death:** Allows your character to revive from death in Habitica. Upon revival, HP is fully restored, but your character will lose all gold, 1 level, all experience points, one stat point, and one piece of equipment. +- **Buy a health potion:** Allows your character to purchase a health potion in Habitica. Instantly applies the potion upon purchase, healing 15 HP at a cost of 25 GP. +- **Allocate all stat points**: Assigns all unallocated stat points based on the previously set automatic allocation method. If no method is set, all points are assigned to strength (STR). + +## Switch controls + +- **Rest in the Inn:** When enabled, allows your character to rest in the inn in Habitica, pausing damage dealt from dailies and quest bosses. -- Habits -- Rewards ## API Service @@ -142,12 +144,12 @@ Also an event `habitica_api_call_success` will be fired with the following data: ## Templating -`sensor.habitica_USER_dailys`, `sensor.habitica_USER_habits`, `sensor.habitica_USER_rewards`, and `sensor.habitica_USER_todos` have state attributes listing the user's respective tasks. For example, you can see this information in **Developer Tools** -> **States** -> `sensor.habitica_USER_dailys` -> **Attributes**, or by adding a [Markdown card](/dashboards/markdown/) to a dashboard with the following code: +`sensor.habitica_USER_habits` and `sensor.habitica_USER_rewards` have state attributes listing the user's respective tasks. For example, you can see this information in **{% my developer_states title="Developer Tools > States" %}** under `sensor.habitica_USER_habits` > **Attributes**, or by adding a [Markdown card](/dashboards/markdown/) to a dashboard with the following code: {% raw %} ```jinja -{% for key, value in states.sensor.habitica_USER_dailys.attributes.items() %} +{% for key, value in states.sensor.habitica_USER_habits.attributes.items() %} {% if 'text' in value | string %} {{ loop.index }}. {{ value.text }} {% endif %}