CSOL(6)

📦 version 1.6.0, in nixpkgs unstable

💖 CSOL(6) — NAME 💖

okay so bestie, meet csol — it’s here to play solitaire. that’s the whole vibe. iconic. 💅

✨ SYNOPSIS ✨

csol [-ChlmSTv] [-c file] [-s seed] [-t theme] [game]

yes queen, that’s the whole shape of it. keep it close. 🫶

🦋 DESCRIPTION 🦋

csol is a small collection of solitaire games. tiny but mighty, no cap. 💖

🎀 OPTIONS 🎀

  • -c file, --config=file — set the configuration file to use. your config, your rules, your era. ✨
  • -C, --colors — show every color currently available in the terminal. this is highkey useful when you’re creating themes for csol. press any key to exit. yes, any key. 👑
  • -h, --help — show a summary of the available command-line options, then exit. lil cheat sheet behavior. 🫶
  • -l, --list — show a list of available games, then exit. window shopping but for solitaire. 🌸
  • -m, --mono — disable all colors. monochrome moment, very minimalist of you. 🖤
  • -s seed, --seed=seed — set the seed used for shuffling cards. it must be an integer. by default, the current time is used as seed. fate via clock, basically. ⭐
  • -S, --scores — if no game has been selected, then a table of scores and statistics for all games is shown. if a game has been selected, a list of all scores in that game is shown. stats girlies rise. 🔥
  • -t theme, --theme=theme — set the theme to use for drawing cards. use --themes to see a list of all available themes. aesthetic upgrade unlocked. 🎀
  • -T, --themes — show a list of available themes, then exit. theme haul incoming. 🛍️
  • -v, --version — show the csol version, then exit. the lore. 💜

🌈 KEYS 🌈

  • h, j, k, l, Left, Down, Up, Right — move cursor left, down, up, or right. the classic little dance. 💃
  • H, L, S-Left, S-Right — move cursor to the leftmost or rightmost position. zoom to the edge, bestie. 🦋
  • J, S-Down — move cursor to the bottommost position of the pile under the cursor, or to the topmost visible card of the next pile down if it’s already at the bottommost position. down-down behavior. ⬇️
  • K, S-Up — move cursor to the topmost position of the pile under the cursor, or to the bottommost card of the next pile up if it’s already at or above the topmost visible card. up-up behavior. ⬆️
  • Space — select the card under the cursor, or — if the card is already selected — move the selected card to a foundation or free cell if possible. the main-character key fr. 🌟
  • m, Enter, ^J — move the selected card to the pile under the cursor. yes ma’am, move it. 💅
  • a — automatically move a card from any tableau, waste, or cell to a foundation pile if possible. auto-move ate. 🔥
  • s — move a card from the stock to the waste, or redeal if stock is empty. stock said next. 🃏
  • W — move card from the waste to the pile under the cursor. waste not, want not. ✨
  • 1, 2, 3, 4, 5, 6, 7, 8, 9 — move a card from a cell (in Frecell-style games) to the pile under the cursor. number keys, but make it solitaire. 🔢
  • u, ^Z — undo one or more moves. take-backs are valid here. 😭
  • U, ^Y, ^R — redo a move that was previously undone. bringing it back like it never left. 💫
  • Esc, ^[ — clear the current selection. unselect, unbothered. 🙈
  • ^S — toggle smart cursor, see smart_cursor in the configuration section. cursor brain on/off. 🧠
  • ^V — toggle vertical stabilization of smart cursor, see keep_vertical_position in the configuration section. keep that vertical vibe steady. 📏
  • ^L — redraw the screen. visual refresh, because sometimes we all need one. 🌸
  • r — shuffle the deck and deal a new game. reset era. 🔄
  • F10 — open the menu. use the arrow keys or mnemonics (highlighted letters) to navigate. press Escape to exit the menu. fancy menu behavior. 🎛️
  • q — exit csol. bye bestie, slay responsibly. 👋

🐭 MOUSE 🐭

in terminals with mouse support, it’s possible to select cards using the left mouse button (same as Space) and to move cards using the right mouse button (same as m). mouse girlies, you’re seen. 🖱️💖

🌟 EXAMPLES 🌟

to play Klondike Solitaire, use the command:

csol klondike

to display all your Klondike scores, use the command:

csol -S klondike

copy, paste, serve. no cap. ✨

🛠️ CONFIGURATION 🛠️

the configuration can be changed by creating or editing the file ~/.config/csol/csolrc. a csol configuration file consists of a newline separated list of commands. most commands expect a single parameter. very demure, very structured. 🎀

an example configuration file that loads the system-wide configuration file, and changes the default game to Yukon:

include /etc/xdg/csol/csolrc
default_game yukon

the following top level commands are available:

  • default_game game — set the game that is selected by default when csol is run without arguments. your default, your destiny. 🌈
  • default_Theme theme — set the theme that is selected by default when csol is run without the -t option. theme chosen in advance, main character prep. 💅
  • scores bit — enable (1) or disable (0) the use of a file for keeping track of game scores. score-keeping toggle. 📊
  • stats bit — enable (1) or disable (0) the use of a file for keeping track of game statistics. stats-keeping toggle. 📈
  • scores_file file — set the file path used for the scores file. tell it where the scores live. 🗂️
  • stats_file file — set the file path used for the stats file. tell it where the stats live. 🗃️
  • show_score bit — enable (1) or disable (0) display of the current score in the bottom left corner of the screen. score in the corner, doing its lil thing. 🔢
  • smart_cursor bit — enable (1) or disable (0) the use of smart cursor movement. when enabled, the cursor will always move to a card. smart cursor said “i got you.” 🧠
  • keep_vertical_position bit — when enabled, the smart cursor behavior is changed so that the vertical position of the cursor doesn’t change when moving horizontally. this means that the cursor doesn’t always move to a card when changing horizontal position. vertical stabilization, but make it specific. 📐
  • alt_cursor bit — when enabled, a different style of cursor is used. alternative cursor aesthetic. 🖱️
  • include file — execute the commands of another configuration file. useful for including the system-wide configuration (i.e. games and themes) into your local configuration file. bring the whole group chat in. 🫶
  • theme_dir directory — lazily load themes from directory. when listing themes with -T, all configuration files in directory will be loaded. when playing a game, only the selected theme will be loaded based on its filename. lazy loading but make it fashion. 🎀
  • game_dir directory — lazily load games from directory. when listing games with -l, all configuration files in directory will be loaded. when playing a game, only the selected game will be loaded based on its filename. same lazy-loading energy, but for games. 🃏

it’s possible to define new games and themes using the csol configuration langauge. for more details, see https://github.com/nielssp/csol. yes, that URL is the blueprint. 🌈

signed with glitter and good taste: CSOL(6) from the Games Manual. the page itself doesn’t spell out a separate version or date, so I’m not inventing one — no fake tea here. bye bestie, go play solitaire 💋🎀💅

📦 where this page comes from