klondike-rs

Rust 编写的 CLI 克隆地扑克牌游戏

从 Crates.io 安装

运行 klondike-rs 的最简单方法是使用 Cargo 从 crates.io 安装。

$ cargo install klondike-rs

Cargo 将需要下载和编译所有必要的依赖项，以及编译此项目的源代码，因此可能需要一些时间。

然后，假设 Cargo 已设置在您的路径中，您可以使用以下命令运行它

$ klondike-rs

如果您没有 Rust（或 Cargo，其构建工具），您可以使用 Rustup 获取。我会尽量保持项目在稳定 Rust 上编译，但如果我想使用一个非常棒的特性，我保留要求使用 nightly 的权利。 :)

从源代码编译

从 crates.io 安装实际上是编译源代码，但如果您想查看代码并进行操作，可以使用以下命令

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

$ cd klondike-rs
$ cargo run  

要了解更多关于 Cargo 的信息，您可以查看 Cargo 书籍。

控制

您始终可以输入 h 或 ? 以获取帮助屏幕！

待编写…

配置

配置使用 TOML，这是 Rust 项目中流行的标记语言。以下是设置所有设置为其默认值的示例配置文件，因此您只需包含一个密钥，如果要更改其值。

[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

配置文件从几个位置检索，具体取决于您的操作系统。

• $HOME/.klondike-rs.toml — 任何操作系统
  • 例如，/home/chris/.klondkie-rs.toml
• $XDG_CONFIG_HOME/klondike-rs/config.toml — 仅限 Linux
  • 例如，/home/chris/.config/klondkie-rs/config.toml
• $HOME/Library/Preferences/net.upliftinglemma.klondike-rs/config.toml — 仅限 MacOS
  • 例如，/Users/Chris/Library/Preferences/net.upliftinglemma.klondike-rs/config.toml
• {FOLDERID_RoamingAppData}\upliftinglemma\klondike-rs\config\config.toml — 仅限 Windows
  • 例如，C:\Users\Chris\AppData\Roaming\upliftinglemma\klondike-rs\config\config.toml

TODO

该项目仍然是 非常 初级的，但至少可以运行。一些仍然需要发生的高级事情

• 尊重有关颜色和 Unicode 的配置。
• 记录所有公共结构体和函数，并重新启用 warn(missing_docs)。
• 提供更多外观配置，例如，卡片背面。

贡献

待编写…