README.md

   1 # solVItaire
   2
   3 Play klondike and spider solitaire in your unicode terminal.
   4
   5 Supports `vi` style keybindings (hjkl), cursor keys and the mouse. Press `J` to
   6 'join' a well-suited pile to the cursor. `Space` locks in a selection, and
   7 `Return` pulls cards from the stack in spider solitaire. Piles can also be
   8 *directly addressed* by the number below them (or 8, 9, 0 for stack, waste and
   9 foundation in klondike).
  10 See `$PROGNAME -h` for details.
  11
  12 ## Details
  13
  14 For details and screenshots see the project homepage at
  15 **https://gir.st/sol.htm**
  16
  17 ## Makefile Options
  18
  19 By default the character set uses an `X` to for the 10 card. Compile with `make
  20 DECIMAL_TEN=1` to display the letters `10` instead.
  21
  22 ## License
  23
  24 You can use, study, share and improve this software under the terms of the GNU
  25 General Public License, version 3. Copyright 2019 Tobias Girstmair. For
  26 licensing details, see `LICENSE`.
  27
  28 <details><summary>
  29 <h2>TODO</h2>
  30 </summary>
  31
  32 ### P1
  33 <!-- * none! \o/-->
  34  * TODO FREECELL: autodetect possible moves (card selector choice dialog)
  35 ### P2
  36  * TODO: suggest moves (`h` => hint)
  37  * TODO: cleanup: in `x2y()` functions there is a lot of replication and noise
  38          when calculating legal moves, top cards, etc.
  39 ### P3
  40  * TODO: visbell changes: instead of screen, flash active {cursor,card} {red,twice}?
  41  * TODO: differential drawing mode (at least for highlighting cards)
  42  * TODO: `.` command (repeat last action)
  43  * TODO: FreeCell (/u/CFWhitman) - req' algorithm for moving multiple cards around
  44          for first multicardmove impl.: allow moving (n+1) cards where n is empty spaces
  45 ### P4
  46  * TODO: ellipsis overlap: if more than three cards in a row overlap, replace
  47          middle ones with an ellipsis
  48  * TODO: differentiate foundation placeholder from cells ph. (freecell)
  49  * TODO: mouse mode improvements:
  50           - spider: detect how many cards to move to empty pile
  51             (must find exact position despite `extreme_overlap`)
  52  * TODO: scores, variants: draw 3, max. n overturns
  53  * TODO: vt220 mode (problems: charset, slow baudrate and no differential drawing mode)
  54  * TODO: ed(1) mode (solEDaire): playable on a line printer; ascii/ibm only?
  55
  56 ### DONE
  57  * DONE: use `#ifdef`s to differentiate games (sol, spider, ed-sol, ed-spider)
  58  * DONE: keyboard alias: twice same key == waste/pile -> foundation
  59  * DONE: spider keyboard: `<from><to>` stacks; 1-9,0=tableu, return=draw
  60  * DONE: spider: easy/medium difficulty: only deal 1/2 suits instead of 4 -> deal()
  61  * DONE: patience: allow taking from 0(foundation)
  62  * DONE: highlight `from` pile, so users can see at what input stage they are
  63  * DONE: make piles 0-indexed in klondike as well
  64  * DONE: duplicate card ♠A found in tableu: added check at start to monitor this
  65          Cannot reproduce, removed check
  66  * DONE: bugs in spider's t2t()
  67          * once segfaulted on large column
  68          * sometimes doesn't work (ERR when it should be OK)
  69          Cannot reproduce
  70  * DONE: some input functions are in `x2y()` -- move them to `get_cmd()` (req.
  71          for mouse, hjkl modes)
  72  * DONE: sigint, sigcont handler! atexit() to avoid inconsistent term state
  73  * DONE: hjkl keyboard mode
  74  * DONE: more vim mode keys (first/last tableu)
  75  * DONE: online (key-)help `?`, `-h`, `-v` (NOTE: implemented -h, rest deemed
  76          not usedul)
  77  * DONE: extreme overlapping: if we are printing a sequence or multiple face down
  78          cards, only print `.overlap` lines of the ends, and `1` line for the
  79          middle cards
  80  * DONE: in direct addressing 'up to' dialog: make return/space select the lowest/highest option
  81  * DONE: undo:
  82          - insert append_undo() in x2y() functions
  83          - to encode stack position we need to overload `f.u.n` as index.
  84            (similar for foundation: overload `f.u.n` as foundation id)
  85          - w2f(): have to encode both stock index and foundation id
  86                   don't want to add a struct field for this one case;
  87                   for the time being (i.e. forever) I'm ORing waste index and
  88                   (foundation id<<16). ugly but works :/
  89          - turning over cards: this needs to be encoded, because the card might
  90            be consecutive and there's no way to tell what its previous state was.
  91             * indicate that a card was turned (can be at most 1) by negating u.n
  92               pros: no wasted space (it's just a boolean value), negation pattern
  93                     already used for closed cards
  94               cons: dirty C hack, less obvious than in other places, no need to
  95                     conserve memory this tightly
  96  * DONE: screen size > stack height => rendering issues!
  97          as good as it's going to get, since we can't just not draw cards at all
  98  * DONE: 'join to here' command (should take longest chain available)
  99  * DONE: expose deal() seed for restarting the game
 100  * DONE: make portable (clang on FreeBSD)
 101          makefile's `$<` refuses to work if prequisite name != target name
 102          Fix:
 103              ln -s sol.c. spider.c
 104              sed -i 's/^spider: sol.c/spider: spider.c/' Makefile
 105  * DONE: escape sequences (for real cursor keys)
 106  * DONE: inverted moves (if A->B doesn't work, try B->A)
 107  * DONE:  - allow dragging the mouse
 108  * DONE: use `10` instead of `X` on card face (/u/Valley6660)
 109  * DONE: `:help` to show keyhelp (/u/Valley6660)
 110  * DONE: don't show cursor-highlight when inputting directly or with the mouse (/u/TooEarlyForMe)
 111  * DONE: remove sysmlink trickery and just call sol.c explicitly
 112  * DONE FREECELL: t2t() multi card move and accompanying pop_undo()
 113  * DONE:   - mouse (term2pile() cell encoding, set_mouse(), wait_mouse_up())
 114  * DONE FREECELL: don't allow selecting more cards than movable (`DO_HI, TOP_HI, cursor_{up,down}`)
 115 </details>
 116
 117 ## Notes
 118
 119  - terminology:
 120 ```
 121     {stock}[waste]    [4*foundation]
 122
 123     []   {}   {}   {}   {}   {}   {}
 124          []  (tableu piles)  {}   {}
 125               []   {}   {}   {}   {}
 126                    []   {}   {}   {}
 127                         []   {}   {}
 128                              []   {}
 129                                   []
 130 ```