maxmoon's Scribbles for Habitica

A collection of scripts (bash & python), which use the Habitica Api following the Guidance for Comrades to complete simple tasks with Habitica.

This collection will grow every time I help someone in the Aspiring Comrades Guild with examples or if I just want to solve a small problem.

Everyone who helps to expand this collection can be in the authors list of the script the person contributed to.

Installation

To install the necessary libraries, which are used in this Python scripts, you can use the requirements.txt like this:

pip install -r requirements.txt

After that you could execute any Python script and if it will not find your API data, it will ask you to enter it and it creates a config file for you.

Scripts

habitica-allocate_stat_points.py

You can choose how many and for which character stat you want to invest the

author: maxmoon (utopify.org)
copyright 2021

habitica-buy_enchanted_armoire.py

Buy enchanted armoire, but choose the limit of gold, which should be left.

Example:
If you want to keep 1k gold, you can use this command
./habitica-buy_enchanted_armoire.py -g 1000

author: maxmoon (utopify.org)
copyright 2021

habitica-buy_enchanted_armoire.sh

Buy an enchanted armoire.

author: maxmoon (utopify.org)
copyright 2021

habitica-check_off_dailies.py

Get a check list of all dailies

author: maxmoon (utopify.org)
copyright 2021

habitica-check_off_habits.py

Get a check list of all habits

author: maxmoon (utopify.org)
copyright 2021

habitica-check_reward.py

This is a script for i3blocks (tool for i3 tiling window manager), which shows if new items are in the reward row.
If it finds other items than enchanted armoire and health potion, it will show an gift item in your status bar.
You can put following lines in your ~/.i3blocks.conf to check every 3 hours for new items:

[habitica-reward]
command=habitica-check_reward.py
color=#dd8d00
interval=10800

author: maxmoon (utopify.org)
copyright 2021

habitica-create_and_check_off.py

Have you forgoten to create a task, but have been productive anyway and just want to check this task off.
No Problem! With this script you can create and check off the amount of todos you want at the same time.
It is even possible to set the difficulty of the tasks, for example 5 trivial tasks would be:
habitica-create_and_check_off.py -d 1 -a 5
Or 3 normal tasks would be:
habitica-create_and_check_off.py -d 3 -a 3
trivial = 1; easy = 2; normal = 3; hard = 4

author: maxmoon (utopify.org)
copyright 2021

habitica-delete_all_todos.py

If you over-planed your life and you want to start all over, you can use this script, which will delete all your todos.
A warning message will appear before deletion, which looks like this:
"Do you want to delete all (521) todos on Habitica?[Y|n]:"
If a todo belongs to a challenge, you will be asked if you want to leave the running challenge, before removing the todo otherwise it will be skipped.

author: maxmoon (utopify.org)
copyright 2021

habitica-drain_hp_now.py

Drain your HP immediately for a fast punishment for e.g. food wasting or wasting time

author: maxmoon (utopify.org)
copyright 2021

habitica-open_mystery_item_box.sh

Open one mystery item box, which only subscribers get.

author: maxmoon (utopify.org)
copyright 2021

habitica-party-accept_pending_quest.sh

This script just accepts a pending quest if you don't want to do it by hand.
I even use it in a cronjob to execute it every 2 hours
42 */2 * * * habitica-accept_pending_quest.sh

author: maxmoon (utopify.org)
copyright 2021

habitica-party-count_classes.sh

Calculates the current amount of all classes in a party.
The result will be posted in the party chat, if the first argument is post

author: maxmoon (utopify.org)
copyright 2021

habitica-party-damage_to_boss.sh

This script shows a prognose of the damage / collected items of the current day.
If the first parameter is post, the message will be posted in the party chat

author: maxmoon (utopify.org)
copyright 2021

habitica-party-quest_reminder.py

Write a chat message with an @ to the people in your party, which did not accept or decline pending quest.

If you want to run this script every hour as a cron, you can use following command:
56 */1 * * * habitica-party-quest_reminder.py

author: maxmoon (utopify.org)
copyright 2021

habitica-party-start_pending_quest.sh

This script force starts pending quests
If you want to force start a quest every day at 8 pm you could use this cron:
0 20 * * * habitica-start_pending_quest.sh

author: maxmoon (utopify.org)
copyright 2021

habitica-pom_exercise_break.py

This script is part of a challenge from Habitica (more information: https://habitica.com/groups/guild/6afa6259-19e4-4e22-b02c-9a11d65dc223)
In this challenge you do PEB (Physical Exercise Breaks) between every pom (Pomodoro Technique).
It sorts all the physical tasks and shows you the one on top you did the least.
With this script and challenge you can train all your muscles of your body within a week.

author: maxmoon (utopify.org)
copyright 2022

habitica-purchase_gems.sh

Purchase 50 gems. 50 is the limit for long subscribers.

author: maxmoon (utopify.org)
copyright 2021

habitica-set_gold_and_purchase_gems.py

Set gold to at least 1020 if it's lower and buy as many gems as possible

Why 1020 gold? To reduce requests this script will start to buy gems. The response message contains the amount of gold you have and will be used to set the amount of gold, if it is needed. The maximum amount of gems you can buy is 50 and one costs 20. So you need 1000 gold and 20 gold will be left for the next month, because the script starts with buying gems and not checking if you have enough gold. Perfect for people who don't care about gold.

author: maxmoon (utopify.org)
copyright 2022

habitica-show_user_data.py

Get user data of a user.

author: maxmoon (utopify.org)
copyright 2021

habitica-start_cron.sh

Just a simple script to trigger cron without visiting the website.
Attention! Unchecked dailies will be ignored and there is no way to check them off afterwards.

author: maxmoon (utopify.org)
copyright 2021