# Craterfinder

Craterfinder is a command-line Minesweeper game written in Rust. Users can explore the mines and mark the positions of mines using the keyboard. The purpose of this project is to provide a simple, fast, and fun Minesweeper gaming experience.

## Features

Craterfinder provides the following features:

- Support for choosing different difficulty levels (beginner, intermediate, advanced)

- Customizable map size and number of mines

- Support for using arrow keys or WASD keys to operate the game

- Ability to mark discovered mine locations

- Support for automatically digging adjacent empty spaces

- Display all mine positions when game over

## Installation

To install Craterfinder, you need to first install Rust and Cargo package manager. If you have not installed Rust and Cargo yet, please visit the official website [https://www.rust-lang.org/tools/install](https://www.rust-lang.org/tools/install) to download and install.

Once installation is complete, execute the following command in the terminal to install Craterfinder:

```
cargo install craterfinder
```

## Usage

**NOTICE: Craterfinder is still under active development and will soon be available.**

Type `craterfinder` in the terminal to start the program. After starting the program, follow the prompts to choose the game difficulty, customize the map size and number of mines, and use the keyboard to explore the mines and mark their locations.

Here are the usage instructions for Craterfinder:

- Use arrow keys or WASD keys to operate the game (up, down, left, right or W/A/S/D)

- Press the space bar to dig at the current position

- Press F to mark or unmark mine locations

- Press Q to quit the game

## Contributing

Contributions to Craterfinder are welcome! If you have any suggestions or questions, please open an issue or pull request on GitHub.

## License

Craterfinder is distributed under the MIT License. Please refer to the [LICENSE](https://github.com/sunray-ley/craterfinder/blob/main/LICENSE) file for more information.