这是我的另一个项目 meeple-cli 的重新想象和实现。

mpl

mpl; 简称 meeple /mipel/ 名词 - 桌游玩家代币。 (例如，BoardGameGeek (BGG) 公共 API 驱动的本地桌游收藏管理 CLI 工具。

跳转至： 功能 | 安装 | 使用 | 配置 | 资源 | 法律 | 文档 🔗

[!警告]
mpl 目前处于 ALPHA 阶段。这意味着它通常是不稳定的，可能缺少关键功能。请通过以下符号跟踪本 README 中的功能进度

符号	状态
✅	已实现 - 稳定
✳️	已实现 - 不稳定
🚧	进行中
❌	未开始

🎥 演示

即将推出。

✨ 功能

• 快速开始，通过 BGG 用户收藏导入
• 通过 BGG 热门、新发布、活跃众筹活动和 BGG 搜索发现新标题
• 通过搜索和打开 Geek Market 列表来增长您的收藏
• 灵活的本地收藏维护和定制
• 强大的跨收藏搜索，以找到游戏之夜的最佳标题
• 创建和管理个人评分
• 记录和查看游戏流程
• 支持多用户，具有个人资料
• 用 Rust 🦀 编写

📦 安装

使用以下任何一种方法安装 mpl，或阅读 文档 了解更多信息。然后运行 mpl --version 以验证安装。

跳转到: Homebrew | Scoop | Cargo | Remote | GitHub 发布 | 源代码

通过 Homebrew 🍺 (macOS/Linux) ❌ 安装

1. 添加 tap

   brew tap boldandbrad/tap
   

2. 安装公式

   brew install mpl-cli
   

通过 Scoop 🍦 (Windows) ❌ 安装

1. 添加 bucket

   scoop bucket add boldandbrad_scoop-bucket https://github.com/boldandbrad/scoop-bucket
   

2. 安装清单

   scoop install boldandbrad_scoop-bucket/mpl-cli
   

通过 Cargo 📦 🚧 安装

• 安装包

  cargo install mpl-cli
  

通过远程安装脚本 📜 ❌ 安装

[!NOTE] 远程安装脚本 会说明其功能并在执行前提示。

• 运行脚本

  curl -LSfs https://raw.githubusercontent.com/boldandbrad/mpl-cli/main/ci/install.sh | sh -s -- --git boldandbrad/mpl-cli
  

从 GitHub 发布手动安装 ⬇️ 🚧

1. 下载您平台的最新 GitHub 发布
2. 解压内容并将安装到您的 $PATH

从源代码手动安装 👩‍💻 🚧

1. 安装 Rust
2. 运行 git clone https://github.com/boldandbrad/mpl-cli 和 cd mpl-cli
3. 运行 cargo install --path .
4. 确保 ~/.cargo/bin 在您的 $PATH

🚀 使用方法

mpl

为了帮助您开始使用，首次运行 mpl 会创建一个默认配置文件，其名称与您的用户主目录相同（您可以选择使用 mpl profile rename 重命名），其中包含一个名为 collection 的藏匿处。

导入 BGG 用户收藏 🚢

mpl bgg import --user=boldandbrad

mpl 将引导您完成导入过程。完成后，查看您导入的收藏

mpl stash list --verbose

从头开始 🧼

mpl 依赖于 BoardGameGeek 项目 ID 来管理您添加到藏匿处的标题。获取这些 ID 的最简单方法是搜索 BoardGameGeek

mpl bgg search "wingspan"

从输出复制项目 ID 并用于其他命令

mpl add -s=collection 266192

您已将 Wingspan 🦜 添加到 collection 藏匿处！

现在让我们看看您的收藏里有什么

mpl titles -s=collection

运行 mpl --help 或阅读 文档 以了解下一步该做什么！

命令参考 📖

[!TIP]
您可以使用 mpl --help 来发现 mpl 命令和选项。

根 🚧

• mpl add 🚧 - 将标题添加到藏匿处
• mpl drop 🚧 - 从藏匿处删除标题
• mpl titles 🚧 - 列出藏匿处的标题
• mpl move ❌ - 将标题移动到另一个藏匿处
• mpl update ❌ - 更新本地藏匿处数据

藏匿处 🚧

管理活动配置文件中的本地藏匿处。

标志/选项

• -p/--profile - 在其中执行操作的配置文件（默认：活动配置文件）

命令

• mpl stash create 🚧 - 创建新的stash
• mpl stash delete 🚧 - 删除现有的stash
• mpl stash list 🚧 - 列出现有的stash
  • -/--verbose ❌ - 列出stash的统计数据
• mpl stash rename ❌ - 重命名现有的stash
• mpl stash info ❌ - 查看stash的详细信息
• mpl stash move ❌ - 将stash移动到另一个配置文件

BoardGameGeek 🚧

BoardGameGeek特定操作。

• mpl bgg search 🚧 - 在boardgamegeek搜索标题
  • 标志 --market ❌ - 搜索geek市场列表
• mpl bgg info 🚧 - 查看标题详细信息
• mpl bgg open ❌ - 打开boardgamegeek.com
  • 选项 --title - 打开标题的boardgamegeek页面
  • 选项 --campaign - 打开标题的众筹活动页面
  • 选项 --listing - 打开geek市场列表
• mpl bgg import ❌ - 导入bgg收藏
• mpl bgg hotness ❌ - 查看bgg热门列表
• mpl bgg campaigns ❌ - 列出活跃的众筹活动
• mpl bgg releases ❌ - 列出最近发布的内容

配置文件 🚧

管理用户配置文件。

• mpl profile active 🚧 - 显示当前配置文件
• mpl profile create ❌ - 创建新的配置文件
• mpl profile delete ❌ - 删除现有的配置文件
• mpl profile list 🚧 - 列出现有的配置文件
• mpl profile rename ❌ - 重命名现有的配置文件
• mpl profile switch ❌ - 切换活动配置文件

配置 🚧

管理配置。

默认情况下，配置文件级别的配置会覆盖全局配置。

标志/选项

• -/--global ❌ - 动作应用于全局选项。如果没有提供，则动作应用于活动配置文件选项。
• -/--force ❌ - 与 - 结合使用，更改所有配置文件默认配置值，并覆盖配置文件值

命令

• mpl config active ❌ - 显示当前配置
• mpl config options ❌ - 显示可用的配置选项
• mpl config set ❌ - 设置选项值
• mpl config unset ❌ - 将选项值还原为默认值
• mpl config complete 🚧 - 设置shell选项补全

评分 ❌

需要更多的思考和设计。

管理个人标题评分。

• mpl rating rate ❌ - 评分标题
• mpl rating unrate ❌ - 取消评分标题
• mpl rating tiers ❌ - 以层级列表显示评分标题

游玩 ❌

需要更多的思考和设计。

记录和管理标题游玩。

• mpl play log/create ❌ - 记录新的游玩
• mpl play delete ❌ - 删除现有的游玩
• mpl play list ❌ - 列出所有记录的游玩
  • 参数 BGG_ID ❌ - 列出标题的记录游玩
• mpl play stats ❌ - 查看标题游玩统计

⚙️ 配置

环境变量

mpl 尊重以下环境变量

• MPL_HOME/XDG_CONFIG_HOME - 修改.mpl/的存储位置。默认：~/.mpl/

配置选项

这些选项可以使用mpl config进行管理。

全局配置存储在.mpl/config.toml中。配置文件级别的配置存储在.mpl/<PROFILE>/config.toml中。

• update_on_change - 在添加/删除操作时自动传递--update。默认false
• default_stash - 执行添加/删除操作时的默认stash。默认collection

补全

mpl支持bash、zsh和fish的tab补全。设置时，运行mpl config completions <SHELL>。

📚 资源

• 变更日志 - 查看已实现的功能/变更的历史。
• 路线图 - 查看计划中的功能和里程碑。
• 常见问题解答 - 查找常见问题的答案。
• 贡献指南 ❌ - 了解如何参与其中。

⚖️ 法律

[!NOTE]
mpl及其维护者与BoardGameGeek无关联。

版权（c）2023 Bradley Wojcik。在MIT许可证下发布。有关详细信息，请参阅LICENSE。