Mines

A MineSweeper clone implemented for many home consoles and computers.

Licensed under GNU General Public License version 2 (or later)

Existing ports in this repo

For specific build & runtime/debug dependencies, please check the individual README.md files for each of the available ports below:

• MSX2 (screen 5): OK
• MSDOS (VGA mode 13h): OK
• Text terminal using ncurses lib: OK
• OpenGL: OK, but with glitchy colors.
• GunSmoke JAMMA board: Slightly broken input handling.
• PSX: Work-In-Progress; Grid shows up but background is glitchy.
• Vectrex: Crude initial boilerplate; currently broken.
• Commodore 64: Just a boilerplate; Please consider contributing an initial implementation!

How to create your own

• Create a new subdirectory in platforms named after the new platform;
• Create at least one source file (.c suffix) to put your platform-specific functions and macros;
  • You might want to separate functions in files input.c and video.c (according to purpose) as commonly found in other platforms;
• Add common.h (for generic definitions) and game.h (for more specific game definitions) to your source files using the #include macro;
• Implement all functions and macros defined in common.h (follow the instructions for each in the file);
• Implement all functions and macros defined in game.h (follow the instructions for each in the file);

You can compare you implementation with a preexisting one if you are stuck. ncurses should be easy to follow.

How to generate HTML documentation

The following Python 3 packages should be installed:

• pandoc
• pygments
• pandocfilters

Which you can do by typing

pip install -r requirements.txt

And then generate the HTML files by executing the command

make docs

And they will be found on the docs folder.