{"id":25230450,"url":"https://github.com/chrisbouchard/klondike-rs","last_synced_at":"2025-10-26T07:32:28.217Z","repository":{"id":57634729,"uuid":"169739018","full_name":"chrisbouchard/klondike-rs","owner":"chrisbouchard","description":"CLI Klondike Solitaire written in Rust","archived":false,"fork":false,"pushed_at":"2019-11-15T03:53:36.000Z","size":403,"stargazers_count":35,"open_issues_count":3,"forks_count":3,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-07T13:47:26.325Z","etag":null,"topics":["card-game","cli","klondike","rust","solitaire","terminal-based"],"latest_commit_sha":null,"homepage":null,"language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/chrisbouchard.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-02-08T13:28:05.000Z","updated_at":"2024-12-27T23:27:49.000Z","dependencies_parsed_at":"2022-09-26T20:20:41.533Z","dependency_job_id":null,"html_url":"https://github.com/chrisbouchard/klondike-rs","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrisbouchard%2Fklondike-rs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrisbouchard%2Fklondike-rs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrisbouchard%2Fklondike-rs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrisbouchard%2Fklondike-rs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/chrisbouchard","download_url":"https://codeload.github.com/chrisbouchard/klondike-rs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238289991,"owners_count":19447509,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["card-game","cli","klondike","rust","solitaire","terminal-based"],"created_at":"2025-02-11T11:59:07.875Z","updated_at":"2025-10-26T07:32:22.939Z","avatar_url":"https://github.com/chrisbouchard.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# klondike-rs\n\n[![Crates.io][crate-badge]][crate]\n[![CircleCI][ci-badge]][ci]\n\nCLI Klondike Solitaire written in Rust\n\n![Default State](https://i.imgur.com/QMd6Gbw.png)\n![Gameplay](https://i.imgur.com/m6gs2F1.png)\n\n[ci-badge]: https://circleci.com/gh/chrisbouchard/klondike-rs.svg?style=shield\n[ci]: https://circleci.com/gh/chrisbouchard/klondike-rs\n[crate-badge]: https://img.shields.io/crates/v/klondike-rs\n[crate]: https://crates.io/crates/klondike-rs\n\n\n## Installing from Crates.io\n\nThe simplest way to run `klondike-rs` is to install it from [crates.io][crate]\nusing Cargo.\n\n```\n$ cargo install klondike-rs\n```\n\nCargo will have to download and compile all necessary dependencies, as well as\ncompile this project's source, so it may take a few moments.\n\nThen, assuming Cargo is set up on your path, you can run it using\n\n```\n$ klondike-rs\n```\n\nIf you don't have Rust (or Cargo, its build tool), you can get it using\n[Rustup][rustup]. I will try to keep the project compiling on stable Rust, but\nI reserve the right to require nightly if there's a really nice feature I want.\n:)\n\n[rustup]: https://rustup.rs/\n\n\n### Compiling from Source\n\nTechnically installing from crates.io _is_ compiling from source, but if you\nwould like to check out the code and mess around with it, you can do so using\n\n```\n$ git clone https://github.com/chrisbouchard/klondike-rs.git\n...\n\n$ cd klondike-rs\n$ cargo run  \n```\n\nTo find out more about Cargo, you can check out [The Cargo Book][cargo-book].\n\n[cargo-book]: https://doc.rust-lang.org/cargo/index.html\n\n\n## Controls\n\nYou can always type `h` or `?` to get the help screen!\n\n_To be written\u0026hellip;_\n\n\n## Configuration\n\nConfiguration uses [TOML](toml), a popular mark-up language among Rust\nprojects. Below is a sample configuration file which sets all settings to their\ndefault values, so you'd only need to include a key if you wanted to change its\nvalue.\n\n```toml\n[display]\n\n# Whether to use ANSI color escapes\n# TODO: Currently ignored\ncolor = true\n\n# Whether to use Unicode box-drawing characters\n# TODO: Currently ignored\nunicode = true\n\n\n[game]\n\n# How many cards to draw (usually 3 or 1)\n# TODO: No bounds checking, so don't break things\ndraw_from_stock_len = 3\n\n# Whether it's permitted to move a card out of a foundation\ntake_from_foundation = true\n```\n\nConfiguration files are picked up from several locations, depending on your OS.\n\n* `$HOME/.klondike-rs.toml` \u0026mdash; _Any OS_\n    * E.g., `/home/chris/.klondkie-rs.toml`\n* `$XDG_CONFIG_HOME/klondike-rs/config.toml` \u0026mdash; _Linux only_\n    * E.g., `/home/chris/.config/klondkie-rs/config.toml`\n* `$HOME/Library/Preferences/net.upliftinglemma.klondike-rs/config.toml` \u0026mdash; _MacOS only_\n    * E.g., `/Users/Chris/Library/Preferences/net.upliftinglemma.klondike-rs/config.toml`\n* `{FOLDERID_RoamingAppData}\\upliftinglemma\\klondike-rs\\config\\config.toml` \u0026mdash; _Windows only_\n    * E.g., `C:\\Users\\Chris\\AppData\\Roaming\\upliftinglemma\\klondike-rs\\config\\config.toml`\n\n[toml]: https://github.com/toml-lang/toml\n\n\n## TODO:\n\nThis project is still _very_ alpha, but it's at least runnable. Some high-level\nthings that still need to happen:\n\n* Respect configuration regarding color and Unicode.\n* Document all public structs and functions and re-enable `warn(missing_docs)`.\n* Offer more cosmetic configuration, e.g., card backs.\n\n\n## Contributing\n\n_To be written\u0026hellip;_\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchrisbouchard%2Fklondike-rs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchrisbouchard%2Fklondike-rs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchrisbouchard%2Fklondike-rs/lists"}