Skip to content

Commit

Permalink
Merge pull request #44 from comradekingu/patch-2
Browse files Browse the repository at this point in the history 
README reworked
  • Loading branch information
@nethical6
nethical6 authored Oct 21, 2024
2 parents 06d78df + 73c5c91 commit 099aa79
Showing 1 changed file with 65 additions and 63 deletions.
128 changes: 65 additions & 63 deletions Readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,43 +5,43 @@
[![GitHub contributors](https://img.shields.io/github/contributors/nethical6/digipaws)](https://github.com/nethical6/digipaws/graphs/contributors)
[![Discord Server](https://img.shields.io/badge/Discord%20Server-white?style=flat&logo=discord)](https://discord.com/invite/Vs9mwUtuCN)
[![Telegram Group](https://img.shields.io/badge/Telegram%20Group-blue?style=flat&logo=telegram)](https://t.me/digipaws6)
[![Total downloads](https://img.shields.io/github/downloads/nethical6/digipaws/total)](https://github.com/nethical6/digipaws/releases)
[![Repository Size](https://img.shields.io/github/repo-size/nethical6/digipaws)](https://github.com/nethical6/digipaws)
[![Total downloads](https://img.shields.io/github/downloads/nethical6/digipaws/total)](https://github.com/nethical6/digipaws/releases)
</div>

<div align="center">
<a href="https://play.google.com/store/apps/details?id=nethical.digipaws&hl=en_IN&pli=1">
<img alt="Get it on Google Play"
height="80"
src="https://play.google.com/intl/en_us/badges/images/generic/en_badge_web_generic.png" />
</a>
<a href="https://f-droid.org/packages/nethical.digipaws/">
<img alt="Get it on F-Droid"
height="80"
src="https://f-droid.org/badge/get-it-on.png" />
</a>
<a href="https://play.google.com/store/apps/details?id=nethical.digipaws&hl=en_IN&pli=1">
<img alt="Get it on Google Play"
height="80"
src="https://play.google.com/intl/en_us/badges/images/generic/en_badge_web_generic.png" />
</a>
</div>
DigiPaws is an open-source Android productivity utility designed to help users reduce screen addiction by regulating app usage through a gamified experience. The application offers three distinct modes—Easy, Adventure, and Hard—each with unique features and challenges to promote healthy screen time habits.
Copylefted libre software solving screen addiction by regulating and gamifying app usage. Easy, Adventure, and Hard modes — each with features and challenges for healthy screen-time habits.


> [!IMPORTANT]
>This project is being re-written in kotlin with a new UI
>This project is being re-written in Kotlin with a new UI
> [!CAUTION]
> This project is experimental and not yet ready for full production. [Donate](https://nethical6.github.io/digipaws/donate)
> This project is experimental and not yet quite ready. [Donate](https://nethical6.github.io/digipaws/donate)
> [!CAUTION]
> If you are stuck and unable to uninstall the app. You can uninstall it via the safe mode. ][How to enter safe mode](https://www.androidauthority.com/how-to-enter-safe-mode-android-801476/)
> If stuck and unable to uninstall the app, it is possible via the safe mode. ][How to enter safe mode](https://www.androidauthority.com/how-to-enter-safe-mode-android-801476/)

## Features

- **Three Unique Modes**: Tailor your screen usage experience with Easy, Adventure, and Hard modes.
- **Gamified Challenges**: Earn Aura coins through quests like walking and use them to unlock app usage.
- **Open Source**: Fully transparent and free to use, with the source code available for community contributions.
- **Productivity Enhancement**: Helps build healthier digital habits and reduce screen addiction.
- **Versatile Blockers**: Take control of your digital environment by blocking apps, keywords, and unwanted in-app screens (e.g., YouTube shorts, comments).
- **Open Api**: Turn your existing application into a digipaws quest!! [Learn More](https://nethical6.github.io/digipaws/partners/)
- **Three Unique Modes**: Easy, adventure, or hard.
- **Gamified Challenges**: Earn Aura through quests like walking to unlock blocked-app usage.
- **Open Source**: Fully transparent and gratis. Source code and contributions.
- **Productivity Enhancement**: Healthier digital habits and reduced screen addiction.
- **Versatile Blockers**: Blocking apps, keywords, and unwanted in-app screens (e.g., YouTube shorts, comments).
- **Open API**: Turn your existing apps into a quest. [Learn More](https://nethical6.github.io/digipaws/partners/)

## Screenshots
Click on any image to enlarge it.
Expand All @@ -60,74 +60,75 @@ Click on any image to enlarge it.

### Easy Mode

In Easy Mode, DigiPaws provides gentle reminders to help you manage your screen time. When you attempt to access a blocked app, a warning screen appears. If you choose to proceed, a cooldown period starts. After the cooldown, another warning is displayed to remind you of your usage.
Genntle reminders repeated to keep you honest.

### Adventure Mode

Adventure Mode introduces a gamified experience to control screen time. To access a blocked app, you need Aura coins. These can be earned by completing quests such as quick walk. Each Aura coin grants 20 minutes of usage time for any blocked app, encouraging physical activity and mindful screen use. With every quest you perform, the difficulty rises.
The slop is in the immediacy of a quick km walk away, which might be a safe distance. \
Requires Aura earnt through quests to access a blocked app for 20 min. With every quest, the difficulty rises.

#### Quests
1. **Touch Grass** - Displace yourself out of the red zone on map. Verified using GPS.
2. **Squats** - Simply perform squats. Verified using AI.
3. **Pushups** - Simply perform pushups. Verified using AI.
4. **Focus Quest** - Apply the 90/20 study rule: Digipaws blocks all unnecessary applications except basic and productive apps like calling and SMS.
5. **Open API** - Learn [how to use our API](https://github.com/nethical6/digipause/blob/main/HowToUseApi.md)

> [!IMPORTANT]
> A custom time can be set for Focus quest when on Hard or Easy mode.
1. **Touch Grass** — Displace yourself out of the red zone on map. Verified using GPS.
2. **Squats** — Simply perform squats. Verified using AI.
3. **Pushups** — Simply perform pushups. Verified using AI.
4. **Focus Quest** — Apply the 90/20 study rule: Only basic productivity apps like calling and SMS.
5. **Open API** — Learn [how to use our API](https://github.com/nethical6/digipause/blob/main/HowToUseApi.md)

> [!IMPORTANT]
> Remember that only focus quest is available on lite version (same as the fdroid version) to reduce app size. Download the full version to enjoy all inbuilt quests. [Download](https://github.com/nethical6/digipaws/releases)
> A custom time can be set for focus quest in hard- or easy mode.
### Hard Mode

Hard Mode offers the most stringent control over app usage. In this mode, when you try to open a blocked app, the back button is automatically pressed without any warning or cooldown, preventing access entirely.
Prevents use of blocked apps altogether.

## Variants
There are two build variants with different features:

- `fullMode:` Contains additional inbuilt quests like touch grass, and workout. Requires google play services.
- `liteMode:` Contains a bare version without additional quests except focus quest. Relatively smaller in size and doesn't require google play services.
- `fullMode:` Contains additional inbuilt quests like touch grass, and workout. Requires google play services. [Download](https://github.com/nethical6/digipaws/releases)
- `liteMode:` Reduced size. (same as the F-Droid version) Contains a bare version without additional quests except focus quest. \
Relatively smaller in size and doesn't require Google Play services.

Note that the quest api works with both variants
Note that the quest API works with both variants

## Configuring

1. Launch DigiPaws on your Android device.
2. Provide all necessary permissions like Accessibility service, Notification, Draw over other apps etc
3. On Android 13+ devices, you need to additionally allow restricted settings before enabling the accessibility permission. Watch a tutorial [here](https://youtu.be/91B72lEpcqc?si=PCKKUSwM1aLdELqJ)
4. Choose your preferred mode: Easy, Adventure, or Hard.
5. Configure the apps and views you want to block and set your preferences.
6. Start using your device with DigiPaws managing your screen time.
1. Launch DigiPaws.
2. Grant necessary permissions like accessibility, notification, draw over other apps, etc.
3. On Android 13+ devices, additionally allow restricted settings before turning on the accessibility permission. Watch a tutorial [here](https://yewtu.be/watch?v=91B72lEpcqc)
4. Choose your preferred mode: Easy, adventure, or hard.
5. Pick apps and views to block and set your preferences.
6. Enjoy life and managed screen-time.


> [!TIP]
> This app relies exclusively on accessibility services to function. Because it requires sensitive permissions, please avoid downloading it from untrusted sources.
> This app relies on sensitive accessibility services to function. \
Avoid downloading it from untrusted sources.

## ToDo
- [x] Block reels
- [x] Block comments
- [x] Block explicit context
- [x] App blockers
- [x] Focus Quest
- [x] Anti-Uninstall
- [x] Customisable warning screen
- [x] Api for other developers to transform their existing apps into digipaw quests!
- [ ] Geoblocker (basically block things when a certain area is entered, like workplace)
- [ ] Block cusomtom user defined keywords
- [ ] Modular and downloadable view blockers
- [ ] expand the app to ios and desktop.
- [x] Block reels.
- [x] Block comments.
- [x] Block explicit context.
- [x] App blockers.
- [x] Focus quest.
- [x] Anti-uninstall.
- [x] Customisable warning screen.
- [x] API for other developers to transform their existing apps into quests!
- [ ] Geo-blocker (basically block things when a certain area is entered, like workplace).
- [ ] Block cusomtom user defined keywords.
- [ ] Modular and downloadable view blockers.
- [ ] Expand the app to ios and desktop.

## Thanks
- [**Osmdroid**](https://github.com/osmdroid/osmdroid) : Mapview used in Quest "TouchGrass"
- [**Osmdroid**](https://github.com/osmdroid/osmdroid) : Map view used in Quest "TouchGrass"
- [**Digital Wellbeing Experiments Toolkit**](https://github.com/googlecreativelab/digital-wellbeing-experiments-toolkit) : some ideas ig, basically the geoblocker one.
- [**Undraw**](https://undraw.co) : illustrations on intro page
- Special thanks to all the premium apps on the Play Store that inspired me to create a free and open-source alternative. imagine making money out of miserable people.
- [**Undraw**](https://undraw.co) : Illustrations on the intro page
- Special thanks to all the premium apps that inspired me to create a copylefted libre alternative, gratis. \
Imagine making money on the misery of people.
- [**Ml Kit QuickStart**](https://github.com/googlesamples/mlkit/tree/master) : ML models and multiple classes were used from this repository.

## Contributing

We welcome contributions from the community! If you'd like to contribute, please follow these steps:
Contributions welcome. Please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bugfix.
Expand All @@ -142,32 +143,33 @@ We welcome contributions from the community! If you'd like to contribute, please
```sh
git push origin feature/your-feature-name
```
5. Create a new Pull Request.
5. Create a new pull request.

Please ensure your code adheres to our coding standards and includes relevant tests.
Please ensure your code adheres to the coding standards and includes relevant tests.

## Contributors
- [Henry Delallal](https://github.com/HenriDellal): assisted in setting up fdroid version
- [Remaker17](https://github.com/remaker17): setup workflow files
- Error 404: helped reaching larger audience
- [Henry Delallal](https://github.com/HenriDellal): assisted in setting up the F-Droid version
- [Remaker17](https://github.com/remaker17): setting up workflow files
- Error 404: helped reach a larger audience

### HELP REQUIRED!!
1. Implementing dyanimic colors inside the warning overlay.
2. Expanding the list of [explict keywords](https://github.com/nethical6/digipause/blob/da5723915412277655aea4dd448cdc64a21fcc83/app/src/main/java/nethical/digipaws/data/BlockerData.java#L28)
3. Expanding the list of [Blocked view items](https://github.com/nethical6/digipause/blob/main/app/src/main/java/nethical/digipaws/data/BlockerData.java#L4) so that more apps can be supported. You can scrape the view ids of a screen with the help of [Developer Assistant](https://play.google.com/store/apps/details?id=com.appsisle.developerassistant). Remeber that these view ids must be unique and only present on the screen to block!!
3. Expanding the list of [Blocked view items](https://github.com/nethical6/digipause/blob/main/app/src/main/java/nethical/digipaws/data/BlockerData.java#L4) so that more apps can be supported. You can scrape the view IDs of a screen with the help of [Developer Assistant](https://play.google.com/store/apps/details?id=com.appsisle.developerassistant). Remeber these view IDs must be unique and only present on the screen to block!
4. Adding more info about other packages [here](https://github.com/nethical6/digipause/blob/main/app/src/main/java/nethical/digipaws/data/BlockerData.java)


## License

DigiPaws is licensed under the [GPL 3 or later licence](LICENSE). You are free to use, modify, and distribute this software in accordance with the license.
Licensed under the [GPL 3 or later licence](LICENSE). \
You are free to use, modify, and distribute this software in accordance with the license.

## Contact

For questions, suggestions, or feedback, please open an issue on the [GitHub repository](https://github.com/nethical6/digipaws/issues) or contact me at:
For questions, suggestions, or feedback, please open an issue on the [GitHub repository](https://github.com/nethical6/digipaws/issues) or get in contact at:
1. Discord: @nethical
2. Telegram: @nethicalps

---

Thank you for using DigiPaws! Together, we can create healthier digital habits.
Thank you for using DigiPaws! Together, we create healthier habits.

0 comments on commit 099aa79

Please sign in to comment.