README.md

MemoryOverflow - Cards & Editions

MemoryOverflow game is based on cards. Each one is unique and can be used in many different ways according to the strategy of the player.
Cards are grouped by editions which represent different themes.

Editions

Contribute!

In this project, everyone is free to contribute. To do that, you must first learn how to use The Machine. It's very easy and takes 10min to start writing your first card. Of course, you don't have to learn writing code or something technical else. The Machine is here to generate your cards automatically.

Create a new card

To be used by The Machine, each card has a generic configuration.
It's possible to create cards in differents programming languages and translations.

The folder structure

A card must be located inside an edition. Each card is composed of files inside a folder name.

A card must have these files. It's possible to add all of the translation you want but you need to have JavaScript format and english translation by default.

README.md file

This file describe the card and its spirit.
Its include:

Its name

Its description

Its type

Its languages supported

Its translations supported

A link to its configuration file

Its changelog

[card name].md file

This file is a Markdown format. It describe in details the card divided in sections by title.

Here is the format:

#title
The full title of the card
#description
The description of the card
#status
Status can only be: "working", "playing" or "deprecated"
#edition
The name of the card edition
#type
Type can only be: "variable", "code", "event" or "the machine"
#author
The full name of the author followed by its Twitter account
#code:javascript
This block is only used for a card with "variable" or "code" type.
Write the specific code of your card and many other informations.
You can add all of the formatting tags like {code}
Use &{} to encapsulate your translated texts
#code:php
You can add all of the codes syntax you want. PHP, Java, C++, etc
#content
This block is used for cards with "event" or "the machine" type.
Write the card action description here.
You can add all of the formatting tags like {code}{/code}
Use &{} to encapsulate your translated texts