README.md

   1 RRace is a slide puzzle racing game.  The goal is to re-arrange coloured tiles
   2 in the game area to create the objective pattern as quickly as possible.
   3
   4 The game is inspired by Rubik's Race, a board game for two players that dates
   5 back to the Rubik's Cube craze in the early 1980s, which you can apparently
   6 still buy in 2022.
   7
   8 # Prerequisites
   9
  10 RRace is written in C, so a working C compiler is compiled.
  11
  12 To build the terminal UI, a curses library is required.  Both
  13 [ncurses][ncurses-homepage] and [PDcurses][pdcurses-homepage] are free
  14 software curses implementations that are fully supported.  Other
  15 implementations may work.
  16
  17 To build the UI for X11 systems, the [Motif toolkit][motif-homepage] is
  18 required.
  19
  20 Optionally, in order to support localized program messages the [GNU libintl
  21 library][gettext-homepage] (included with the GNU C library) is required.
  22
  23 [ncurses-homepage]: https://invisible-island.net/ncurses/
  24 [pdcurses-homepage]: https://pdcurses.org/
  25 [motif-homepage]: https://sourceforge.net/projects/motif/
  26 [gettext-homepage]: https://www.gnu.org/software/gettext/
  27
  28 # Playing the Game
  29
  30 The game is played on a 5x5 grid of tiles, called the *game area*, containing
  31 24 tiles in 6 different colours--4 of each colour.  There is one *empty
  32 position* in the game area.  The *goal area* is a 3x3 grid of tiles which
  33 displays the *objective* pattern that must be formed to win the game.
  34
  35 Selecting a tile in the same row or column as the empty position will "slide"
  36 that tile, along with any tiles between it and the empty position, into the
  37 empty space.  The new empty position will be at the selected location.  Such
  38 moves are repeated until the colours in the centre 3x3 subgrid of the game
  39 area match the objective.
  40
  41 Since there are four tiles in each colour, any of those tiles may be used
  42 to match any of the corresponding positions in the objective.  Together with
  43 the fact that only a portion of the game area needs to be solved, this makes
  44 the game considerably easier than a more traditional slide puzzle.
  45
  46 # Contributing
  47
  48 Please send suggestions, bug reports, patches or any other
  49 correspondence regarding RRace by electronic mail to
  50 [Nick Bowler \<nbowler@draconx.ca\>][email].
  51
  52 [email]: mailto:nbowler@draconx.ca
  53
  54 # License
  55
  56 RRace is free software: you can redistribute it and/or modify it under the
  57 terms of the GNU General Public License as published by the Free Software
  58 Foundation, either version 3 of the License or (at your option) any later
  59 version.
  60
  61 {::comment}
  62 Copyright © 2022 Nick Bowler
  63 {:/comment}