habitica README

The project's README from github.com/HabitRPG/habitica. As one markdown file: README.md.

Public pull request submissions paused as of August 4, 2026

Due to changes in the tech landscape and in how our player base interacts with Habitica on various platforms, we have made the decision to pause our acceptance of code-based contributions (Blacksmith tiers). Our codebase will remain open-source and publicly visible. If you’d like to know more about this pause, you can find additional details on the GitHub wiki.

⚠️ No AI-Generated Code Policy

This repository prohibits the submission of code generated by large language models (LLMs), AI coding assistants, or automated generation tools. All code must be authored entirely by humans. AI-assisted commits will be rejected during pull request reviews.

Habitica Build Status

Habitica is an open-source habit-building program that treats your life like a role-playing game. Level up as you succeed, lose HP as you fail, and earn Gold to buy weapons and armor!

Want to contribute code to Habitica? We're always looking for assistance on any issues in our repo with the "Help Wanted" label. The wiki pages below and the additional linked pages will tell you how to start contributing code and where you can seek further help or ask questions:

Interested in contributing to Habitica’s mobile apps? Visit the links below for our mobile repositories.

Habitica's code is licensed as described at https://github.com/HabitRPG/habitica/blob/develop/LICENSE

Found a bug? Please report it to admin email rather than create an issue (an admin will advise you if a new issue is necessary; usually it is not).

Creating a third-party tool? Please review our API Usage Guidelines to ensure that your tool is compliant and maintains the best experience for Habitica players.

Have any questions about Habitica or contributing? See the links in the Habitica website's Help menu. There’s FAQ’s, guides, and the option to reach out to us with any further questions!

habitica (HabitRPG/habitica)

mongodb
Searching Database…

14.2K ·GitHub
What is this?Habitica is an open-source habit-building app that turns your real-life goals and habits into a role-playing game: you level up for good behavior, lose HP for bad behavior, and earn Gold to buy weapons and armor for your avatar.
Is this repo the mobile app or the web app?This repo is Habitica's web app and backend (Node/Express server with a Vue client, backed by MongoDB). The Android and iOS apps are maintained in separate repositories.
How do I run this locally for development?Follow the 'Setting up Habitica Locally' wiki guide, which walks through installing dependencies and configuring a local dev/test instance; a docker-compose setup is also provided in the repo.
Do I need Node.js and MongoDB set up first?Yes — the project requires Node 20 and npm ^10 per package.json engines, and stores all app data in MongoDB.
What do I actually earn for completing habits and to-dos?You earn experience points and Gold for completing dailies, habits, and to-dos, which you can spend on weapons, armor, and other items for your in-game avatar.
What happens if I keep failing my tasks?Your character loses HP for missed dailies and bad habits, and if HP hits zero your character can 'die', mirroring traditional RPG mechanics.
Can third-party developers build tools on top of Habitica?Yes, Habitica exposes a public API, and third-party tool makers are asked to follow the API Usage Guidelines to stay compliant and keep the player experience consistent.
Creator
HabitRPG
Size
1.6 GB
Stars
14.2K
Age
14y
Commits · 90 Days