mirror of
https://github.com/sudoxnym/habitica-android.git
synced 2026-04-14 19:56:32 +00:00
81 lines
No EOL
3.4 KiB
Markdown
81 lines
No EOL
3.4 KiB
Markdown
# Habitica for Android
|
|
|
|
[](https://gitter.im/HabitRPG/habitrpg-android?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
|
|
|
[Habitica](https://habitica.com) is an open source habit building program which treats your life like a Role Playing Game. Level up as you succeed, lose HP as you fail, earn money to buy weapons and armor. This repository is related to the Android Native Application.
|
|
|
|
It's also on Google Play:
|
|
|
|
<a href="https://play.google.com/store/apps/details?id=com.habitrpg.android.habitica">
|
|
<img alt="Get it on Google Play"
|
|
width="185"
|
|
src="https://play.google.com/intl/en_us/badges/images/generic/en-play-badge.png" />
|
|
</a>
|
|
|
|
Having the application installed is a good way to be notified of new releases. However, clicking "Watch" on this
|
|
repository will allow GitHub to email you whenever we publish a release.
|
|
|
|
|
|
# What's New
|
|
|
|
See the project's Releases page for a list of versions with their changelogs.
|
|
|
|
##### [View Releases](https://github.com/HabitRPG/habitrpg-android/releases)
|
|
|
|
If you Watch this repository, GitHub will send you an email every time we publish an update.
|
|
|
|
## Contributing
|
|
|
|
For an introduction to the technologies used and how the software is organized, refer to [Contributing to Habitica](http://habitica.wikia.com/wiki/Contributing_to_Habitica#Coders_.28Web_.26_Mobile.29) - "Coders (Web & Mobile)" section.
|
|
|
|
Thank you very much [to all contributors](https://github.com/HabitRPG/habitrpg-android/graphs/contributors).
|
|
|
|
#### Steps for contributing to this repository:
|
|
|
|
1. Fork it
|
|
2. Create your feature branch: `git checkout -b my-new-feature`
|
|
3. Commit your changes: `git commit -am 'Add some feature'`
|
|
4. Push to the branch: `git push origin my-new-feature`
|
|
5. Create new Pull Request
|
|
* Don't forget to include your Habitica User ID, so that we can count your contribution towards your contributor tier
|
|
|
|
### Code Style Guidelines
|
|
We follow the code style guidelines outlined in [Android Code Style Guidelines for Contributors](https://source.android.com/source/code-style.html).
|
|
|
|
You can install our code style scheme to Intellij and/or Android Studio via this shell command:
|
|
|
|
$ ./install-codestyle.sh
|
|
|
|
## Build Instructions
|
|
|
|
### Config Files
|
|
|
|
1. Setup Habitica build config files by simply copying or renaming the example habitica files:
|
|
|
|
`habitica.properties.example` to `habitica.properties`
|
|
|
|
`habitica.resources.example` to `habitica.resources`
|
|
|
|
You also need `google-services.json`. Download it from Firebase in the next step.
|
|
|
|
|
|
Note: this is the default production `habitica.properties` file for habitica.com. If you want to use a local Habitica server, please modify the values in the properties file accordingly.
|
|
|
|
|
|
|
|
|
|
2. Go to https://console.firebase.google.com
|
|
|
|
a. Register/Login to Firebase. (You can use a Google account.)
|
|
|
|
b. Create a new project called Habitica
|
|
|
|
c. Create two apps in the project: `com.habitrpg.android.habitica` and `com.habitrpg.android.habitica.debug`
|
|
|
|
d. Creating each app will generate a `google-services.json` file. Download the `google-services.json` file from the second app and put it in `\Habitica\`
|
|
|
|
You can skip the last part of the app creation wizards (where you run the app to verify installation).
|
|
|
|
|
|
|
|
3. If using Android Studio, click Sync Project with Gradle Files. Update Android Studio if it asks you to update. Run Habitica. |