PapyrusDotNet 开源项目教程

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

PapyrusDotNet 是一个用于将 .NET 二进制文件编译成 Papyrus 脚本（.PEX 文件）的开源项目。以下是项目的目录结构及其介绍：

• Binaries: 存放编译后生成的二进制文件。
• Documentation: 包含项目的文档和说明文件。
• Examples: 提供了一些示例代码，帮助开发者了解如何使用 PapyrusDotNet。
• Output: 存放编译后的 Papyrus 脚本文件。
• Source: 源代码目录，包含了项目的所有 C# 源文件。
• .gitattributes: 定义了 Git 仓库中文件的属性。
• .gitignore: 指定了 Git 忽略的文件和目录。
• README.md: 项目的自述文件，包含了项目的介绍和基本使用说明。
• gpl-license.txt: 项目的许可文件，本项目采用 GPL v3 许可。

2. 项目的启动文件介绍

项目的启动文件是 PapyrusDotNet.exe，它是项目的可执行文件。以下是启动文件的基本介绍：

• 功能: 用于编译 .NET 二进制文件（.dll）到 Papyrus 脚本（.PEX 文件），或将 Papyrus 脚本（.PEX 文件）反编译到 .NET 库。

• 使用方法: 通过命令行调用，具体命令如下：

  PapyrusDotNet.exe <input> <output> [option] [<target papyrus version (-fo4 | -skyrim)>] [<compiler settings (-strict|-easy)>]
  

  其中：

  • <input>: 输入的 .dll 文件或包含 .pex 文件的文件夹。
  • <output>: 输出的文件夹。
  • [option]: 可选参数，用于指定编译选项。
  • [target papyrus version]: 可选参数，用于指定目标 Papyrus 版本（默认为 Fallout 4）。
  • [compiler settings]: 可选参数，用于指定编译器设置（默认为严格模式）。

3. 项目的配置文件介绍

项目的配置文件主要是 .gitignore 文件，它定义了 Git 仓库在提交时应该忽略的文件和目录。以下是配置文件的基本介绍：

• 功能: 告诉 Git 忽略特定的文件和目录，以避免将这些不需要的文件提交到仓库中。
• 内容: 例如，Binaries 文件夹通常会被忽略，因为它包含了编译后的二进制文件，这些文件不需要提交到版本控制中。

通过正确配置 .gitignore 文件，可以保持版本控制仓库的清洁和有序。