Sigmar's Garden by Trollbreeder
Original by Zachtronics (Opus Magnum)

Thank you for downloading Sigmar's Garden!
This README file will contain the rules of the game and extra help.
Note: This game is only playable on Advanced Computers due to its use of the mouse and colors.

--- License ---
In short: you may use it as part of your project, you may download and play it, but you may not steal (take and treat as your own) and/or sell it.
See license.txt for more information.
If there is no such license.txt file, or you have paid for this game, you may have been scammed.
THIS GAME WILL ALWAYS AND FOREVER BE FREE OF CHARGE.

--- How to play- --
Start the game by going to the game's folder and typing in "sigmar [board id]" into the CraftOS shell.
board id is the optional id of the board, or ? for random boards.
For example, "sigmar 3" will load the third level Projection.

Click on an atom to select it. Click on a matching atom to match and remove them from the board.
Your goal is to remove all atoms from the board.

--- Rules ---
Every board consists of ATOMS (squares that are not empty)
These atoms react and clear themselves based on matches.

The Cardinal Elements (Earth, Fire, Water, Air) match with themselves, or Salt.
Salt matches with itself, or a Cardinal Element.
Vitae and Mors match with their opposite (Vitae with Mors, Mors with Vitae)

The metals match with quicksilver  (and vice versa), but only in the Order of Projection:
lead -> tin -> iron -> copper -> silver -> gold
The exception is gold, which does not require quicksilver.
After gold, it loops back to lead.
Metals are distinct from other elements because they are represened by a lowercase letter.

Only atoms that have two or more empty squares next to them along orthagonal directions (no diagonals) are interactible.
Uninteractible atoms are considered LOCKED.
By clearing atoms and therefore creating empty squares, you can unlock atoms.

Slag is a unique type of atom, as it counts as empty for winning a board, but is not considered empty to determine locked atoms.
It's color is gray and it has no letter on it.

--- Making Custom Boards ---
This is the technical side of things.
Boards are secretly NFP images, but interpreted and rendered differently.
The first line is the board's name, and is read literally.
The rest is how atoms should be constructed. Every atom is a single hexadecimal digit from 0-f, with its number representing its type.

Here is a table of all atoms and their hexadecimal representation:
0 Vitae
1 copper
2 lead
3 Air
4 gold
5 Empty
6 silver
7 Slag
8 Salt
9 iron
a quicksilver
b Water
c Tin
d Earth
e Fire
f Mors

Tip: Anything outside of 0-f (Lowercase only if applicable) will be treated as an empty space, including whitespace characters.
For example, this is the board for Caution (7.dat):
Caution
aa
e e
9ec
 2e
7a
 7

Boards are named sequentially from 1 with extension '.dat'. Non-number names are allowed, but can only be accessed through accessing its board id directly.
For example, board "test.dat" can only be loaded with "sigmar test"
Boards are placed in a folder called "boards" on the same directory as the game's file.


We hope you have fun playing this game and creating custom content for it!