Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion docs/config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand All @@ -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"]

Expand Down
113 changes: 99 additions & 14 deletions docs/content/english/_index.md
Original file line number Diff line number Diff line change
@@ -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: <a href="https://apidoc.bannerlord.com/">https://apidoc.bannerlord.com/</a>.
# Mount & Blade II: Bannerlord Modding Documentation

To access the "Frequently Asked Questions" section, see <strong>[F.A.Q]({{< ref "faq.md" >}})</strong>.
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 <strong>[Modules-Quickguide]({{< ref "quickguide_create_a_mod.md" >}})</strong>.
## Getting Started

For further information:
New to Bannerlord modding? Follow these steps in order:

- <strong>[[Asset Management]]({{< ref "Asset Management" >}})</strong> 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.
- <strong>[[Bannerlord Missions]]({{< ref "Authoring Mission Scenes" >}})</strong> 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.
- <strong>[[Best Practices]]({{< ref "BestPractices" >}})</strong> Information about various topics and their best practices.
- <strong>[[Editor]]({{< ref "Editor" >}})</strong> Information about how to use the scene and content editors with maximum efficency.
- <strong>[[Audio Modding]]({{< ref "Audio Modding" >}})</strong> Adding sounds to your module using intended XMLs and code.
- <strong>[[Multiplayer]]({{< ref "Multiplayer" >}})</strong> All about hosting a server, creating a custom game mode and making multiplayer scenes.
- <strong>[[Steam Workshop]]({{< ref "Steam Workshop" >}})</strong> Details on how to upload your mod to the Steam Workshop.
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.
112 changes: 98 additions & 14 deletions docs/content/russian/_index.md
Original file line number Diff line number Diff line change
@@ -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: <a href="https://apidoc.bannerlord.com/">https://apidoc.bannerlord.com/</a>.
Официальные руководства TaleWorlds по созданию модов для Bannerlord: модули, ассеты, сцены, инструменты редактора, звук, мультиплеер и морской контент. Справочник по коду: [документация API](https://apidoc.bannerlord.com/).

Чтобы получить доступ к разделу «Часто задаваемые вопросы», см. <strong>[F.A.Q]({{< ref "faq.md" >}})</strong>.
## С чего начать

Краткое руководство по созданию и регистрации модулей см. <strong>[Краткое руководство по модулям]({{< ref "quickguide_create_a_mod.md" >}})</strong>.
Впервые занимаетесь моддингом 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" >}})**: ответы на частые проблемы.

- <strong>[[Управление ассетами]]({{< ref "Asset Management" >}})</strong> Создание и редактирование модуля, который может содержать ресурсы, скрипты, сцены и данные игровой логики, являются либо новыми, либо заменяют уже существующие в базовой игре.
- <strong>[[Миссии]]({{< ref "Authoring Mission Scenes" >}})</strong> Подробная информация о том, как работают компоненты сценариев, когда срабатывают обратные вызовы, и о некоторых конкретных шаблонах сценариев, которые Bannerlord использует для создания игрового процесса.
- <strong>[[Best Practices]]({{< ref "BestPractices" >}})</strong> Information about various topics and their best practices.
- <strong>[[Редактор]]({{< ref "Editor" >}})</strong> Информация о том, как максимально эффективно использовать редакторы сцен и контента.
- <strong>[[Audio Modding]]({{< ref "Audio Modding" >}})</strong> Adding sounds to your module using intended XMLs and code.
- <strong>[[Multiplayer]]({{< ref "Multiplayer" >}})</strong> All about hosting a server, creating a custom game mode and making multiplayer scenes.
- <strong>[[Steam Workshop]]({{< ref "Steam Workshop" >}})</strong> Details on how to upload your mod to the Steam Workshop.
## Я хочу...

{{< 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)**: предлагайте исправления или новые страницы для этой документации.
Loading
Loading