Skip to content

README.md

Latest commit

 

History

History
64 lines (36 loc) · 1.6 KB

README.md

File metadata and controls

64 lines (36 loc) · 1.6 KB

Here's a comprehensive README.md for the LycalopX/MineSweeper project, designed to provide clear guidance for users and contributors:

MineSweeper

A classic Minesweeper game implemented in C, offering a console-based gameplay experience.

Features

  • Text-based interface for straightforward interaction.
  • Customizable grid size and mine count.
  • Real-time game statistics tracking.
  • Efficient game logic for responsive play.

Getting Started

Prerequisites

Ensure you have a C compiler installed, such as gcc.

Compilation

To compile the game, navigate to the project directory and run:

gcc game.c -o minesweeper

Running the Game

After compilation, start the game with:

./minesweeper

File Structure

  • game.c: Main source code containing game logic.
  • constants.h: Header file defining game constants.
  • functions.h: Header file declaring functions used in the game.
  • stats1.txt & stats2.txt: Files used for storing game statistics.

Contributing

Contributions are welcome! Please fork the repository and submit a pull request for any enhancements or bug fixes.

License

This project is open-source and available under the MIT License.

Acknowledgments

Developed by LycalopX.

As a joke, there is an UltraNightmare difficulty. It will not run properly, and, sometimes, not run at all. Also, the game was made for Linux, but had to be updated to Windows and that kinda bugged it out. Sry, no time to correct, as the project has been abandoned. Thanks