diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index f66bf90..2ccbc46 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -98,6 +98,48 @@ module.exports = { selectText: '选择语言', label: '简体中文', editLinkText: '在 GitHub 上编辑此页', + algolia: {}, + nav: [ + { + text: '主页', + link: '/zh/', + }, + { + text: '指南', + link: '/zh/_intro/getting-started' + } + ], + sidebar: [ + { + title: '介绍', + sidebarDepth: 1, + children: [ + '/zh/_intro/getting-started', + '/zh/_intro/folder-structure', + '/zh/_intro/advanced' + ] + }, + { + title: '教程', + sidebarDepth: 1, + children: apiGen.getAPITree('docs/zh', '_tutorials') + }, + { + title: 'C# API', + sidebarDepth: 1, + children: apiGen.getAPITree('docs/zh', '_csharp-api') + }, + { + title: 'Gauntlet', + sidebarDepth: 1, + children: apiGen.getAPITree('docs/zh', '_gauntlet') + }, + { + title: 'XML 文档', + sidebarDepth: 1, + children: apiGen.getAPITree('docs/zh', '_xmldocs', false) + } + ] } } }, diff --git a/docs/zh/_tutorials/basic-csharp-mod.md b/docs/zh/_tutorials/basic-csharp-mod.md index 44fa049..2011a5d 100644 --- a/docs/zh/_tutorials/basic-csharp-mod.md +++ b/docs/zh/_tutorials/basic-csharp-mod.md @@ -58,8 +58,9 @@ 1. 启动 Microsoft Visual Studio 并且选择 `创建新项目`。 2. 选择 `类库 (.NET Framework)`。 3. 给项目起名字并且选择框架 `.NET Framework 4.7.2`。如果不能选这个选项,可以从[这里](https://dotnet.microsoft.com/download/dotnet-framework/net472)下载。下载\(开发者包\) -4. 现在你的项目已经创建好,设置你的[构建路径](https://docs.microsoft.com/en-us/visualstudio/ide/how-to-change-the-build-output-directory?view=vs-2019)到你的游戏目录下的`Modules/MyModule/bin/Win64_Shipping_Client`。 -5. [引用](https://docs.microsoft.com/en-us/visualstudio/ide/how-to-add-or-remove-references-by-using-the-reference-manager?view=vs-2019) 游戏目录(不是指Modules目录)`bin\Win64_Shipping_Client`下的所有`TaleWorlds.*` DLLs 文件。并且引用每个官方模组的 `TaleWorlds.*` DLLs文件,目录为 `Modules\ModuleName\bin\Win64_Shipping_Client`。 +4. 现在你的项目已经创建好,设置你的[构建路径](https://learn.microsoft.com/zh-cn/visualstudio/ide/how-to-change-the-build-output-directory?view=vs-2019)到你的游戏目录下的`Modules/MyModule/bin/Win64_Shipping_Client`。 +5. [引用](https://learn.microsoft.com/zh-cn/visualstudio/ide/how-to-add-or-remove-references-by-using-the-reference-manager?view=vs-2019) 游戏目录(不是指Modules目录)`bin\Win64_Shipping_Client`下的所有`TaleWorlds.*` .dll 文件。 +6. [引用](https://learn.microsoft.com/zh-cn/visualstudio/ide/how-to-add-or-remove-references-by-using-the-reference-manager?view=vs-2019) 每个官方模组的 .dll 文件,目录为 `Modules\Module 名称\bin\Win64_Shipping_Client`。 ### Debugging 项目 (可选) @@ -67,13 +68,13 @@ 1. 打开 项目属性 到 `Debug` 选项卡。 2. 选择 `启动外部程序` 选项,同时浏览到你游戏目录下(不是Modules目录)的`bin\Win64_Shipping_Client`文件夹里面的 `Bannerlord.exe`。 3. 设置工作目录到游戏目录(不是Modules目录)下的 `bin\Win64_Shipping_Client`。 -4. 添加如下的命令行参数(要确定替代 `MyModule` 的名字) +4. 添加如下的命令行参数(确保将 `MyModule` 替换成你 Module 的名称): * `/singleplayer _MODULES_*Native*SandBox*SandBoxCore*StoryMode*CustomBattle*MyModule*_MODULES_` #### 方法二 (如果你想从启动器窗口开始 Debugging) 1. 打开 项目属性 到 `Debug` 选项卡; 2. 选择 `打开外部程序` 选项同时浏览到你的游戏目录下(不是你的Mod目录)`bin\Win64_Shipping_Client` 文件夹下的 `TaleWorlds.MountAndBlade.Launcher.exe`; -3. 设定你的工作目录是游戏目录下的 `bin\Win64_Shipping_Client` +3. 设置工作目录到游戏目录(不是Modules目录)下的 `bin\Win64_Shipping_Client`。 ## 编程 @@ -86,8 +87,8 @@ using TaleWorlds.MountAndBlade; ``` -3. 继承 `MBSubModuleBase` 类 -4. 重载 `OnSubModuleLoad()` 方法 +3. 继承 `MBSubModuleBase` 类。 +4. 重载 `OnSubModuleLoad()` 方法。 5. 添加如下代码到这个方法: ```csharp @@ -95,7 +96,7 @@ new TextObject("消息", null), 9990, () => { InformationManager.DisplayMessage(new InformationMessage("Hello World!")); }, - false)); + () => { return (false, null); })); ``` 6. 编译你的项目并且确认输出到 `Modules\ExampleMod\bin\Win64_Shipping_Client` 下 @@ -103,4 +104,6 @@ 8. 在标题页面,你应该能看到一个按钮叫做 `消息` ,点击你应该能看到 `Hello World` 出现在屏幕左下角。 9. 现在你已经成功创建了第一个骑马与砍杀2:霸主的Mod! +## Module 模版 +如果你使用 Visual Studio 2019 或更高的版本,你也能使用 [Bannerlord Module Template](https://github.com/BUTR/Bannerlord.Module.Template) 去自动创建一个基础的 C\# Module!