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 UI for X11 systems, the [Motif toolkit][motif-homepage] is
  13 required.
  14
  15 Optionally, in order to support localized program messages the [GNU libintl
  16 library][gettext-homepage] (included wit the GNU C library) is required.
  17
  18 [motif-homepage]: https://sourceforge.net/projects/motif/
  19 [gettext-homepage]: https://www.gnu.org/software/gettext/
  20
  21 # Playing the Game
  22
  23 The game is played on a 5x5 grid of tiles, called the *game area*, containing
  24 24 tiles in 6 different colours--4 of each colour.  There is one *empty
  25 position* in the game area.  The *goal area* is a 3x3 grid of tiles which
  26 displays the *objective* pattern that must be formed to win the game.
  27
  28 Selecting a tile in the same row or column as the empty position will "slide"
  29 that tile, along with any tiles between it and the empty position, into the
  30 empty space.  The new empty position will be at the selected location.  Such
  31 moves are repeated until the colours in the centre 3x3 subgrid of the game
  32 area match the objective.
  33
  34 Since there are four tiles in each colour, any of those tiles may be used
  35 to match any of the corresponding positions in the objective.  Together with
  36 the fact that only a portion of the game area needs to be solved, this makes
  37 the game considerably easier than a more traditional slide puzzle.
  38
  39 # Contributing
  40
  41 Please send suggestions, bug reports, patches or any other
  42 correspondence regarding RRace by electronic mail to
  43 [Nick Bowler \<nbowler@draconx.ca\>][email].
  44
  45 [email]: mailto:nbowler@draconx.ca
  46
  47 # License
  48
  49 RRace is free software: you can redistribute it and/or modify it under the
  50 terms of the GNU General Public License as published by the Free Software
  51 Foundation, either version 3 of the License or (at your option) any later
  52 version.
  53
  54 {::comment}
  55 Copyright © 2022 Nick Bowler
  56 {:/comment}