README.md

   1 # solVIItaire
   2
   3 play klondike and spider solitaire in your unicode terminal.
   4
   5 ## TODO
   6
   7 ### P1
   8 ### P2
   9  * TODO: undo:
  10          - insert append_undo() in x2y() functions
  11          - to encode stack position we need to overload `f.u.n` as index.
  12  * TODO: cleanup: in `x2y()` functions there is a lot of replication and noise
  13          when calculating legal moves, top cards, etc.
  14 ### P3
  15  * TODO: mouse mode
  16  * TODO: extreme overlapping: if we are printing a sequence or multiple face down
  17          cards, only print `.overlap` lines of the ends, and `1` line for the
  18          middle cards
  19  * TODO: screen size > stack height => rendering issues!
  20  * TODO: online (key-)help `?`, `-h`, `-v`
  21  * TODO: suggest moves (`h` => hint)
  22 ### P4
  23  * TODO: scores, variants: draw 3, max. n overturns
  24  * TODO: vt220 mode
  25  * TODO: ed(1) mode (solEDaire): playable on a line printer; ascii/ibm only?
  26
  27 ### DONE
  28  * DONE: use `#ifdef`s to differentiate games (sol, spider, ed-sol, ed-spider)
  29  * DONE: keyboard alias: twice same key == waste/pile -> foundation
  30  * DONE: spider keyboard: `<from><to>` stacks; 1-9,0=tableu, return=draw
  31  * DONE: spider: easy/medium difficulty: only deal 1/2 suits instead of 4 -> deal()
  32  * DONE: patience: allow taking from 0(foundation)
  33  * DONE: highlight `from` pile, so users can see at what input stage they are
  34  * DONE: make piles 0-indexed in klondike as well
  35  * HOLD: duplicate card ♠A found in tableu: added check at start to monitor this
  36          Cannot reproduce, removed check
  37  * DONE: some input functions are in `x2y()` -- move them to `get_cmd()` (req.
  38          for mouse, hjkl modes)
  39  * DONE: sigint, sigcont handler! atexit() to avoid inconsistent term state
  40  * DONE: hjkl keyboard mode
  41  * DONE: more vim mode keys (first/last tableu)
  42
  43 ## Notes
  44
  45  - terminology:
  46 ```
  47     {stock}[waste]    [4*foundation]
  48
  49     []   {}   {}   {}   {}   {}   {}
  50          []  (tableu piles)  {}   {}
  51               []   {}   {}   {}   {}
  52                    []   {}   {}   {}
  53                         []   {}   {}
  54                              []   {}
  55                                   []
  56 ```
  57  - data structures:
  58     - enum for each card (e.g. `SPADES_ACE`, `HEARTS_10`)
  59     - each pile is an array holding (13 open cards + up to 6 closed)
  60       [0] is the "northmost"/bottom-most card; unoccupied are NULL/NO_CARD
  61     - a single card is represented in the 'cards' enum; if it is closed, it is negated.
  62     - the foundation are 4 arrays of size 13
  63     - the stock pile is an array holding n cards and an index to the one to display
  64       when removing, decrement stack size and move all cards above index 1 over
  65     - previous states array: where to move which cards to get back to the state before
  66     - undo:
  67       double-linked list (follow `.prev` to undo, `.next` to redo)
  68       "N cards were moved from X to Y" (do Y->X to undo)
  69       allows jumping forwards in time as well (by repeating X->Y)
  70       warn: when appending state, must check if `.next` was non-NULL and free rest of chain if so.
  71  - multiple card sizes: schemes.h will store cards like below. if we want to draw a card
  72    that has one or more other cards below it, we only draw the first `.overlap` lines,
  73    otherwise if it is the last one, we draw the whole one.
  74    this will give a look like in `~/solitaire-tests`
  75 ```
  76     .grid=7, /*vertical alignment*/
  77     .overlap=2,
  78     .cards = [
  79        ["╭───╮",
  80         "│♠ X│",
  81         "│ ♠ │",
  82         "╰───╯",
  83           NULL],
  84     ]
  85     /*or:*/
  86     .grid=2,
  87     .overlap=1,
  88     .cards = [
  89       [ "🃖 ", NULL ],
  90     ]
  91 ```
  92 "open": face up card
  93 "closed": face down card