3 Play klondike and spider solitaire in your unicode terminal.
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.
14 For details and screenshots see the project homepage at
15 **https://gir.st/sol.htm**
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.
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`.
35 * TODO: suggest moves (`h` => hint)
36 * TODO: cleanup: in `x2y()` functions there is a lot of replication and noise
37 when calculating legal moves, top cards, etc.
39 * TODO: visbell changes: instead of screen, flash active {cursor,card} {red,twice}?
40 * TODO: differential drawing mode (at least for highlighting cards)
41 * TODO: `.` command (repeat last action)
42 read data fron undo-head?
43 * TODO: `wait_mouse_up()` sometimes hangs in kde konsole (trash the `level++`
44 and just return an error)
46 * TODO: ellipsis overlap: if more than three cards in a row overlap, replace
47 middle ones with an ellipsis
48 * TODO: mouse mode improvements:
49 - spider/freecell: detect how many cards to move to empty pile
50 (must find exact position despite `extreme_overlap`)
51 * TODO: scores, variants: draw 3, max. n overturns
52 * TODO: klondike/freecell: auto-move to foundation (optional)
53 workaround: multiple joins to foundation
54 * TODO: vt220 mode (problems: charset, slow baudrate and no differential drawing mode)
55 * TODO: ed(1) mode (solEDaire): playable on a line printer; ascii/ibm only?
58 * DONE: use `#ifdef`s to differentiate games (sol, spider, ed-sol, ed-spider)
59 * DONE: keyboard alias: twice same key == waste/pile -> foundation
60 * DONE: spider keyboard: `<from><to>` stacks; 1-9,0=tableu, return=draw
61 * DONE: spider: easy/medium difficulty: only deal 1/2 suits instead of 4 -> deal()
62 * DONE: patience: allow taking from 0(foundation)
63 * DONE: highlight `from` pile, so users can see at what input stage they are
64 * DONE: make piles 0-indexed in klondike as well
65 * DONE: duplicate card ♠A found in tableu: added check at start to monitor this
66 Cannot reproduce, removed check
67 * DONE: bugs in spider's t2t()
68 * once segfaulted on large column
69 * sometimes doesn't work (ERR when it should be OK)
71 * DONE: some input functions are in `x2y()` -- move them to `get_cmd()` (req.
72 for mouse, hjkl modes)
73 * DONE: sigint, sigcont handler! atexit() to avoid inconsistent term state
74 * DONE: hjkl keyboard mode
75 * DONE: more vim mode keys (first/last tableu)
76 * DONE: online (key-)help `?`, `-h`, `-v` (NOTE: implemented -h, rest deemed
78 * DONE: extreme overlapping: if we are printing a sequence or multiple face down
79 cards, only print `.overlap` lines of the ends, and `1` line for the
81 * DONE: in direct addressing 'up to' dialog: make return/space select the lowest/highest option
83 - insert append_undo() in x2y() functions
84 - to encode stack position we need to overload `f.u.n` as index.
85 (similar for foundation: overload `f.u.n` as foundation id)
86 - w2f(): have to encode both stock index and foundation id
87 don't want to add a struct field for this one case;
88 for the time being (i.e. forever) I'm ORing waste index and
89 (foundation id<<16). ugly but works :/
90 - turning over cards: this needs to be encoded, because the card might
91 be consecutive and there's no way to tell what its previous state was.
92 * indicate that a card was turned (can be at most 1) by negating u.n
93 pros: no wasted space (it's just a boolean value), negation pattern
94 already used for closed cards
95 cons: dirty C hack, less obvious than in other places, no need to
96 conserve memory this tightly
97 * DONE: screen size > stack height => rendering issues!
98 as good as it's going to get, since we can't just not draw cards at all
99 * DONE: 'join to here' command (should take longest chain available)
100 * DONE: expose deal() seed for restarting the game
101 * DONE: make portable (clang on FreeBSD)
102 makefile's `$<` refuses to work if prequisite name != target name
104 ln -s sol.c. spider.c
105 sed -i 's/^spider: sol.c/spider: spider.c/' Makefile
106 * DONE: escape sequences (for real cursor keys)
107 * DONE: inverted moves (if A->B doesn't work, try B->A)
108 * DONE: - allow dragging the mouse
109 * DONE: use `10` instead of `X` on card face (/u/Valley6660)
110 * DONE: `:help` to show keyhelp (/u/Valley6660)
111 * DONE: don't show cursor-highlight when inputting directly or with the mouse (/u/TooEarlyForMe)
112 * DONE: remove sysmlink trickery and just call sol.c explicitly
113 * DONE FREECELL: t2t() multi card move and accompanying pop_undo()
114 * DONE: - mouse (term2pile() cell encoding, set_mouse(), wait_mouse_up())
115 * DONE FREECELL: don't allow selecting more cards than movable (`DO_HI, TOP_HI, cursor_{up,down}`)
116 * DONE: differentiate foundation placeholder from cells ph. (freecell)
117 * DONE FREECELL: join()
118 * DONE FREECELL: autodetect possible moves (card selector choice dialog)
125 {stock}[waste] [4*foundation]
128 [] (tableu piles) {} {}