taleworlds / documentations

Official repository for TaleWorlds Entertainment documentations.

Getting Started

Run server on Windows Locally

Execute run.bat, and access to http://localhost:4444 from your web browser.

Run server on Mac/Linux Locally

Install Hugo Then go to docs folder:

cd docs
hugo server -w --bind="0.0.0.0" -p=4444 --baseUrl="http://localhost:4444/" --ignoreCache --disableFastRender --forceSyncStatic --gc --verbose > log.txt 
# Or simply hugo server -D

Then access to http://localhost:4444 or http://localhost:1313 (By Default) from your web browser.

Contributing

We accept a lot of different contributions including, but not limit to 🪲 Issues, 🛠️ Pull Request, ❓ Support, 🌏 Localization.

To contribute:

• Create a personal fork of the project on Github.
• Clone the fork on your local machine.
• Add or change the documentation as needed.
• Commit your changes and Push your branch to your fork on Github.
• From your fork open a pull request.

Localization

Localization contributions are welcomed.
Copy and paste docs/content/english folder alongside english folder as docs/content/<LanguageName>.
Then add your language in config.toml using english as example.

[languages]
    [languages.en]
        contentDir = "content/english"
        languageName = "English"
    [languages.zh_cn]
        contentDir = "content/schinese"
        languageName = "简体中文"
    [languages.ru]
        contentDir = "content/russian"
        languageName = "Русский"

documentations's Issues

Website is down and images related to this repo are not loading

Website is down and images related to this repo are not loading

[Bug] Children Description in each index are not formatted in Zh_CN language.

Here is the link: http://docs.modding.bannerlord.com/zh_cn/playing-sounds/
http://docs.modding.bannerlord.com/zh_cn/asset-management/

The screenshot for the first one is:

Is there a way to write the each page's description directly? Now the description seems the be extracted from each page.

Where is the original page for generating_and_loading_ui_sprite_sheets?

I found that recently documentation added one page:
http://docs.modding.bannerlord.com/bestpractices/generating_and_loading_ui_sprite_sheets/

I want to make contribution with i18n since this page is very useful. But I did not found this page in this repo.

Add All-Contributor to this project

All Contributor is an App to recognize contributors to an open source project in a way that rewards each and every contribution, not just code.

Here is an example: https://github.com/all-contributors/all-contributors

And it is free to install this bot to public repo and here is the installation guide.

[Chore] Auto run hugo build when submitting a PR

We can add a github workflow to auto run hugo command when submitting a PR, which will make sure that all the merge commit will not break the master deploy session.

Document depends_flag_* tags

It seems like when a FlagCapturePoint is captured, entities tagged as dependends_flag_X will take the color of the flag. Coud you document that part and explain if any entities can be used?

What is RGL?

In a few docs such as path.md, it mentioned a term RGL.
It looks like the Ruby Graph Library or something.
Refer this: https://github.com/monora/rgl and https://r-forge.r-project.org/projects/rgl/

I think this is a library that is based on OpenGL and Bannerlord Engine used as one of the graph library. But I am not sure the exact the meaning for this.

doc wrong

this file : docs/content/english/Multiplayer/hosting_server.md
At there :"Your token has been generated and saved under your Documents\Mount & Blade II Bannerlord\Tokens folder:"
This floder is Wrong,the right floder is "Mount and Blade II Bannerlord"
I copy this floder and create to save Token doc When i read this tutorial.
This wrong took me a lot of time.

[Translation] Move current translated Chinese contents here

We have already translated several docs into Chinese here: https://yigu-studio.github.io/DocsModdingBannerlordCN/zh/

We will move to this repo shortly.

Disable AFK Kick Feature

Would be nice to have a serverside check to be able to disable the anti afk kick feature. This would be very helpful for servers running group fight or persistent empires servers since there can be reasons why a player is afk or standing still for a prolonged period of time and not be a detriment to the game. Very much appreciate this.

Asset browser shows assets 5256+2+56

What is the meaning for this 5256+2+56 in the page: http://docs.modding.bannerlord.com/asset-management/asset-browser/

[Discussion] Which code style we will choose?

I think we should introduce code highlight to prettify code blocks.

You can check support style here.

I provided two the most proper styles below I think:
Dracula: XML, C#

And
monokai: C#, XML

Add auto assign reviewer for PR.

We can add a workflow to auto add reviewers for our PR.

We can use this workflow auto-assign-action

Will start a PR soon. Currently we only set @OzgurEraslan as reviewer.

[Translation] Chinese Translation Progress

Documentation Sync Date

2021-04-05

Reviewer List

If you have any questions about translation, please reach out @WuZhuoran @Bisstocuz @Yuxuan1993 @Hallavan

Documentation List

Introduction

• Index by #10

Asset Management

• Index
• f.a.q. by #21
• quick-guide by #11

Asset Browser

• index
• Filter Queries by #22

Asset Types

• index
• Adding & Overriding Assets
• Animations
• Bodies by #27
• Entities & Prefabs by #42
• Materials
• Meshed by #42
• Naming Conventions @Yuxuan1993
• Overriding Scenes and Prefabs by #43
• Paths by #43
• Scripts
• Skeletions
• Textures by #43

Best Practice

• Scene Performance Guide
• Sealed Class Extension

Bannerlord Missions

• index
• what makes a village scene
• Mission Tactical Positions by #46
• Destructible Component @Oshibuki
• Scene Barrier Builder
• Scene Spawn Point Guide
• Script Component Callbacks by #45
• Spawn Point Debug Tool by #47

Editor

• index

Resource Editors

• index
• Material Editor
• Skeleton Editor
• Cloth Simulation
• Meta Mesh Editor by #49
• Model Viewer
• Texture Editor by #41

Scene Editor

• index
• nav_mesh
• Creating Entity @Hallavan
• Editor Shortcuts by #13
• Path Editing by #40
• Terrain Creation by #14
• Entity Inspector
• Navigation Mesh Inspector by #51
• Alignment and Snapping Tools @Hallavan
• Distance Tool by #38
• Mass Selection
• Precomputed Radiance Transfer - GI System
• Resizing Terrain by #32
• Scene Level System
• Terrain Mesh Blend System by #48

Playing Sounds

• index
• Adding Custom Sounds by #23

The guide to add banners to the game is not accurate

The section does not seem to work as of 1.7.2 as I have done everything according to the guide but I cannot for the life of me get the new folder to show up in the resource browser

Links in hosted documentation have wrong base URL

All the links within each page of the hosted documentation in http://docs.modding.bannerlord.com/ all have the base URL of http://localhost:4444 instead of http://docs.modding.bannerlord.com.

The navigation menu is correct.

Instruction to open the game console is not always correct

The instruction in the hosting custom server file to open the console may not be always correct. It seems to be only applicable to US keyboards or any keyboard layout that happens to have their tilde key to the left of digit 1.

Open the game console by pressing ALT + tilde key (~)

This instruction is not applicable to a UK layout keyboard, for example.

The instruction could be updated to explain that it is the top left key of a QWERTY layout keyboard (to the left of digit 1)
or the shortcut to open the console could be updated to be ALT + tilde key (~) across all keyboard layouts

Documentations/docs/content/english/Multiplayer/hosting_server.md

Line 18 in 136e5b7

Open the game console by pressing `ALT` + `tilde key (~)`:

[Bug] Gor Error 522 when visiting the website.

Will checkout later.

[Bug] Main Page Icon not showing on mobile device.

It makes mobile users very hard to click back to front page.

Suggest to make the Taleworlds icon at top-left corner clickable. the url is http://docs.modding.bannerlord.com/

Document AgentProximityMap

In cRPG, we use Mission.GetAgentsInRange extensively. It seems like if the radius is less than the proximity map max search radius it will use the AgentProximityMap. I'm wondering if mappers have to do anything to use that feature. Could you please document that part.

[Suggest] Add Crowdin to this project

Crowdin is one tool to get automated and continuous localization.

I think adding this app will help document translation.
In addition, choosing open source plan is free to use

[Docs] update README

It will be more helpful if README can contain more information for beginner.

I think a few things should be covered:

• How to run locally in both Windows and Mac/Linux.
• How to start contributing the repo.
• What is the license of the documentation here (Discussion Required).
• Contributor List.

[Translation] Russian Translation

Introduction

• Index #91

Asset Management

• FAQ #91
• Generating and Loading UI Sprite Sheets #91
• Horse Reins Simulation Creation #91
• How to Add Custom Fonts #91
• Creating a Module - Quick Guide #91
• Creating Custom Banner Icons & Colors #96

Asset Browser

• Filter Queries #91

Asset Types

• Animations
• Naming Conventions #91
• Bodies #91
• Materials #91
• Meshes #91
• Adding & Overriding Assets #91
• Overriding Scenes and Prefabs #91
• Paths #91
• Entities & Prefabs #91
• Scripts #91
• Skeletons #91
• Textures #91

Authoring Mission Scenes

• What Makes a Siege Scene #91
• Mission Tactical Positions #91
• What Makes a Village Scene
• What Makes a Hideout Scene #91

Script Components

• Destructible Component
• Script Component Callbacks #91
• Scene Barrier Builder #91
• Scene Spawn Point Guide
• Spawn Point Debug Tool

Best Practices

• Scene Performance Guide #91
• Sealed Class Extension #91
• XSLT Usage Tutorial #91

Editor

Resource Editors

• Cloth Simulation
• Material Editor #91
• Meta Mesh Editor #91
• Texture Editor #91
• Model Viewer #91
• Skeleton Editor #91

Scene Editor

• Alignment and Snapping Tools
• Creating Entity #91
• Distance Tool
• Editor Shortcuts
• Entity Inspector
• Scene Level System
• Mass Selection
• Navmesh
• Navigation Mesh Inspector
• Path Editing
• Precomputed Radiance Transfer - GI System
• Terrain Creation
• Terrain Mesh Blend System
• Resizing Terrain #91

Playing Sounds

• Adding Sounds to Your Module #91

Multiplayer

• Hosting a Custom Server
• Creating a Custom Game Mode
• What Make a Multiplayer Scene

Steam Workshop

• Uploading \ Updating a Mod

Doxygen API Documentation: XML Output

Would it be possible to enable XML output for the doxygen API documentation in addition to the current HTML: apidoc.bannerlord.com?
Preferably in a public directory so that people can parse the API docs programmatically and/or convert it to markdown.

[Bug] Language Option not showing in Mobile Device.

When using mobile device it will not show the language choice option.