antimine-android/README.md

70 lines
3.4 KiB
Markdown
Raw Normal View History

2020-05-15 12:52:08 +00:00
# Antimine - Minesweeper
2020-04-29 15:12:28 +00:00
![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) [![GitHub release](https://img.shields.io/github/release/lucasnlm/antimine-android.svg?maxAge=60)](https://github.com/lucasnlm/antimine-android/releases) [![ktlint](https://img.shields.io/badge/code%20style-%E2%9D%A4-FF4081.svg)](https://ktlint.github.io/) [![crowdin](https://badges.crowdin.net/antimine-android/localized.svg)](https://crowdin.com/project/antimine-android) [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Flucasnlm%2Fantimine-android.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Flucasnlm%2Fantimine-android?ref=badge_shield)
2020-02-08 13:58:56 +00:00
2020-04-13 13:02:59 +00:00
### Description
2020-05-15 12:52:08 +00:00
Antimine is a minesweeper-like puzzle game. The objective is to flag the spaces with mines to make the field a safer place without exploding any of them.
2020-02-08 13:58:56 +00:00
2020-05-15 12:52:08 +00:00
You win the game when you've flagged every mine in the minefield. Be careful not to trigger one!
2020-02-08 13:58:56 +00:00
2020-04-13 13:02:59 +00:00
### Screeshots
2020-02-08 14:04:17 +00:00
<p align="center">
2020-04-14 22:39:09 +00:00
<img src="https://github.com/lucasnlm/antimine-android/blob/master/fastlane/metadata/android/image_1.png" width="275px"/>
<img src="https://github.com/lucasnlm/antimine-android/blob/master/fastlane/metadata/android/image_5.png" width="275px"/>
<img src="https://github.com/lucasnlm/antimine-android/blob/master/fastlane/metadata/android/image_3.png" width="275px"/>
2020-02-08 14:04:17 +00:00
</p>
2020-02-08 13:58:56 +00:00
## Contributing
2020-04-22 20:13:10 +00:00
Feel free to contribute with [issues](https://github.com/lucasnlm/antimine-android/issues), [feature requests](https://github.com/lucasnlm/antimine-android/issues), [pull requests](https://github.com/lucasnlm/antimine-android/pulls), or [translating](https://crowdin.com/project/antimine-android).
2020-02-08 13:58:56 +00:00
## 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
2020-04-06 19:25:34 +00:00
- [Android SDK 29](https://developer.android.com/about/versions/10)
- [AndroidX](https://developer.android.com/jetpack/androidx)
- [Lifecycle](https://developer.android.com/topic/libraries/architecture/lifecycle)
- [Dagger](https://dagger.dev/android.html)
- [Room](https://developer.android.com/training/data-storage/room)
2020-04-08 13:07:57 +00:00
- [Robolectric](http://robolectric.org/)
2020-04-06 19:25:34 +00:00
- [Coroutines](https://kotlinlang.org/docs/reference/coroutines-overview.html)
## License
2020-05-15 12:52:08 +00:00
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Flucasnlm%2Fantimine-android.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Flucasnlm%2Fantimine-android?ref=badge_large)