PalWorld Server Toolkit 使用教程

PalWorld Server Toolkit 使用教程

palworld-server-toolkit PalWorld Server Toolkits - For Save file modify, list the players, repair sav file, etc... 项目地址: https://gitcode.com/gh_mirrors/pa/palworld-server-toolkit

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

PalWorld Server Toolkit 的目录结构如下：

palworld-server-toolkit/
├── docs/                # 文档目录
├── img/                 # 图片资源目录
├── palworld_server_toolkit/  # 项目主目录
│   ├── save_tools/      # 存档工具模块
│   ├── .gitignore       # Git忽略文件
│   ├── .gitmodules      # Git子模块配置文件
│   ├── CHANGELOG.rst    # 更新日志
│   ├── LICENSE          # MIT 许可证文件
│   ├── MANIFEST.in       # 打包文件列表
│   ├── README.en.md      # 英文README文件
│   ├── README.md         # 简体中文README文件
│   ├── pyproject.toml    # Python项目配置文件
│   ├── requirements.txt  # 项目依赖文件
│   ├── setup.cfg         # 打包配置文件
│   └── ...
└── ...

• docs/: 存放项目的文档。
• img/: 存放项目相关的图片资源。
• palworld_server_toolkit/: 项目主目录，包含所有项目文件和模块。
  • save_tools/: 存档工具模块，包含用于修改和管理PalWorld存档的工具。
  • .gitignore: 指定Git忽略的文件和目录。
  • .gitmodules: 配置Git子模块。
  • CHANGELOG.rst: 记录项目的历史更新和改动。
  • LICENSE: 项目的MIT许可证文件。
  • MANIFEST.in: 指定打包时包含的文件和目录。
  • README.en.md: 项目的英文介绍。
  • README.md: 项目的简体中文介绍。
  • pyproject.toml: Python项目配置文件，用于定义项目信息和依赖。
  • requirements.txt: 项目依赖的Python包列表。
  • setup.cfg: 打包配置文件。

2. 项目的启动文件介绍

项目的启动文件为 palworld_server_toolkit/editor.py，这是项目的主要执行文件。用户可以通过命令行运行此文件，以执行各种存档编辑操作。

启动文件的基本使用命令如下：

python3 -m palworld_server_toolkit.editor [options] <Level.sav>

其中，[options] 是可选参数，<Level.sav> 是需要操作的存档文件。

3. 项目的配置文件介绍

项目的配置文件主要集中在 pyproject.toml 和 requirements.txt。

• pyproject.toml: Python项目配置文件，用于定义项目名称、版本、作者、依赖关系等。例如：

[project]
name = "palworld-server-toolkit"
version = "0.8.3"
description = "PalWorld Server Toolkit"
authors = ["magicbear <magicbear@example.com>"]
dependencies = [
    "requests",
    "pyyaml",
    # 其他依赖
]

• requirements.txt: 列出了项目运行所依赖的Python包，例如：

requests
pyyaml
# 其他依赖

这些配置文件确保了项目可以在有正确依赖关系的环境中正确运行。

palworld-server-toolkit PalWorld Server Toolkits - For Save file modify, list the players, repair sav file, etc... 项目地址: https://gitcode.com/gh_mirrors/pa/palworld-server-toolkit