Introduce pet-projects dir
[lcapit-junk-code.git] / pet-projects / games / microballs / README
blob9740b1854be017c4b4029ad31f8a50cf665d11a7
1 mballs: A microballs game implementation
2 ========================================
4 1. Compiling and running
5 ------------------------
7  To compile it just run 'make' and a binary file called 'mballs' will
8 be created.
10  You can execute it to run the game:
12 $ ./mballs
14 2. Playing
15 ----------
17  There are two players in the game: X and Y. By default, both players
18 are humans, X always plays first and the board size is 8x8.
20  If you select to play against the computer, it will play with player Y.
22  Moves have this format:
24      from-to
26  where, 'from' and 'to' are pairs of row and column, for example:
28      a1-a2
30  means: move piece from row 'a' and column '1' to row 'a' and
31 column '2'. The '-' character is mandatory.
33  Other example:
35     g3-f5
37  means: move piece from row 'g' and column '3' to row 'f' and
38 column '5'.
40 3. Options
41 ----------
43  mballs executable supports the following options:
45  mballs [ -h ] [ -c ] [ -e<size> ]
47  -h: The help message.
49  -c: Select to play against the computer (it'll play with player Y).
51  -e<size>: Custom board size, valid range is from 9 to 16.
53  Examples:
55  $ ./mballs -e10
57    Creates a 10x10 board to be played by two humans.
59  $ ./mballs -c
61    Creates the default board size (8x8) to be played by a human against
62    the computer.
64  $ ./mballs -c -e16
66    Creates a 16x16 board size to be played by a human against the
67    computer.
69 Luiz Fernando N. Capitulino
70 <lcapitulino@gmail.com>