Palworld Save Tools 使用与安装指南

1. 项目目录结构及介绍

Palworld Save Tools 是一个专门用于处理 Palworld 游戏存档文件的工具包，支持将 .sav 文件转换成 JSON 格式，反之亦然。下面是项目的主要目录结构概览：

• root
  • convenience_tools: 实用工具或辅助脚本存放位置。
  • palworld_save_tools: 核心库代码所在，包含了转换 .sav 到 JSON 的逻辑。
    • scripts: 具体的脚本文件，如用于转换的命令行工具。
    • tests: 单元测试相关文件。
  • gitignore: Git 忽略文件。
  • pre-commit-config.yaml: 预提交钩子配置，确保代码质量。
  • LICENSE: 许可证文件，遵循 MIT 协议。
  • README.md: 项目说明文档，包含快速入门信息。
  • hatch.toml, pyproject.toml: 构建和依赖管理配置文件。
• Releases: 在GitHub页面上，你可以找到项目的版本发布记录和对应的下载链接。

2. 项目的启动文件介绍

命令行界面（CLI）使用

核心功能通过命令行工具提供，主要启动文件是位于 scripts 目录下的 convert.py。用户不需要直接编辑这个文件来运行程序，而是通过以下方式调用它：

• 对于图形界面用户，可以直接通过预编译的二进制文件或者运行 convert cmd （在Windows环境下），将 .sav 文件拖放到该命令上来转换。
• 在终端环境中，需定位到解压后的项目目录，然后执行相应的Python命令（比如 python convert.py <路径至.sav文件>）以实现文件的转换。

3. 项目的配置文件介绍

主要配置文件

项目中直接涉及配置的主要有两个方面，但并不直接提供传统意义上的单独配置文件给最终用户调整。其配置管理通过如下方式体现：

• pre-commit-config.yaml: 这个文件用于设置Git的预提交钩子，更多是开发者层面的配置，帮助维护代码风格和质量，对用户直接操作影响较小。

• 构建与依赖管理: 项目使用hatch.toml 和 pyproject.toml 来定义项目结构、依赖以及如何打包项目。虽然这些是重要的配置文件，普通用户在使用已发布的工具时通常无需直接介入修改。

总之，Palworld Save Tools的设计侧重于易用性，用户在使用过程中主要通过简单的命令行交互完成操作，而复杂的内部配置细节则隐藏在开发者的工作流之中。用户层面上，了解如何调用核心脚本进行转换就足以满足日常需求。