# TaiwuModTemplate

**Repository Path**: g_yl/taiwu-mod-template

## Basic Information

- **Project Name**: TaiwuModTemplate
- **Description**: 太吾Mod开发模板
- **Primary Language**: Unknown
- **License**: BSD-3-Clause
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2023-03-22
- **Last Updated**: 2023-04-04

## Categories & Tags

**Categories**: Uncategorized

**Tags**: 太吾绘卷

## README

# 太吾Mod解决方案模板
## 使用方法(小白可用)
1. 使用`git clone`或直接下载文件夹到本地
1. 修改得到的文件夹名称改为想要的mod(英文)名称,如`TWSmallTool`
1. 修改`TaiwuModTemplate.sln`文件名与上述名称相同,如`TWSmallTool.sln`
1. 双击`sln`文件，使用`visual studio`打开解决方案
1. 在git面板中选择`管理远程存储库`
1. 删除自带的远程仓库，添加自己的仓库
1. 进行开发
## 注意：使用前一定要配置StartTaiwu.bat和config.lua
***
## 模板结构
| 文件/文件夹 | 描述 |
| --- | --- |
| TaiwuModTemplate.sln | 解决方案（使用前改名） |
| Backend | 后端插件工程 |
| Frontend | 前端插件工程 |
| Common | 通用组件工程 |
| Plugins | 模组插件文件夹(编译后的dll自动放在该目录) |
| Corver.png | 模组封面 |
| Config.lua | 模组配置文件 （使用前配置） |
| StartTaiwu.bat | 开发mod时一件启动mod的批处理文件(使用前需修改路径配置,详见后续描述) |

***
## 模板工程介绍
### Common
- 前后端都需要的类可以写在该项目中
- 生成路径 `Plugins`

### Backend 
- 后端使用的插件
- 基础引用dll
    - 0Harmony
    - TaiwuModdingLib
    - GameData
    
- 生成路径`Plugins`
    - 已实现，若需要重新设置请参考下面
    ```xml
    <PropertyGroup>
        <TargetFramework>net5.0</TargetFramework>
        <AppendTargetFrameworkToOutputPath>Plugins</AppendTargetFrameworkToOutputPath>
        <OutputPath>../Plugins</OutputPath>
        <AllowUnsafeBlocks>True</AllowUnsafeBlocks>
    </PropertyGroup>
    ```

### Frontend
- 前端使用的插件
- 基础引用dll
    - 0Harmony
    - TaiwuModingLib
    - Assembly-CSharp
    - 其他Unity相关dll

### StartTaiwu.bat
- 解决方案编译后，一键复制Mod相关文件到配置好的文件中并通过Steam启动太吾
- 使用前配置太吾路径以及mod文件名，并保证`Plugins`下有内容
```bat
@echo off

Rem 配置太吾Mod的目标目录（不要带双引号，以 / 结尾）
set target_dir=D:/Program/Steam/steamapps/common/The Scroll Of Taiwu/Mod/ModTemplate/


set plugins_dir="%target_dir%Plugins"
set config_dir="%target_dir%Config.lua"
set cover_dir="%target_dir%Cover.png"
echo %target_dir%
echo %plugins_dir%
echo %config_dir%
echo %cover_dir%


Rem 删除原有的Plugins文件夹，以便同步最新的文件夹内容
rd /s /Q %plugins_dir%
mkdir %plugins_dir%
Rem 复制Plugins文件夹
Xcopy "./Plugins" %plugins_dir% /S /E /D /Y /C
Rem 复制配置文件和封面
cp "./Config.lua" %config_dir%
cp "./Cover.png" %cover_dir%

Rem 通过steam启动太吾
start steam://rungameid/838350
```
***
## Mod结构介绍
### Plugins
- Mod中使用相关dll，包含上述工程编译输出和其他必要的dll
### Conver.png
- Mod封面，会在游戏内的Mod面板显示
### Config.lua
- Mod配置文件