All Projects → chrisbouchard → klondike-rs

chrisbouchard / klondike-rs

Licence: MIT license
CLI Klondike Solitaire written in Rust

Programming Languages

rust
11053 projects

Projects that are alternatives of or similar to klondike-rs

fc-solve
Freecell Solver - a C library for automatically solving Freecell and some other variants of card Solitaire
Stars: ✭ 49 (+53.13%)
Mutual labels:  card-game, solitaire
csol
A small collection of solitaire/patience games (Klondike, FreeCell, Spider, Yukon, etc.) to play in the terminal
Stars: ✭ 25 (-21.87%)
Mutual labels:  card-game, solitaire
TermGL
2D & 3D graphics engine in the terminal [C/C++]
Stars: ✭ 219 (+584.38%)
Mutual labels:  terminal-based
card-game
Card game created in unity. Tribute to Astral Tournament.
Stars: ✭ 31 (-3.12%)
Mutual labels:  card-game
pendfetch
Double Pendulum visualised with fetching system information in Python.
Stars: ✭ 62 (+93.75%)
Mutual labels:  terminal-based
ll
ll - a more informative `ls`, based on `k`
Stars: ✭ 24 (-25%)
Mutual labels:  terminal-based
duel-masters
Browser based Duel Masters simulator.
Stars: ✭ 28 (-12.5%)
Mutual labels:  card-game
tod0
A Terminal Client for Microsoft To-Do
Stars: ✭ 93 (+190.63%)
Mutual labels:  terminal-based
cryptgo
A terminal application to watch crypto prices!
Stars: ✭ 123 (+284.38%)
Mutual labels:  terminal-based
uno-online
Two player online game of UNO. Made using React and Socket.IO
Stars: ✭ 106 (+231.25%)
Mutual labels:  card-game
CardGame
Unity prototype of a gambling card game DouDizhu
Stars: ✭ 29 (-9.37%)
Mutual labels:  card-game
cgol
Conway's Game of Life in the Terminal
Stars: ✭ 32 (+0%)
Mutual labels:  terminal-based
outfancy
Python3 library to print tables in Terminal.
Stars: ✭ 47 (+46.88%)
Mutual labels:  terminal-based
tjmj
网页的天津麻将,从 GoogleCode 导入,不活跃
Stars: ✭ 29 (-9.37%)
Mutual labels:  card-game
consoleTimer
Simple timer for your terminal
Stars: ✭ 20 (-37.5%)
Mutual labels:  terminal-based
qrrs
CLI QR code generator and reader written in rust
Stars: ✭ 29 (-9.37%)
Mutual labels:  terminal-based
asciiarena
Terminal multiplayer deathmatch game
Stars: ✭ 34 (+6.25%)
Mutual labels:  terminal-based
deerportal
Full of the diamonds 💎 board game driven by a 🦌 Deer 🦌 god and classical elements 🔥 💦 💨 🌍
Stars: ✭ 31 (-3.12%)
Mutual labels:  card-game
SpiderCard
蜘蛛纸牌 for mac
Stars: ✭ 29 (-9.37%)
Mutual labels:  card-game
htui
Heroku Terminal User Interface
Stars: ✭ 109 (+240.63%)
Mutual labels:  terminal-based

klondike-rs

Crates.io CircleCI

CLI Klondike Solitaire written in Rust

Default State Gameplay

Installing from Crates.io

The simplest way to run klondike-rs is to install it from crates.io using Cargo.

$ cargo install klondike-rs

Cargo will have to download and compile all necessary dependencies, as well as compile this project's source, so it may take a few moments.

Then, assuming Cargo is set up on your path, you can run it using

$ klondike-rs

If you don't have Rust (or Cargo, its build tool), you can get it using Rustup. I will try to keep the project compiling on stable Rust, but I reserve the right to require nightly if there's a really nice feature I want. :)

Compiling from Source

Technically installing from crates.io is compiling from source, but if you would like to check out the code and mess around with it, you can do so using

$ git clone https://github.com/chrisbouchard/klondike-rs.git
...

$ cd klondike-rs
$ cargo run  

To find out more about Cargo, you can check out The Cargo Book.

Controls

You can always type h or ? to get the help screen!

To be written…

Configuration

Configuration uses TOML, a popular mark-up language among Rust projects. Below is a sample configuration file which sets all settings to their default values, so you'd only need to include a key if you wanted to change its value.

[display]

# Whether to use ANSI color escapes
# TODO: Currently ignored
color = true

# Whether to use Unicode box-drawing characters
# TODO: Currently ignored
unicode = true


[game]

# How many cards to draw (usually 3 or 1)
# TODO: No bounds checking, so don't break things
draw_from_stock_len = 3

# Whether it's permitted to move a card out of a foundation
take_from_foundation = true

Configuration files are picked up from several locations, depending on your OS.

  • $HOME/.klondike-rs.tomlAny OS
    • E.g., /home/chris/.klondkie-rs.toml
  • $XDG_CONFIG_HOME/klondike-rs/config.tomlLinux only
    • E.g., /home/chris/.config/klondkie-rs/config.toml
  • $HOME/Library/Preferences/net.upliftinglemma.klondike-rs/config.tomlMacOS only
    • E.g., /Users/Chris/Library/Preferences/net.upliftinglemma.klondike-rs/config.toml
  • {FOLDERID_RoamingAppData}\upliftinglemma\klondike-rs\config\config.tomlWindows only
    • E.g., C:\Users\Chris\AppData\Roaming\upliftinglemma\klondike-rs\config\config.toml

TODO:

This project is still very alpha, but it's at least runnable. Some high-level things that still need to happen:

  • Respect configuration regarding color and Unicode.
  • Document all public structs and functions and re-enable warn(missing_docs).
  • Offer more cosmetic configuration, e.g., card backs.

Contributing

To be written…

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].