https://github.com/chrisbouchard/klondike-rs
CLI Klondike Solitaire written in Rust
https://github.com/chrisbouchard/klondike-rs
card-game cli klondike rust solitaire terminal-based
Last synced: 8 months ago
JSON representation
CLI Klondike Solitaire written in Rust
- Host: GitHub
- URL: https://github.com/chrisbouchard/klondike-rs
- Owner: chrisbouchard
- License: mit
- Created: 2019-02-08T13:28:05.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-11-15T03:53:36.000Z (over 6 years ago)
- Last Synced: 2025-02-07T13:47:26.325Z (over 1 year ago)
- Topics: card-game, cli, klondike, rust, solitaire, terminal-based
- Language: Rust
- Size: 394 KB
- Stars: 35
- Watchers: 3
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# klondike-rs
[![Crates.io][crate-badge]][crate]
[![CircleCI][ci-badge]][ci]
CLI Klondike Solitaire written in Rust
[ci-badge]: https://circleci.com/gh/chrisbouchard/klondike-rs.svg?style=shield
[ci]: https://circleci.com/gh/chrisbouchard/klondike-rs
[crate-badge]: https://img.shields.io/crates/v/klondike-rs
[crate]: https://crates.io/crates/klondike-rs
## Installing from Crates.io
The simplest way to run `klondike-rs` is to install it from [crates.io][crate]
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][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.
:)
[rustup]: https://rustup.rs/
### 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][cargo-book].
[cargo-book]: https://doc.rust-lang.org/cargo/index.html
## Controls
You can always type `h` or `?` to get the help screen!
_To be written…_
## Configuration
Configuration uses [TOML](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.
```toml
[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.toml` — _Any OS_
* E.g., `/home/chris/.klondkie-rs.toml`
* `$XDG_CONFIG_HOME/klondike-rs/config.toml` — _Linux only_
* E.g., `/home/chris/.config/klondkie-rs/config.toml`
* `$HOME/Library/Preferences/net.upliftinglemma.klondike-rs/config.toml` — _MacOS only_
* E.g., `/Users/Chris/Library/Preferences/net.upliftinglemma.klondike-rs/config.toml`
* `{FOLDERID_RoamingAppData}\upliftinglemma\klondike-rs\config\config.toml` — _Windows only_
* E.g., `C:\Users\Chris\AppData\Roaming\upliftinglemma\klondike-rs\config\config.toml`
[toml]: https://github.com/toml-lang/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…_