pharap/minesweeper

Finally, the Minesweeper game I've had locked in a cellar for several months

Minesweeper

Finally, the Minesweeper game I've had locked in a cellar for several months

Pharap Logo Licencing

Please note that the 'Pharap Logo' is copyrighted by Pharap and thus not licenced for general use.
If you plan to create a derivitive game I suggest replacing the logo with your own.

Code Licencing

The source code is licenced under the Apache 2.0 licence.
This means that you are free to copy and edit the code, but you must:

• Retain all copyright notices
• Document your changes

Graphics Licencing

All graphics (excepting the aforementioned logo) are released under the Creative Commons Attribution-NonCommercial-ShareAlike licence ('CC BY-NC-SA').

You can find a copy of the licence in Graphics/BY-NC-SA.txt.

minesweeper's Issues

Improve Marsaglia citation

The code currently cites Marsaglia:

Minesweeper/Minesweeper/Utils/SkullHash.h

Lines 23 to 26 in d8509ca

	// This is actually part of the algorithm for an 'Xorshift' PRNG variant.
	// PRNG algorithms that have a single-value state can be easily repurposed as hash functions.
	// The shift values are taken from page 4 of George Marsaglia's 'Xorshift RNGs'.
	// Marsaglia's 'Xorshift RNGs': https://www.jstatsoft.org/article/view/v008i14

But it doesn't currently mention the paper's licence (CC BY 3.0),
or that the code was written from scratch using values tabulated in the paper.

Using reinterpret_cast in a constexpr expression is non-standard

Using reinterpret_cast in a constexpr expression is non-standard, so this needs to be changed:

Minesweeper/Minesweeper/SaveSystem.h

Lines 68 to 73 in 88648a6

	static constexpr SaveBlock * SaveAddress = reinterpret_cast<SaveBlock *>(SaveStart);
	static constexpr Header * HeaderAddress = reinterpret_cast<Header *>(HeaderStart);
	static constexpr DataType * DataAddress = reinterpret_cast<DataType *>(DataStart);
	static constexpr uint32_t * ChecksumAddress = reinterpret_cast<uint32_t *>(ChecksumStart);
	static constexpr uint16_t * DataSizeAddress = reinterpret_cast<uint16_t *>(DataSizeStart);

Standardise the way images are formatted

In some places there's uint8_t const:

Minesweeper/Minesweeper/Images/Backgrounds.h

Line 28 in d8509ca

uint8_t const BackgroundLeft[] PROGMEM =

In other places there's const unsigned char:

Minesweeper/Minesweeper/Images/LargeTiles.h

Line 29 in d8509ca

const unsigned char LargeTiles[] PROGMEM =

Really it would be good to standardise all images to constexpr uint8_t.

Fix code dependent on -fpermissive

This includes things like:

• constexpr expressions using reinterpret_cast
• stack-allocated variable length arrays

Update to v2.0.0

When the v2.0.0 project and the v2.0.0 milestone are complete, publish a new v2.0.0 release.

Missing Vampirics citations

Particularly here:

Minesweeper/Minesweeper/Images/LargeTiles.h

Line 21 in d8509ca

// Penguin large tile created by Vampirics (https://github.com/vampirics)

Add @vampirics to the graphics credits

At the same time as #26, be sure to add @vampirics to the credits list under the "Graphics" category newly added by #25.

Make the EEPROM save system future-proof

At the moment adding new information to the 'save file' will cause it to become incompatible with existing saves.

The save system needs to be future-proofed so that new setting can be added without invalidating save states from older versions.

Note that this is a breaking change and hence part of the reason for a major version increment.

Add backgrounds functionality

Add the backgrounds created by @vampirics to the themes mechanism.

Reorganise Stats screen

Currently the stats screen displays as:

Wins: 1
Losses: 1

I think it would be better to rearrange it to this:

Wins:
1

Losses:
1

because then the locations of the numbers won't depend on the language being used.

Fix stack overflow

There's a fatal stackoverflow bug in the EEPROM verification code.
It needs to be fixed before the code can develop any further.

Specifically the problem stems from here:

Minesweeper/Minesweeper/SaveSystem.h

Line 104 in 239edc9

char buffer[dataSize];

When EERPOM is uninitialised, the size value read from eerpom could easily exceed the entire size of RAM, let alone the size of the stack.
There are several ways this problem can be solved.
Figuring out the best way is incredibly difficult.

Add a credits entry for "Graphics"

As part of the big v2.0.0 update, some new graphics created by @vampirics are going to be added to the game.

In response to this, a new category in the credits list for "Graphics" needs to be introduced.

Add settings menu

Add a settings menu to facilitate planned v2.0.0 features.

Consider restructuring to use src file

There's an issue with Arduino projects in which only .cpp files in either the root of the project or a src folder will compile.

At the time this game was written I was unaware of it,
hence a lot of stuff got dumped in the root.
But now that I am aware, it might be a good idea to someday fix the issue.

Remove redundant const qualifiers

Many constexpr variables also feature const.
As constexpr implies const, the consts are superfluous and should thus be removed.

Configurable size of board and number of mines

It would be more replayable if we could choose a bigger board (fill in some of the space that currently just has background with more mine spaces) and if we could choose more or less mines.

Remove the old 'themes' easter egg

In the old v1.0.0-v1.1.0 versions there was an easter egg on the title screen that implemented 'theme' selection.
As of the big v2.0.0 update, this is being promoted from an easter egg to a full feature.

Now that a proper "Themes" option has been added, the old easter egg functionality needs to be removed because it's redundant.

Note that this is a breaking change and hence part of the reason for a major version increment.

Improve theme selection UI

Currently the theme selection state is still using placeholder graphics.
These need to be replaced with some better graphics.

Array of size zero is non-standard

Zero-sized arrays are non-standard, so the following function should be removed:

Minesweeper/Minesweeper/Utils/ArrayUtils.h

Lines 28 to 31 in 88648a6

	template< typename T > constexpr size_t ArrayLength(T(&)[0])
	{
	return 0;
	}

Reduce size of Minesweeper logo

Currently the minesweeper logo has a lot of excess blank space.
This space should be trimmed down to make the logo smaller in preparation for adding a new menu option.

Move all files into Minesweeper subdirectory

Move the files into a subdirectory so people don't have to delete the branch extension.

Make 'generateRandomSeed' defer to Arduboy2 when possible

When possible, generateRandomSeed should forward to Arduboy2Base::generateRandomSeed().

(I.e. detect Arduboy2 version 5.2.0.)

Stack allocated arrays are non-standard

Stack allocated arrays such as the following are non-standard:

Minesweeper/Minesweeper/SaveSystem.h

Line 97 in 88648a6

char buffer[dataSize];

Minesweeper/Minesweeper/SaveSystem.h

Line 115 in 88648a6

char buffer[dataSize];

The required array buffers should instead be passed as reference parameters.

---

The Arduboy's screen buffer would serve a suitable replacement buffer as it's 1KB (as large as the whole of EEPROM) and unused at the point in time that checksum verification needs to be done.

Remove unnecessary 'static's on global variables

E.g. the ones in LargeTiles.h:

Minesweeper/Minesweeper/Images/LargeTiles.h

Lines 26 to 27 in d8509ca

	static constexpr uint8_t LargeTileFrameWidth = 16;
	static constexpr uint8_t LargeTileFrameHeight = 16;

Fix the casing of file names in include statements

Certain includes are only working because of case insensitivity.
The cases need to be fixed to be case sensitive so they work on case sensitive file systems.

Reference here

Had trouble compiling on Linux because of case-sensitivity - different filenames vs. includes for TitleScreenState / TitlescreenState and SplashScreenState / SplashscreenState.

Add save functionality for themes

Currently the theme resets to theme 0 every time the console is reset.
Instead, the chosen theme should persist in EEPROM even after the device is turned off.

Depends on #22 being implemented.

Improve citation for 'generateRandomSeed()'

Really it ought to be under the MIT licence since it was 'borrowed' from the Arduboy2 library.

Change licence header comment style

The licence headers currently use multiline comments.
I'd like to change them to use single line comments.

Fix minor single pixel discrepency present in certain number tiles

Issue raised by @vampirics in a PM.

This issue is present on both the number 2 and number 3 tiles.

Prepare code for placement new being added to Arduino library

Minesweeper/Minesweeper/Utils/PlacementNew.h

Lines 29 to 33 in 88648a6

	inline void * operator new (size_t size, void * pointer)
	{
	static_cast<void>(size);
	return pointer;
	}

The Arduino library has recently added placement new to the library,
which will clash with this implementation of placement new and thus prevent compilation.

This code needs to be changed to avoid being defined if the library is suitably recent.

Add a comment about the origins of 'SkullHash'

'SkullHash' is actually one of George Marsaglia's 'xorshift' algorithms.

Relevant links:

• https://www.jstatsoft.org/article/view/v008i14
• https://en.wikipedia.org/wiki/Xorshift#Example_implementation
• https://en.wikipedia.org/wiki/Linear-feedback_shift_register#Xorshift_LFSRs