Progress Quest CLI 版本的安装与使用教程

1. 项目的目录结构及介绍

Progress Quest CLI 版本是一个基于命令行的游戏，项目的目录结构如下：

pq-cli/
├── .gitignore
├── .pre-commit-config.yaml
├── LICENSE.md
├── README.md
├── poetry.lock
├── pyproject.toml
├── screen-basic.png
├── screen-curses-logo.png
├── screen-curses.png
└── pqcli/
    ├── __init__.py
    ├── pqcli.py
    └── ...

• .gitignore: 指定 Git 忽略的文件和目录。
• .pre-commit-config.yaml: 配置 pre-commit 钩子，用于在提交代码前自动执行一些格式化任务。
• LICENSE.md: 项目的许可协议文件，本项目采用 MIT 许可。
• README.md: 项目的说明文件，包含项目的基本信息和如何安装使用。
• poetry.lock: Poetry 包管理工具的锁文件，记录了项目依赖的确切版本。
• pyproject.toml: 项目配置文件，定义了项目的元数据和依赖。
• screen-basic.png, screen-curses-logo.png, screen-curses.png: 游戏界面截图。
• pqcli/: 游戏的主要代码目录，包含游戏的初始化和运行逻辑。

2. 项目的启动文件介绍

项目的启动文件位于 pqcli/pqcli.py。这个文件包含了游戏的入口点，当你运行 pqcli 命令时，Python 解释器会执行这个文件。

以下是启动文件的主要内容：

# 导入必要的模块
from pqcli import ...

# 游戏的主入口点
if __name__ == '__main__':
    # 初始化游戏
    game = Game()
    # 运行游戏
    game.run()

3. 项目的配置文件介绍

项目的配置文件是 pyproject.toml，它用于定义项目的基本信息，包括项目名称、版本、作者、依赖关系等。

以下是配置文件的部分内容：

[tool.poetry]
name = "pq-cli"
version = "0.1.0"
description = "Progress Quest: the CLI edition"
authors = ["Your Name <[e-mail]>"]

[tool.poetry.dependencies]
python = "^3.7"
# 这里会列出项目依赖的其他包

[tool.poetry.dev-dependencies]
# 这里会列出项目的开发依赖

在 pyproject.toml 文件中，[tool.poetry.dependencies] 部分定义了项目运行所需的依赖包，而 [tool.poetry.dev-dependencies] 部分定义了开发过程中需要的依赖包。

通过正确配置这个文件，你可以使用 Poetry 来管理项目的依赖，确保项目在不同的环境中能够一致地运行。