https://github.com/iplaylf2/lf2-taiwu-mods
🎮 太吾绘卷 Mod 开发模板 - 现代化工具链与自动化构建系统
https://github.com/iplaylf2/lf2-taiwu-mods
dotnet mod monorepo taiwu unity
Last synced: 5 months ago
JSON representation
🎮 太吾绘卷 Mod 开发模板 - 现代化工具链与自动化构建系统
- Host: GitHub
- URL: https://github.com/iplaylf2/lf2-taiwu-mods
- Owner: iplaylf2
- License: bsd-3-clause
- Created: 2025-06-12T15:46:51.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2025-11-16T11:47:20.000Z (8 months ago)
- Last Synced: 2025-11-16T12:21:37.926Z (8 months ago)
- Topics: dotnet, mod, monorepo, taiwu, unity
- Language: C#
- Homepage:
- Size: 185 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 太吾绘卷 Mod 开发模板
本仓库汇总了在 Mod 开发实践中沉淀的通用模板与工作区，旨在通过现代化的工具链和高度自动化的构建系统，为开发者提供一个高效、稳定且易于协作的开发环境。
## 核心特性
- ✅ **自动化项目配置**：只需按约定命名并创建项目，框架便会自动配置目标平台、依赖引用等所有繁琐细节。
- ✅ **依赖自动内嵌**：告别“DLL 冲突”，你发布的 Mod 将是单个独立的程序集文件。
- ✅ **完整智能提示**：游戏私有 API 也能获得完整的代码提示，如同调用原生函数般流畅自然。
- ✅ **一键式环境准备**：仅需一个 `dotnet restore` 命令，即可从官方 NuGet 源和 GitHub Packages 自动拉取所有依赖。
## 快速上手
本章节将引导你完成从环境配置到创建第一个 Mod 的完整流程。
### 前置条件
- **.NET SDK**：版本需满足 [`global.json`](./global.json) 文件中的定义。
- **GitHub PAT**：一个拥有 `read:packages` 权限的 [Personal Access Token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)。
### 1. 环境配置
本项目的依赖分为两部分：一部分来自官方 NuGet 源的标准库，另一部分是托管在 GitHub Packages 上的项目特有库。因此，你需要配置凭据以访问 GitHub Packages。
**VS Code / 命令行用户**：
1. 将你的 GitHub 用户名和 PAT 配置为环境变量 `GITHUB_USERNAME` 和 `GITHUB_TOKEN`
2. 在项目根目录运行 `dotnet restore`。该命令会自动拉取所有必要的 NuGet包
> [!TIP]
> **Visual Studio 用户**：如果遇到凭据配置或 Release 编译报错等问题，请查阅专门的[环境配置指南](./docs/how-to/visual-studio-setup.md)。
> [!WARNING]
> 理想情况下，`dotnet restore` 能一键拉取所有依赖。但由于分发游戏文件存在法律风险，**本模板并未包含游戏核心库的在线包**。因此，在首次配置环境时，你可能会遇到 `NU1101` 等“包找不到”的错误。要解决此问题，你需要将这些缺失的依赖打包并推送至开发者自己的远程 NuGet 源。具体方法请参阅 [**非托管依赖项设置指南**](./projects/unmanaged-vendor/README.md)。
### 2. 创建你的第一个 Mod
本框架遵循**约定优于配置**的理念，将创建新 Mod 的流程极大简化：
1. 在 `projects/mods/` 目录下为你的新 Mod 创建一个文件夹，例如 `MyNewMod`
2. 在其中创建对应的项目文件夹，并遵循命名约定，例如 `MyNewMod.Backend`
3. 在项目文件夹中，创建一个最简化的 C# 项目文件 `MyNewMod.Backend.csproj`：
```xml
```
完成！仅需遵循 `.Backend` 或 `.Frontend` 的命名约定，构建系统就会自动完成所有配置[^1]。你无需关心任何构建细节，可以立即开始编写 Mod 逻辑。
### 3. 开始编码
现在，在你的项目文件夹中添加 C# 代码（如 `ModEntry.cs`），并遵循游戏官方的 Mod 开发文档编写逻辑即可。
### 4. 构建与发布
准备交付时，执行一次 `dotnet build -c Release -t:LF2PublishMod -p:LF2Mod=` 即可产出游戏可识别的目录结构（默认输出在 `.lf2.publish//`）[^2]。
## 进一步阅读
- **[文档索引](./docs/README.md)**：浏览完整的文档分类，按需跳转到操作指南与参考资料。
- **[仓库内 Mod 导览](./projects/mods/README.md)**：查看目前包含的 Mod 列表、状态与源码路径。
## 相关资源
- **[仓库目录结构](./docs/reference/repository-layout.md)** - 了解模板约定的项目命名与目录职责。
- **[构建系统参考 - Mod 打包使用指南](./docs/reference/build-system.md#mod-打包使用指南)** - 深入掌握 `LF2PublishMod` 打包目标的工作流程。
## 贡献与反馈
欢迎通过提交 Issue 或 Pull Request 来为本项目做出贡献。
## 参考资料
[^1]: `.Backend` 和 `.Frontend` 后缀是构建系统识别项目类型的关键约定，系统会据此自动配置相应的依赖和构建参数。
[^2]: `LF2PublishMod` 是构建系统提供的发布目标，负责产出符合游戏规范的发布目录结构。