Skip to content

Commit

Permalink
Minor README modifications
Browse files Browse the repository at this point in the history
- Minor spelling change
- Added use instructions
  • Loading branch information
roddyrap committed May 31, 2021
1 parent 7b4d861 commit 85cb6c7
Showing 1 changed file with 16 additions and 7 deletions.
23 changes: 16 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Minesweeper Gameboy
This is a port/demake of the microsoft game Minesweeper. The game works both for the Gameboy and the Gameboy colors, with enhanced colors for the latter.
This is a port/demake of the Microsoft game Minesweeper. The game works both for the Gameboy and the Gameboy colors, with enhanced colors for the latter.

While I do have a Gameboy (Color) I wasn't able to test it on official hardware due to a lack of ability to load it to a cartridge. The rom file was tested on [BGB](https://bgb.bircd.org/) and [Emuclius](https://emulicious.net/).
While I do have a Gameboy (Color) I wasn't able to test it on official hardware due to a lack of ability to load it to a cartridge. The ROM file was tested on [BGB](https://bgb.bircd.org/) and [Emuclius](https://emulicious.net/).

# Gameplay (from Wikipedia)
In Minesweeper, mines (that resemble naval mines in the classic theme) are scattered throughout a board, which is divided into cells. Cells have three states: uncovered, covered and flagged. A covered cell is blank and clickable, while an uncovered cell is exposed. Flagged cells are those marked by the player to indicate a potential mine location.
Expand All @@ -15,14 +15,23 @@ To win the game, players must uncover all non-mine cells, at which point, the ti

# GB Modifications (rules)
Instead of using the mouse and left/right clicks the player uses the d-pad and the A and B buttons to navigate.
- A is used to open tiles
- A is used to open tiles.
- B is used to flag and unflag tiles
- All mines need to be flagged in order to win and no more
- Start is used to restart game
- All mines need to be flagged to win.
- Start is used to restart the game.
- Select opens a difficulty select screen

WARNING: While large board sizes are available the Gameboy takes a lot of time to place the bombs, it might freeze for around a minute and a half while placing the bombs, but should then work clearly.

# Use instructions
The latest version should be available in the releases tab. Downloading the ROM from there is easy and should let you play immediately.

If you want to build the files yourself it's possible.
- Clone or download the git repository.
- Download [GBDK 2020 (Gameboy Development Kit 2020)](https://github.com/gbdk-2020/gbdk-2020).
- If you are using a Windows PC modify the file source of LCC in the build.bat file, and execute it. It should create the ROM in the Build directory.
- Else, follow GBDK 2020's instruction on how to compile in your operating system. Keep in mind to allow Gameboy Color compatibility, which is disabled in the compiler by default.

# Images
## GBC
![GameStartEasy](Images/GBC/GameStartEasy.bmp)
Expand All @@ -39,7 +48,7 @@ WARNING: While large board sizes are available the Gameboy takes a lot of time t
Feel free to submit all bug reports and code changes ideas and requests to the corresponding tabs in GitHub.

# License
This project is licensed under the Apache license 2.0.
This project is licensed under the Apache License 2.0.

# Attribution
Game play section provided by Wikipedia under the "Creative Commons Attribution-ShareAlike" License. This is not endorsed by Wikipedia or its writers.
Gameplay section provided by Wikipedia under the "Creative Commons Attribution-ShareAlike" license. This is not endorsed by Wikipedia or its writers.

0 comments on commit 85cb6c7

Please sign in to comment.