GitHub's octocat logo

GitHub is a website that Habitica uses to house its source code, track bugs and issues, and manage certain types of contributions. For further information on GitHub in general, see Wikipedia's entry.


Source CodeEdit

The source code for the main Habitica site is stored in the habitica repository.

The source code for the mobile editions of Habitica for Android and iOS have their own repositories.

The Chrome extensions have their own Chrome repository.

Images and AlgorithmsEdit

The pixel art is stored in the "assets" directory in the habitica repository.

Most of the algorithms - such as when you score a task - are stored in the "common" directory in the habitica repository, which is used for both mobile and web. That way it can be used in multiple locations and the code does not have to be duplicated.

Special RewardsEdit

Blacksmiths (programmers) can contribute new code or bug fixes through GitHub for contributor rewards.

Glow hammer gif by zoebeagle
Certain Habitica bugs on GitHub have special rewards. The Critical Hammer of Bug Crushing is a decorative weapon given to anyone who manages to solve a bug labeled as "priority: critical" on GitHub.

Solutions for bugs categorized on GitHub with "type: bounty" can yield the Blacksmith monetary awards from BountySource. A list of those bugs are also available on the BountySource page for Habitica.

Bugs and IssuesEdit

With the capacity to house source code, GitHub also provides issue tracking for any repository on its servers. A GitHub account is needed to log a new issue or comment on an existing one.

However, using GitHub is usually not necessary for reporting bugs. Instead, you can go to the Habitica website and click on Help > Report a Bug to access the Report a Bug guild. If your bug is complex or requires significant work or detailed information from you, you may be asked to report it on GitHub.


GitHub issue list with multiple label filters active

Issues in GitHub are assigned labels which identify the type, priority and status of the issue as well as section of Habitica the issue is related to. You can filter issues by labels or multiple labels in the GitHub issue list.