antimine-android/README.md

61 lines
2.1 KiB
Markdown
Raw Normal View History

2020-03-08 17:58:22 +00:00
# Anti-mine ![Android CI](https://github.com/lucasnlm/antimine-android/workflows/Android%20CI/badge.svg) [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) [![ktlint](https://img.shields.io/badge/code%20style-%E2%9D%A4-FF4081.svg)](https://ktlint.github.io/)
2020-02-08 13:58:56 +00:00
Anti-Mine is a minesweeper puzzle game. The objective is: search for all hidden mines and clear the minefield without explode any of them.
Flag the spaces with mines to make the board a safer place. You win the game when you've flagged every mine on the board. Be careful not to trigger one, or the game is over!
2020-02-08 14:04:17 +00:00
<p align="center">
2020-02-09 16:20:15 +00:00
<img src="https://raw.githubusercontent.com/lucasnlm/antimine-android/master/extras/image_02.png" width="275px"/>
<img src="https://raw.githubusercontent.com/lucasnlm/antimine-android/master/extras/image_01.png" width="275px"/>
<img src="https://raw.githubusercontent.com/lucasnlm/antimine-android/master/extras/image_06.png" width="275px"/>
2020-02-08 14:04:17 +00:00
</p>
2020-02-08 13:58:56 +00:00
## Contributing
Feel free to contribute with pull requests.
## Download
<a href="https://play.google.com/store/apps/details?id=com.logical.minato">
2020-02-08 14:04:17 +00:00
<img src="https://play.google.com/intl/en_us/badges/images/generic/en_badge_web_generic.png"
alt="Get it on Google Play" height="80"/></a>
2020-02-08 13:58:56 +00:00
## Building
You can build from source code by running:
```bash
git clone git@github.com:lucasnlm/antimine-android.git
cd antimine-android
./gradlew assembleRelease -Dorg.gradle.java.home=$ANDROID_JRE
```
Where `ANDROID_JRE` is the Java runtime provided by Android Studio.
## Features
- Game levels: begginner, intermediate, expert and custom
- Android Wear OS support
- Dark Theme support
- Save/Resume state when quit/resume game
- Put flag on long press
- Put question mark on double long press
2020-02-09 16:17:16 +00:00
- Open multiple areas by long pressing the numbers
2020-02-08 13:58:56 +00:00
- Game assistant to auto-flag discovered mines
2020-03-08 18:00:47 +00:00
- Share game
2020-02-09 16:17:16 +00:00
- App shortcuts
- Split screen
2020-02-08 13:58:56 +00:00
- Assessability: large toachable area
2020-02-09 16:17:16 +00:00
- Assessability: screen reader
2020-02-08 13:58:56 +00:00
## Technical Details
- Android SDK 29
- AndroidX
- Lifecycle
- Dagger
- Room
- Coroutines
2020-03-08 18:00:47 +00:00