Minesweeper (with Autoplay)

The classic Minesweeper game with an AI-powered Autoplay feature
Report Bug · Request Feature

Table of Contents

1. About The Project
2. Installation
3. Usage
4. Contributing
5. Roadmap
6. Contact

About The Project

Minesweeper (with Autoplay) is a Java-based implementation of the classic Minesweeper game, planned to be enhanced with an AI-powered Autoplay feature that helps to automatically open or mark the obvious boxes based on basic AI logic. The game presents users with three difficulty levels and maintains high scores for each level in a local highScore.txt file.

Features

• Classic Minesweeper gameplay
• Three difficulty levels to choose from
• AI-powered Autoplay feature (In development)
• Local high score tracking

(back to top)

Installation

To set up Minesweeper (with Autoplay) locally, follow these steps:

Prerequisites

• Ensure you have at least JDK 22 installed. You can download it from here.
• Any Java IDE - (Install IntelliJ IDEA from here).

Steps

1. Clone the repository:

   git clone https://github.com/saharsh-agrawal/Minesweeper.git
   cd Minesweeper

2. Open the project in IntelliJ IDEA.

3. Run the application:

   • Navigate to src folder.
   • Locate Minesweeper.java.
   • Right-click on Minesweeper.java and select Run 'Minesweeper.main()'.

(back to top)

Usage

Upon running the application, a main window will appear, asking the user to choose a level of difficulty (Easy, Medium, Hard). The game board is then presented according to the chosen difficulty. High scores are saved locally in highScore.txt.

Autoplay Feature

• The Autoplay feature is currently under development.
• When enabled, it will use AI logic to help play the game.
• A button exists to toggle this feature.

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

Steps to Contribute

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Development Setup

• Ensure your development environment is set up with JDK 22 and IntelliJ IDEA.
• Refer to the Installation section for initial setup instructions.

(back to top)

Roadmap

• Fix high score storage issue for packed JAR files.
• Implement Autoplay feature with basic AI logic.
• Add more advanced AI features for improved gameplay.

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contact

Maintainer - Saharsh Agrawal

(back to top)