Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
jayasuryat committed Dec 17, 2021
2 parents b4cee63 + bb44763 commit 17913c9
Showing 1 changed file with 10 additions and 12 deletions.
22 changes: 10 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@ This is a [Minesweeper](https://en.wikipedia.org/wiki/Minesweeper_(video_game))-

The objective of this game is to clear a rectangular board containing hidden "mines" or bombs without detonating any of them, with help from clues about the number of neighboring mines in each cell.

## Demo
| Dark mode | Light mode |
| -- | -- |
| <img src="https://github.com/JayaSuryaT/minesweeper-j-compose/raw/main/art/Main_DarkTheme.gif" alt="Using Views - Light theme" data-canonical-src="https://github.com/JayaSuryaT/minesweeper-j-compose/raw/main/art/Main_DarkTheme.gif" width="270" height="585" />|<img src="https://github.com/JayaSuryaT/minesweeper-j-compose/raw/main/art/Main_LightTheme.gif" alt="Using Views - Dark theme" data-canonical-src="https://github.com/JayaSuryaT/minesweeper-j-compose/raw/main/art/Main_LightTheme.gif" width="270" height="585" />|


## Features :
* Zoomable and Panabel minefield
* Safe first click - The first cell is never a mine as the minefield is generated around the first click
Expand All @@ -17,19 +23,11 @@ The objective of this game is to clear a rectangular board containing hidden "mi
* Long press an unrevealed cell to flag/unflag it
* Tap an already revealed cell to expose potentially solved cells

## Demo


| Dark mode | Light mode |
| -- | -- |
| <img src="https://github.com/JayaSuryaT/minesweeper-j-compose/raw/main/art/Main_DarkTheme.gif" alt="Using Views - Light theme" data-canonical-src="https://github.com/JayaSuryaT/minesweeper-j-compose/raw/main/art/Main_DarkTheme.gif" width="270" height="585" />|<img src="https://github.com/JayaSuryaT/minesweeper-j-compose/raw/main/art/Main_LightTheme.gif" alt="Using Views - Dark theme" data-canonical-src="https://github.com/JayaSuryaT/minesweeper-j-compose/raw/main/art/Main_LightTheme.gif" width="270" height="585" />|


## Package Structure :

```
com.jayasuryat.minesweeperjc
โ”œโ”€โ”€ ๐Ÿ“‚ app/ # App layer
โ”œโ”€โ”€ ๐Ÿ“‚ app/ # App module
โ”‚ โ”œโ”€โ”€ presentation/ # Navigation & Screens
โ”‚ โ”œโ”€โ”€ theme/ # Theming
โ”‚ โ””โ”€โ”€ MinesweeperApp.kt
Expand All @@ -42,6 +40,8 @@ com.jayasuryat.minesweeperjc
โ”‚ โ”œโ”€โ”€ state/ # Stateful grid and utils
โ”‚ โ””โ”€โ”€ util/
โ”‚
โ”œโ”€โ”€ ๐Ÿ“‚ minesweeper-engine-debug/ # Module for debug utils related to minesweeper-engine
โ”‚
โ”œโ”€โ”€ ๐Ÿ“‚ minesweeper-ui/ # Module for all of the UI components of the mine grid
โ”‚ โ””โ”€โ”€ composable/
โ”‚ โ”œโ”€โ”€ action/ # Action listeners for Minefield interaction actions
Expand All @@ -60,8 +60,6 @@ com.jayasuryat.minesweeperjc
โ”‚
โ”œโ”€โ”€ ๐Ÿ“‚ ui-difficulty-selection/ # Module for difficulty selection screen
โ”‚
โ”œโ”€โ”€ ๐Ÿ“‚ minesweeper-engine-debug/ # Module for debug utils related to minesweeper-engine
โ”‚
โ””โ”€โ”€ ๐Ÿ“‚ util/ # Module for common utilities
```

Expand All @@ -73,9 +71,9 @@ com.jayasuryat.minesweeperjc
All the SFX used in this project are sourced from <a href="https://freesound.org/">freesound.org</a> and are licensed under the <a href="https://creativecommons.org/publicdomain/zero/1.0/">Creative Commons 0 License</a>.
</summary>

* [Cell poping sound](https://freesound.org/people/onikage22/sounds/240566/) by [onikage22](https://freesound.org/people/onikage22/)
* [Cell flagging sound](https://freesound.org/people/plasterbrain/sounds/237422/) by [plasterbrain](https://freesound.org/people/plasterbrain/)
* [Cell unflagging sound](https://freesound.org/people/plasterbrain/sounds/423168/) by [plasterbrain](https://freesound.org/people/plasterbrain/)
* [Cell poping sound](https://freesound.org/people/onikage22/sounds/240566/) by [onikage22](https://freesound.org/people/onikage22/)

</details>
</p>
Expand Down

0 comments on commit 17913c9

Please sign in to comment.