diff --git a/docs/config.toml b/docs/config.toml index 524ef6d..90bc64f 100644 --- a/docs/config.toml +++ b/docs/config.toml @@ -2,7 +2,7 @@ baseUrl = "https://moddocs.bannerlord.com/" languageCode = "en-us" DefaultContentLanguage = "en" hasCJKLanguage = true -title = "Taleworlds Documentation" +title = "TaleWorlds Documentation" theme = "hugo-theme-docdock-master" pygmentsCodeFences = true pygmentsStyle = "monokailight" @@ -25,6 +25,9 @@ enableMissingTranslationPlaceholders = false # Add more languages here +[params] +description = "Official Mount & Blade II: Bannerlord modding documentation by TaleWorlds: modules, assets, editor, scenes, multiplayer and Steam Workshop." + [outputs] home = ["HTML", "RSS", "JSON"] diff --git a/docs/content/english/_index.md b/docs/content/english/_index.md index 61546c3..c52f249 100644 --- a/docs/content/english/_index.md +++ b/docs/content/english/_index.md @@ -1,22 +1,107 @@ +++ -title = "Live" -description = "" +title = "Home" +description = "Official Mount & Blade II: Bannerlord modding documentation by TaleWorlds. Guides for modules, assets, scenes, editor tools, audio, multiplayer, War Sails and the Steam Workshop." weight = 1 +++ -# Welcome to the Mount&Blade II: Bannerlord Modding Documentation -To access the API documentation: https://apidoc.bannerlord.com/. +# Mount & Blade II: Bannerlord Modding Documentation -To access the "Frequently Asked Questions" section, see [F.A.Q]({{< ref "faq.md" >}}). +Official guides from TaleWorlds for creating Bannerlord mods: modules, assets, scenes, editor tools, audio, multiplayer and naval content. For code reference, see the [API documentation](https://apidoc.bannerlord.com/). -For a quick guide on creating and registering modules, see [Modules-Quickguide]({{< ref "quickguide_create_a_mod.md" >}}). +## Getting Started -For further information: +New to Bannerlord modding? Follow these steps in order: -- [[Asset Management]]({{< ref "Asset Management" >}}) Creating & editing a module which can contain assets, scripts, scenes and gamelogic data which is either new or an override for an existing one in the base game. -- [[Bannerlord Missions]]({{< ref "Authoring Mission Scenes" >}}) Detail about how script components work, when does the callbacks get triggered and some specific script templates that Bannerlord use to create the gameplay experience. -- [[Best Practices]]({{< ref "BestPractices" >}}) Information about various topics and their best practices. -- [[Editor]]({{< ref "Editor" >}}) Information about how to use the scene and content editors with maximum efficency. -- [[Audio Modding]]({{< ref "Audio Modding" >}}) Adding sounds to your module using intended XMLs and code. -- [[Multiplayer]]({{< ref "Multiplayer" >}}) All about hosting a server, creating a custom game mode and making multiplayer scenes. -- [[Steam Workshop]]({{< ref "Steam Workshop" >}}) Details on how to upload your mod to the Steam Workshop. \ No newline at end of file +1. **[Creating a Module - Quick Guide]({{< ref "quickguide_create_a_mod.md" >}})**: create and register your first module. +2. **[Adding & Overriding Assets]({{< ref "overriding_assets.md" >}})**: add new assets or replace existing ones. +3. **[Merging Module XML Files with Native]({{< ref "merging_module_xml_files_with_native.md" >}})**: change game data without copying whole files. +4. **[Uploading/Updating a Mod]({{< ref "uploading_updating_mod.md" >}})**: publish your mod on the Steam Workshop. +5. **[Frequently Asked Questions]({{< ref "faq.md" >}})**: answers to common problems. + +## I Want To... + +{{< cards >}} +{{< card title="Build scenes & terrain" icon="fa-map" >}} +- [Terrain Creation]({{< ref "terrain_creation.md" >}}) +- [Navmesh]({{< ref "nav_mesh.md" >}}) +- [Editor Shortcuts]({{< ref "editor_shortcuts.md" >}}) +- [Scene Performance Guide]({{< ref "scene_performance_guide.md" >}}) +{{< /card >}} +{{< card title="Make mission scenes" icon="fa-chess-rook" >}} +- [Village Scenes]({{< ref "villages.md" >}}) +- [Siege Scenes]({{< ref "sieges.md" >}}) +- [Arena Scenes]({{< ref "arenas.md" >}}) +- [Hideout Scenes]({{< ref "hideouts.md" >}}) +{{< /card >}} +{{< card title="Add items & weapons" icon="fa-shield" >}} +- [Weapon Smithing & Crafting Pieces]({{< ref "weapon_smithing.md" >}}) +- [Meshes]({{< ref "meshes.md" >}}) +- [Materials]({{< ref "materials.md" >}}) +- [Textures]({{< ref "textures.md" >}}) +{{< /card >}} +{{< card title="Add sounds & music" icon="fa-music" >}} +- [Audio Modding with FMOD Studio]({{< ref "audio-modding-overview.md" >}}) +- [Event Setup]({{< ref "audio-modding-event-setup.md" >}}) +- [Scene Audio]({{< ref "audio-modding-scene-audio.md" >}}) +- [Audio Systems & Optimization]({{< ref "audio-modding-systems.md" >}}) +{{< /card >}} +{{< card title="Create ships & naval content" icon="fa-ship" >}} +- [Ship Creation]({{< ref "ship_creation.md" >}}) +- [Seaborne Raid Scenes]({{< ref "what_makes_seaborne_village_raid_scene.md" >}}) +- [War Sails World Map]({{< ref "wsworldmap.md" >}}) +{{< /card >}} +{{< card title="Make multiplayer content" icon="fa-users" >}} +- [Creating a Custom Game Mode]({{< ref "custom_game_mode.md" >}}) +- [Hosting a Custom Server]({{< ref "hosting_server.md" >}}) +- [Multiplayer Scenes]({{< ref "multiplayer_scenes.md" >}}) +{{< /card >}} +{{< card title="Change UI, fonts & banners" icon="fa-paint-brush" >}} +- [UI Sprite Sheets]({{< ref "generating_and_loading_ui_sprite_sheets.md" >}}) +- [Custom Fonts]({{< ref "how_to_add_custom_fonts.md" >}}) +- [Banner Icons & Colors]({{< ref "creating_custom_banner_icons.md" >}}) +{{< /card >}} +{{< card title="Write code" icon="fa-code" >}} +- [Scripts]({{< ref "scripts.md" >}}) +- [Script Component Callbacks]({{< ref "callbacks.md" >}}) +- [Sealed Class Extension]({{< ref "sealed_class_extension.md" >}}) +- [API Documentation](https://apidoc.bannerlord.com/) +{{< /card >}} +{{< /cards >}} + +## All Sections + +{{< cards >}} +{{< card title="Asset Management" icon="fa-cubes" link="asset-management/" >}} +Create modules and add or override assets: meshes, materials, textures, animations, prefabs and more. +{{< /card >}} +{{< card title="Bannerlord Missions" icon="fa-flag" link="authoring-mission-scenes/" >}} +What each mission scene needs, plus the script components and callbacks behind gameplay. +{{< /card >}} +{{< card title="Editor" icon="fa-pen-to-square" link="editor/" >}} +Use the Scene Editor and resource editors for terrain, navmeshes, materials, skeletons and cloth. +{{< /card >}} +{{< card title="Audio Modding" icon="fa-volume-up" link="audio-modding/" >}} +Add sounds and music with FMOD Studio, from event setup to scene audio and optimization. +{{< /card >}} +{{< card title="War Sails" icon="fa-anchor" link="war-sails/" >}} +Create ships, seaborne raid scenes and world map content for the War Sails expansion. +{{< /card >}} +{{< card title="Multiplayer" icon="fa-globe" link="multiplayer/" >}} +Host a server, create custom game modes and build multiplayer scenes. +{{< /card >}} +{{< card title="Best Practices" icon="fa-check-circle" link="bestpractices/" >}} +Recommended approaches for XML merging, XSLT, code extension and scene performance. +{{< /card >}} +{{< card title="Steam Workshop" icon="fa-brands fa-steam" link="steam-workshop/" >}} +Upload and update your mod on the Steam Workshop. +{{< /card >}} +{{< /cards >}} + +## Community & Resources + +- **[API Documentation](https://apidoc.bannerlord.com/)**: reference for the Bannerlord code base. +- **[Mount & Blade Modding Discord](https://discord.gg/ykFVJGQ)**: ask questions and talk with other modders. +- **[Bannerlord Documentation (community)](https://docs.bannerlordmodding.com/)**: community-written guides, including Gauntlet UI and packaging mods for Vortex. +- **[BannerlordModding.LT (community)](https://docs.bannerlordmodding.lt/)**: a community wiki of modding processes, techniques and tips. +- **[TaleWorlds Forums – The Smithy](https://forums.taleworlds.com/index.php?forums/the-smithy-mod-development.643/)**: the official mod development forum. +- **[Contribute on GitHub](https://github.com/TaleWorlds/Documentations)**: suggest fixes or new pages for this documentation. diff --git a/docs/content/russian/_index.md b/docs/content/russian/_index.md index f6d1ad4..d20873d 100644 --- a/docs/content/russian/_index.md +++ b/docs/content/russian/_index.md @@ -1,23 +1,107 @@ +++ -title = "Live" -description = "" +title = "Главная" +description = "Официальная документация TaleWorlds по моддингу Mount & Blade II: Bannerlord. Руководства по модулям, ассетам, сценам, редактору, звуку, мультиплееру, War Sails и Steam Workshop." weight = 1 +++ -# Добро пожаловать в документацию по моддиингу Mount&Blade II: Bannerlord +# Документация по моддингу Mount & Blade II: Bannerlord -To access the API documentation: https://apidoc.bannerlord.com/. +Официальные руководства TaleWorlds по созданию модов для Bannerlord: модули, ассеты, сцены, инструменты редактора, звук, мультиплеер и морской контент. Справочник по коду: [документация API](https://apidoc.bannerlord.com/). -Чтобы получить доступ к разделу «Часто задаваемые вопросы», см. [F.A.Q]({{< ref "faq.md" >}}). +## С чего начать -Краткое руководство по созданию и регистрации модулей см. [Краткое руководство по модулям]({{< ref "quickguide_create_a_mod.md" >}}). +Впервые занимаетесь моддингом Bannerlord? Пройдите эти шаги по порядку: -Дополнительная информация: +1. **[Создание модуля - Краткое руководство]({{< ref "quickguide_create_a_mod.md" >}})**: создайте и зарегистрируйте свой первый модуль. +2. **[Добавление и переопределение ассетов]({{< ref "overriding_assets.md" >}})**: добавляйте новые ассеты или заменяйте существующие. +3. **[Merging Module XML Files with Native]({{< ref "merging_module_xml_files_with_native.md" >}})**: изменяйте игровые данные, не копируя файлы целиком. +4. **[Uploading/Updating a Mod]({{< ref "uploading_updating_mod.md" >}})**: опубликуйте мод в Steam Workshop. +5. **[Часто задаваемые вопросы]({{< ref "faq.md" >}})**: ответы на частые проблемы. -- [[Управление ассетами]]({{< ref "Asset Management" >}}) Создание и редактирование модуля, который может содержать ресурсы, скрипты, сцены и данные игровой логики, являются либо новыми, либо заменяют уже существующие в базовой игре. -- [[Миссии]]({{< ref "Authoring Mission Scenes" >}}) Подробная информация о том, как работают компоненты сценариев, когда срабатывают обратные вызовы, и о некоторых конкретных шаблонах сценариев, которые Bannerlord использует для создания игрового процесса. -- [[Best Practices]]({{< ref "BestPractices" >}}) Information about various topics and their best practices. -- [[Редактор]]({{< ref "Editor" >}}) Информация о том, как максимально эффективно использовать редакторы сцен и контента. -- [[Audio Modding]]({{< ref "Audio Modding" >}}) Adding sounds to your module using intended XMLs and code. -- [[Multiplayer]]({{< ref "Multiplayer" >}}) All about hosting a server, creating a custom game mode and making multiplayer scenes. -- [[Steam Workshop]]({{< ref "Steam Workshop" >}}) Details on how to upload your mod to the Steam Workshop. \ No newline at end of file +## Я хочу... + +{{< cards >}} +{{< card title="Создавать сцены и ландшафт" icon="fa-map" >}} +- [Terrain Creation]({{< ref "terrain_creation.md" >}}) +- [Navmesh]({{< ref "nav_mesh.md" >}}) +- [Editor Shortcuts]({{< ref "editor_shortcuts.md" >}}) +- [Руководство по производительности сцены]({{< ref "scene_performance_guide.md" >}}) +{{< /card >}} +{{< card title="Создавать сцены миссий" icon="fa-chess-rook" >}} +- [Сцены деревень]({{< ref "villages.md" >}}) +- [Сцены осады]({{< ref "sieges.md" >}}) +- [Сцены арены]({{< ref "arenas.md" >}}) +- [Сцены укрытий]({{< ref "hideouts.md" >}}) +{{< /card >}} +{{< card title="Добавлять предметы и оружие" icon="fa-shield" >}} +- [Weapon Smithing & Crafting Pieces]({{< ref "weapon_smithing.md" >}}) +- [Сетки]({{< ref "meshes.md" >}}) +- [Материалы]({{< ref "materials.md" >}}) +- [Текстуры]({{< ref "textures.md" >}}) +{{< /card >}} +{{< card title="Добавлять звуки и музыку" icon="fa-music" >}} +- [Audio Modding with FMOD Studio]({{< ref "audio-modding-overview.md" >}}) +- [Event Setup]({{< ref "audio-modding-event-setup.md" >}}) +- [Scene Audio]({{< ref "audio-modding-scene-audio.md" >}}) +- [Audio Systems & Optimization]({{< ref "audio-modding-systems.md" >}}) +{{< /card >}} +{{< card title="Создавать корабли и морской контент" icon="fa-ship" >}} +- [Ship Creation]({{< ref "ship_creation.md" >}}) +- [Seaborne Raid Scenes]({{< ref "what_makes_seaborne_village_raid_scene.md" >}}) +- [War Sails World Map]({{< ref "wsworldmap.md" >}}) +{{< /card >}} +{{< card title="Создавать контент для мультиплеера" icon="fa-users" >}} +- [Creating a Custom Game Mode]({{< ref "custom_game_mode.md" >}}) +- [Hosting a Custom Server]({{< ref "hosting_server.md" >}}) +- [Multiplayer Scenes]({{< ref "multiplayer_scenes.md" >}}) +{{< /card >}} +{{< card title="Изменять интерфейс, шрифты и баннеры" icon="fa-paint-brush" >}} +- [UI таблицы спрайтов]({{< ref "generating_and_loading_ui_sprite_sheets.md" >}}) +- [Собственные шрифты]({{< ref "how_to_add_custom_fonts.md" >}}) +- [Значки и цвета баннеров]({{< ref "creating_custom_banner_icons.md" >}}) +{{< /card >}} +{{< card title="Писать код" icon="fa-code" >}} +- [Скрипты]({{< ref "scripts.md" >}}) +- [Обратные вызовы компонентов сценария]({{< ref "callbacks.md" >}}) +- [Расширение запечатанных классов]({{< ref "sealed_class_extension.md" >}}) +- [Документация API](https://apidoc.bannerlord.com/) +{{< /card >}} +{{< /cards >}} + +## Все разделы + +{{< cards >}} +{{< card title="Управление ассетами" icon="fa-cubes" link="asset-management/" >}} +Создание модулей, добавление и переопределение ассетов: сетки, материалы, текстуры, анимации, префабы и многое другое. +{{< /card >}} +{{< card title="Миссии Bannerlord" icon="fa-flag" link="authoring-mission-scenes/" >}} +Что нужно каждой сцене миссии, а также компоненты сценариев и обратные вызовы, на которых построен геймплей. +{{< /card >}} +{{< card title="Редактор" icon="fa-pen-to-square" link="editor/" >}} +Редактор сцен и редакторы ресурсов: ландшафт, навмеши, материалы, скелеты и ткань. +{{< /card >}} +{{< card title="Audio Modding" icon="fa-volume-up" link="audio-modding/" >}} +Добавление звуков и музыки с помощью FMOD Studio: от настройки событий до звука сцен и оптимизации. +{{< /card >}} +{{< card title="War Sails" icon="fa-anchor" link="war-sails/" >}} +Создание кораблей, сцен морских набегов и контента карты мира для дополнения War Sails. +{{< /card >}} +{{< card title="Multiplayer" icon="fa-globe" link="multiplayer/" >}} +Запуск сервера, создание собственных режимов игры и сцен для мультиплеера. +{{< /card >}} +{{< card title="Лучшие практики" icon="fa-check-circle" link="bestpractices/" >}} +Рекомендуемые подходы к слиянию XML, XSLT, расширению кода и производительности сцен. +{{< /card >}} +{{< card title="Steam Workshop" icon="fa-brands fa-steam" link="steam-workshop/" >}} +Загрузка и обновление мода в Steam Workshop. +{{< /card >}} +{{< /cards >}} + +## Сообщество и ресурсы + +- **[Документация API](https://apidoc.bannerlord.com/)**: справочник по коду Bannerlord. +- **[Discord сообщества моддинга Mount & Blade](https://discord.gg/ykFVJGQ)**: задавайте вопросы и общайтесь с другими моддерами. +- **[Bannerlord Documentation (сообщество)](https://docs.bannerlordmodding.com/)**: руководства от сообщества, включая Gauntlet UI и упаковку модов для Vortex. +- **[BannerlordModding.LT (сообщество)](https://docs.bannerlordmodding.lt/)**: вики сообщества о процессах, техниках и советах по моддингу. +- **[Форумы TaleWorlds – The Smithy](https://forums.taleworlds.com/index.php?forums/the-smithy-mod-development.643/)**: официальный форум разработки модов. +- **[Участие на GitHub](https://github.com/TaleWorlds/Documentations)**: предлагайте исправления или новые страницы для этой документации. diff --git a/docs/content/schinese/_index.md b/docs/content/schinese/_index.md index 73c3ec7..94ba890 100644 --- a/docs/content/schinese/_index.md +++ b/docs/content/schinese/_index.md @@ -1,24 +1,107 @@ +++ -title = "Live" -description = "" +title = "首页" +description = "TaleWorlds 官方《骑马与砍杀2：霸主》Mod 制作文档。涵盖模块、资产、场景、编辑器、音频、多人游戏、War Sails 和 Steam 创意工坊的指南。" weight = 1 +++ -# 欢迎来到《骑马与砍杀2：霸主》 Mod 开发文档 +# 《骑马与砍杀2：霸主》Mod 制作文档 -查看 API 文档：https://apidoc.bannerlord.com/。 +TaleWorlds 官方的《霸主》Mod 制作指南：模块、资产、场景、编辑器工具、音频、多人游戏和海战内容。代码参考请查看 [API 文档](https://apidoc.bannerlord.com/)。 -获取更多“常见问题解答”，请访问 [常见问题解答]({{< ref "faq.md" >}})。 +## 快速开始 -想要快速创建并且注册一个游戏 Mod 请访问 [快速入门指南]({{< ref "quickguide_create_a_mod.md" >}})。 +第一次制作《霸主》Mod？请按顺序完成以下步骤： -更多信息请参阅： +1. **[创建一个Mod - 快速入门]({{< ref "quickguide_create_a_mod.md" >}})**：创建并注册你的第一个模块。 +2. **[添加与覆盖资产]({{< ref "overriding_assets.md" >}})**：添加新资产或替换现有资产。 +3. **[Merging Module XML Files with Native]({{< ref "merging_module_xml_files_with_native.md" >}})**：无需复制整个文件即可修改游戏数据。 +4. **[上传/更新一个模组]({{< ref "uploading_updating_mod.md" >}})**：将你的 Mod 发布到 Steam 创意工坊。 +5. **[常见问题解答]({{< ref "faq.md" >}})**：常见问题的解答。 -- [[资产管理]]({{< ref "Asset Management" >}}) 创建/编辑一个包含资产 (Assets)、脚本、场景以及游戏逻辑数据的模组，这些可以是新建的数据，也可以用于覆盖游戏内已经存在的数据。 -- [[霸主任务系统]]({{< ref "Authoring Mission Scenes" >}}) 详细介绍游戏脚本组件的工作原理，何时能触发回调，以及骑砍2：霸主中用来建立游戏流程（体验）的特定脚本模板。 -- [[最佳实践]]({{< ref "BestPractices" >}}) 各种热门话题及其最佳实践的相关信息。 -- [[编辑器]]({{< ref "Editor" >}}) 关于编辑器的信息，引导玩家如何能最有效地使用编辑器编辑场景和内容。 -- [[Audio Modding]]({{< ref "Audio Modding" >}}) 用XMLs和代码来给你的Mod添加音乐。 -- [[多人游戏]]({{< ref "Multiplayer" >}}) 所有关于搭建服务器、创建自定义游戏模式和制作多人游戏场景的内容都在这里。 -- [[Steam 创意工坊]]({{< ref "Steam Workshop" >}}) 关于如何将你的模组上传到 Steam 创意工坊的详细信息。 +## 我想要…… +{{< cards >}} +{{< card title="制作场景和地形" icon="fa-map" >}} +- [地形创建]({{< ref "terrain_creation.md" >}}) +- [导航网格]({{< ref "nav_mesh.md" >}}) +- [编辑器快捷键]({{< ref "editor_shortcuts.md" >}}) +- [Scene Performance Guide]({{< ref "scene_performance_guide.md" >}}) +{{< /card >}} +{{< card title="制作任务场景" icon="fa-chess-rook" >}} +- [村庄场景]({{< ref "villages.md" >}}) +- [攻城战场景]({{< ref "sieges.md" >}}) +- [竞技场场景]({{< ref "arenas.md" >}}) +- [藏身处场景]({{< ref "hideouts.md" >}}) +{{< /card >}} +{{< card title="添加物品和武器" icon="fa-shield" >}} +- [Weapon Smithing & Crafting Pieces]({{< ref "weapon_smithing.md" >}}) +- [网格]({{< ref "meshes.md" >}}) +- [材质]({{< ref "materials.md" >}}) +- [纹理]({{< ref "textures.md" >}}) +{{< /card >}} +{{< card title="添加音效和音乐" icon="fa-music" >}} +- [Audio Modding with FMOD Studio]({{< ref "audio-modding-overview.md" >}}) +- [Event Setup]({{< ref "audio-modding-event-setup.md" >}}) +- [Scene Audio]({{< ref "audio-modding-scene-audio.md" >}}) +- [Audio Systems & Optimization]({{< ref "audio-modding-systems.md" >}}) +{{< /card >}} +{{< card title="制作船只和海战内容" icon="fa-ship" >}} +- [Ship Creation]({{< ref "ship_creation.md" >}}) +- [Seaborne Raid Scenes]({{< ref "what_makes_seaborne_village_raid_scene.md" >}}) +- [War Sails World Map]({{< ref "wsworldmap.md" >}}) +{{< /card >}} +{{< card title="制作多人游戏内容" icon="fa-users" >}} +- [创建自定义游戏模式]({{< ref "custom_game_mode.md" >}}) +- [Hosting a Custom Server]({{< ref "hosting_server.md" >}}) +- [多人游戏场景的构造]({{< ref "multiplayer_scenes.md" >}}) +{{< /card >}} +{{< card title="修改界面、字体和旗帜" icon="fa-paint-brush" >}} +- [UI 精灵图集]({{< ref "generating_and_loading_ui_sprite_sheets.md" >}}) +- [如何添加自定义字体]({{< ref "how_to_add_custom_fonts.md" >}}) +- [旗帜图标和颜色]({{< ref "creating_custom_banner_icons.md" >}}) +{{< /card >}} +{{< card title="编写代码" icon="fa-code" >}} +- [脚本]({{< ref "scripts.md" >}}) +- [脚本组件回调函数]({{< ref "callbacks.md" >}}) +- [Sealed Class Extension]({{< ref "sealed_class_extension.md" >}}) +- [API 文档](https://apidoc.bannerlord.com/) +{{< /card >}} +{{< /cards >}} + +## 所有章节 + +{{< cards >}} +{{< card title="资产管理" icon="fa-cubes" link="asset-management/" >}} +创建模块，添加或覆盖资产：网格、材质、纹理、动画、预制件等。 +{{< /card >}} +{{< card title="编辑任务场景" icon="fa-flag" link="authoring-mission-scenes/" >}} +各类任务场景的要求，以及驱动游戏玩法的脚本组件和回调函数。 +{{< /card >}} +{{< card title="编辑器" icon="fa-pen-to-square" link="editor/" >}} +使用场景编辑器和资源编辑器处理地形、导航网格、材质、骨骼和布料。 +{{< /card >}} +{{< card title="Audio Modding" icon="fa-volume-up" link="audio-modding/" >}} +使用 FMOD Studio 添加音效和音乐，从事件设置到场景音频和优化。 +{{< /card >}} +{{< card title="War Sails" icon="fa-anchor" link="war-sails/" >}} +为 War Sails 资料片制作船只、海上劫掠场景和世界地图内容。 +{{< /card >}} +{{< card title="多人游戏" icon="fa-globe" link="multiplayer/" >}} +架设服务器、创建自定义游戏模式和制作多人游戏场景。 +{{< /card >}} +{{< card title="最佳实践范例" icon="fa-check-circle" link="bestpractices/" >}} +XML 合并、XSLT、代码扩展和场景性能的推荐做法。 +{{< /card >}} +{{< card title="Steam 创意工坊" icon="fa-brands fa-steam" link="steam-workshop/" >}} +在 Steam 创意工坊上传和更新你的 Mod。 +{{< /card >}} +{{< /cards >}} + +## 社区与资源 + +- **[API 文档](https://apidoc.bannerlord.com/)**：《霸主》代码参考。 +- **[骑马与砍杀 Mod 制作 Discord](https://discord.gg/ykFVJGQ)**：提问并与其他 Mod 作者交流。 +- **[Bannerlord Documentation（社区）](https://docs.bannerlordmodding.com/)**：社区编写的指南，包括 Gauntlet UI 和为 Vortex 打包 Mod。 +- **[BannerlordModding.LT（社区）](https://docs.bannerlordmodding.lt/)**：记录 Mod 制作流程、技巧和经验的社区百科。 +- **[TaleWorlds 论坛 – The Smithy](https://forums.taleworlds.com/index.php?forums/the-smithy-mod-development.643/)**：官方 Mod 开发论坛。 +- **[在 GitHub 上贡献](https://github.com/TaleWorlds/Documentations)**：为本文档提出修改建议或新页面。 diff --git a/docs/layouts/_default/baseof.html b/docs/layouts/_default/baseof.html new file mode 100644 index 0000000..6aaf053 --- /dev/null +++ b/docs/layouts/_default/baseof.html @@ -0,0 +1,31 @@ + + + + {{if .Site.Params.themeStyle}} + {{ partial (printf "%s/head.html" .Site.Params.themeStyle) . }} + {{else}} + {{ partial "flex/head.html" . }} + {{end}} + + + {{if .Site.Params.themeStyle}} + {{ partial (printf "%s/body-beforecontent.html" .Site.Params.themeStyle) . }} + {{else}} + {{ partial "flex/body-beforecontent.html" . }} + {{end}} + + {{ block "main" . }} + {{ end }} + + {{if .Site.Params.themeStyle}} + {{ partial (printf "%s/body-aftercontent.html" .Site.Params.themeStyle) . }} + {{else}} + {{ partial "flex/body-aftercontent.html" . }} + {{ end }} + + {{ block "footer" . }} + {{ end }} + + {{ partial "custom-footer.html" . }} + + \ No newline at end of file diff --git a/docs/layouts/partials/custom-footer.html b/docs/layouts/partials/custom-footer.html index 6938c7a..047cc84 100644 --- a/docs/layouts/partials/custom-footer.html +++ b/docs/layouts/partials/custom-footer.html @@ -1,5 +1,5 @@
\ No newline at end of file diff --git a/docs/layouts/partials/custom-head.html b/docs/layouts/partials/custom-head.html new file mode 100644 index 0000000..4d9c249 --- /dev/null +++ b/docs/layouts/partials/custom-head.html @@ -0,0 +1,16 @@ +{{- $desc := .Site.Params.description -}} +{{- with .Summary }}{{ $desc = . | plainify | htmlUnescape | replaceRE "\\s+" " " | replaceRE "[\"“”«»]" "'" | truncate 160 }}{{ end -}} +{{- with .Description }}{{ $desc = . }}{{ end -}} + +{{- if .IsHome }} + +{{- end }} diff --git a/docs/layouts/partials/flex/head.html b/docs/layouts/partials/flex/head.html new file mode 100644 index 0000000..30cd8c4 --- /dev/null +++ b/docs/layouts/partials/flex/head.html @@ -0,0 +1,19 @@ + + + +{{ if .IsHome }}{{ .Site.Title }}{{ else }}{{ .Title }} :: {{ .Site.Title }}{{ end }} + + + + + + +{{with .Site.Params.themeVariant}} + +{{end}} + + + +{{ partial "custom-head.html" . }} diff --git a/docs/layouts/shortcodes/card.html b/docs/layouts/shortcodes/card.html new file mode 100644 index 0000000..ee8949e --- /dev/null +++ b/docs/layouts/shortcodes/card.html @@ -0,0 +1,12 @@ +{{- $title := .Get "title" -}} +{{- $icon := .Get "icon" -}} +{{- $link := .Get "link" -}} +
+

+ {{- with $icon }} {{ end -}} + {{- if $link }}{{ $title }}{{ else }}{{ $title }}{{ end -}} +

+
+{{ .Inner | markdownify }} +
+
diff --git a/docs/layouts/shortcodes/cards.html b/docs/layouts/shortcodes/cards.html new file mode 100644 index 0000000..ee96fdc --- /dev/null +++ b/docs/layouts/shortcodes/cards.html @@ -0,0 +1,3 @@ +
+{{ .Inner }} +
diff --git a/docs/static/robots.txt b/docs/static/robots.txt new file mode 100644 index 0000000..37873d9 --- /dev/null +++ b/docs/static/robots.txt @@ -0,0 +1,4 @@ +User-agent: * +Allow: / + +Sitemap: https://moddocs.bannerlord.com/sitemap.xml