中文麻将助手安装与使用指南

中文麻将助手安装与使用指南

ChineseOfficialMahjongHelper国标麻将小助手——包含算番器、线下实麻计分器、番种详细说明、牌理等项目地址:https://gitcode.com/gh_mirrors/ch/ChineseOfficialMahjongHelper

1. 项目目录结构及介绍

ChineseOfficialMahjongHelper/
│
├── README.md       - 项目简介和指南
├── src/            - 源代码目录
│   ├── main.py     - 主程序入口
│   └── config.yaml - 配置文件
│
├── data/           - 存储数据和资源文件
│   ├── rules.json  - 麻将规则定义
│   └── logs/       - 日志文件夹
│
└── requirements.txt - 依赖项列表

• README.md: 提供项目的基本信息和使用说明。
• src/main.py: 项目的主执行文件，负责加载配置并运行麻将辅助逻辑。
• config.yaml: 用于设置应用行为的配置文件。
• data/rules.json: 麻将规则的JSON格式定义，可按需自定义。
• data/logs/: 存放程序运行时的日志文件。
• requirements.txt: 列出项目所需的Python库，用于环境搭建。

2. 项目的启动文件介绍

在终端中，确保已进入ChineseOfficialMahjongHelper根目录，然后执行以下命令启动项目：

python src/main.py

src/main.py是项目的核心部分，它会读取config.yaml中的配置，处理麻将算法，以及进行日志记录等操作。

3. 项目的配置文件介绍

config.yaml

game_mode: official  # 游戏模式（official: 正式规则；custom: 自定义规则）
debug: true          # 是否开启调试模式（日志输出更详细）
rules:                # 配置麻将规则（此处应对应data/rules.json中的键值）
  scoring_system: "default"
  max_rounds: 8
  extra_rounds_for_win: 1
logging:
  level: info         # 日志级别（debug, info, warning, error, critical）
  file_path: ./data/logs/app.log  # 日志文件路径

• game_mode: 设定游戏使用的基础规则，可以是"official"（正式规则）或"custom"（自定义规则）。
• debug: 开启或关闭调试模式，影响日志的详细程度。
• rules: 配置麻将的具体玩法，如计分系统、最大局数和胜利额外局数等。
• logging: 设置日志相关参数，包括日志级别和日志保存位置。

完成上述步骤后，您就可以开始使用这个中文麻将助手了。如果有任何疑问，参考README.md或查看源代码以获取更多帮助。祝您好运，玩得愉快！

ChineseOfficialMahjongHelper国标麻将小助手——包含算番器、线下实麻计分器、番种详细说明、牌理等项目地址:https://gitcode.com/gh_mirrors/ch/ChineseOfficialMahjongHelper