rbavishi / Habitican-Curse

Habitican Curse

• A Terminal Application for HabitRPG with basic terminal GUI features. Implemented using the curses library.

New Updates

• Task modification has been added and the documentation has been updated.

Configuring Habitican Curse

• You will need to have a 256-color terminal, with support for basic unicode symbols. The shell used in the screenshots is the simple GNOME shell and will suffice.

• You can install Habitican Curse using pip - sudo pip install habitican_curse

• Launch the program by typing habitican-curse in the terminal.

• If not done already, the program will ask for you UUID and API-KEY. This will be stored in plaintext in a file named .habiticarc in your home directory. As per my knowledge, I don't know of any way to encrypt this file and still not waste user-time by asking them to provide the key for decryption. I'd suggest changing file permissions to prevent read/write across ssh or by another user.

• WARNING: There can be undefined behavior if your supplied UUID and KEY are incorrect. Also please do not use Ctrl-C to exit. Exception handling has not been implemented completely. Only use :q to exit.

Acknowledgements

• Habitican Curse uses the amazing requests library for communicating with the Habitica server.

• Functions used in data-display are borrowed from the excellent data-display tool by LadyAlys (https://github.com/Alys/tools-for-habitrpg)

Common Commands

• :help - View detailed description of all the commands.

• Use arrow keys for movement. You can also the Vim-style h, j, k, l bindings for movement.

• Press m to mark an item for toggling its completion status. Press + and - for habits. Press the key again to unmark it. Similarly press d to toggle deletion status

• :w to write any changes to server. The completed status for the marked items changes. Health, Gold, XP are automatically updated.

• :r to reload the tasks from the server - basically rebooting the interface.

• c to display the checklist(if any) for the highlighted task. Press arrow keys to navigate, m for marking, d for delete, and ENTER for changing name etc. Press enter on Add an Item to add a new checklist item.

• :q to exit.

• :et, :ed, :eh to create a TODO, Daily and a Habit respectively.

• :set <options> will modify a task. See :help for more details.

Party

• If you are a member of a party, you can type :party to display the chat messages and quest details (if any).

Data-Display

• :data-display to display some basic details like "Est. Damage to You", "Est. Damage to Party", "Est. Damage to Boss" etc.

ScreenShots

Main Task Menu

Task Marking

Party Details

Checklist Example