Skip to content
Mart Kartasev edited this page Aug 8, 2021 · 24 revisions

Welcome to the The Old World Wiki.

This will be the storage for all of our code related knowledge that we have accumulated during research and experimentation. The primary purpose is to record information learned about the operating principles of the scripts in Bannerlord, common pitfalls as well as provide architectural or design overviews of patterns used in our own project.

  1. How to edit
  2. Naming
  3. Adding pages

How to edit

The suggested way is to clone the wiki using:

git clone https://github.com/WarhammerTheOldWorld/TOW_Core.wiki.git

Or the SSH equivalent:

git clone git@github.com:WarhammerTheOldWorld/TOW_Core.wiki

This will allow you to edit multiple pages in a single commit, meaning less revisions in total. Smaller modifications can still be done from the GitHub web ui.

Please refer to the Markdown Cheatsheet for hints on how to edit this wiki and format your pages.

Formatting rules

Keep sections separated with 3 newlines in markup format. This is not necessary for subsections.

Every sentence can be formatted onto a separate line in the markup file. This help keep the text readable in pre-processed format on most screens. Sections can be created by separating with 1 newline.

Naming

WIP. Please make more suggestions.

Page names should consist of two parts: category and name. This will make the resulting links predictable and easier to manage.

The category should refer to the general technical topic for a group of items. For example "AI".

The name should refer to whatever is the primary object of discussion on the page in question. For example "MobileParty".

The resulting page name would be "AI MobileParty".

Adding pages

For adding new pages please follow the suggested order of operations:

  1. Edit the Sidebar
  2. Add the page under the appropriate category by using the format

[Name here](https://github.com/WarhammerTheOldWorld/TOW_Core/wiki/Category-Name

  1. Finish editing. Make sure that the link was formatted correctly.
  2. Fill out the page in question

This will assure that you always create pages that are linked to the sidebar. If you rename the page after creation, please edit the link as page links are associated to page names.