PalEdit 项目教程

1. 项目目录结构及介绍

PalEdit 项目的目录结构如下：

PalEdit/
├── assets/
├── palworld_pal_edit/
├── github/
│   └── workflows/
├── .gitignore
├── CxFreezeCompile.py
├── LICENSE
├── PalEdit.py
├── README.md
├── compile.bat
├── requirements.txt
└── run.bat

目录结构介绍

• assets/: 存放项目所需的资源文件。
• palworld_pal_edit/: 包含与 PalWorld 游戏相关的编辑和生成功能的代码。
• github/workflows/: 存放 GitHub Actions 的工作流配置文件。
• .gitignore: Git 忽略文件，指定哪些文件或目录不需要被 Git 管理。
• CxFreezeCompile.py: 用于编译项目的 Python 脚本。
• LICENSE: 项目的开源许可证文件。
• PalEdit.py: 项目的启动文件，包含了主要的逻辑代码。
• README.md: 项目的说明文档，包含了项目的介绍、安装和使用说明。
• compile.bat: Windows 平台下的编译脚本。
• requirements.txt: 项目依赖的 Python 包列表。
• run.bat: Windows 平台下的运行脚本。

2. 项目启动文件介绍

项目的启动文件是 PalEdit.py。这个文件包含了 PalEdit 工具的主要逻辑代码，负责处理 PalWorld 游戏存档的编辑和生成功能。

主要功能

• 加载和保存存档: 处理 PalWorld 游戏存档的加载和保存操作。
• 编辑 Pal: 提供用户界面，允许用户编辑 Pal 的属性和特性。
• 生成 Pal: 根据用户输入生成新的 Pal。

代码示例

# PalEdit.py
import sys
from PyQt5.QtWidgets import QApplication, QMainWindow
from palworld_pal_edit.ui import MainWindow

if __name__ == "__main__":
    app = QApplication(sys.argv)
    mainWindow = QMainWindow()
    ui = MainWindow()
    ui.setupUi(mainWindow)
    mainWindow.show()
    sys.exit(app.exec_())

3. 项目的配置文件介绍

requirements.txt

requirements.txt 文件列出了项目依赖的 Python 包，用于确保项目在不同环境中的一致性。

PyQt5==5.15.4

.gitignore

.gitignore 文件指定了哪些文件或目录不需要被 Git 管理，例如编译生成的文件、临时文件等。

# .gitignore
*.pyc
__pycache__/
dist/
build/

compile.bat

compile.bat 是一个 Windows 批处理脚本，用于编译项目。它会调用 pyinstaller 工具将 Python 代码打包成可执行文件。

:: compile.bat
pyinstaller --noconfirm --onefile --windowed --icon "palworld_pal_edit/resources/MossandaIcon.ico" --hidden-import=PIL "PalEdit.py"

run.bat

run.bat 是一个 Windows 批处理脚本，用于运行项目。它会直接调用 Python 解释器运行 PalEdit.py。

:: run.bat
python PalEdit.py

通过以上介绍，您应该对 PalEdit 项目的目录结构、启动文件和配置文件有了基本的了解。希望这份教程能帮助您更好地理解和使用 PalEdit 项目。