Modding Guide M&B Warband file

Base for a new modding guide for Mount&Blade Warband. Be aware, it's work in progress and there is still a lot which needs to find its place inside there. See also the forum thread for the Modding Guide:

Forums.taleworlds.com

Table of Contents

1. Introduction
2. Localization and Modularity
3. Setting up the Module System
4. Module Syntax and Usage
5. Documenation Module System
6. Documentation module.ini
7. Game Engine Settings, Formulas and Info Tidbits
8. Most Common Errors at Modding
9. Good Practice (not started yet)
10. In-game Editor (not started yet)
11. Frequently Asked Questions (started)
12. BRF-related Informations (not started yet)

Edit Log 21.08.2022

html update: The pdf version won't be updated any longer. The work has been ported to html, to make it easier and better accessible.

Download the html version at this place:
Gitlab.com

Edit Log 29.12.2021

The following subchapters have been finished:
- 'Can-fail (cf_x) Scripts'
- 'Optimal Music File Format'
- 'Optimal Sound File Format'
- 'Skin/Gender/Race-based Voice Entries'
- 'Sound Flags'
- 'Animation Sounds'
- 'Variations for Animations'
- 'Ragdolls'
- 'Module Map Icons'
- 'Creating a New Party Template'

Added introduction to chapter 'Module Sounds'
Added passage at 'Other Tidbits'
More detailed description at itp_covers_legs, cheers to dstn and Somebody!
Added remark to shoot_speed and some other little work at item stats descriptions.
Added description to arf_make_custom_sounds.
Improved module.ini descriptions of enable_quick_battles, show_multiplayer_gold, disable_attack_while_jumping and can_reload_while_moving
Integrated some infobit at 'Remarkable Notes'
Added notes about Decompilers
Little work at chapter 'Module Mission Templates'
Little corrections and additions

Edit Log 18.09.2021

Started the chapters "Module Simple Triggers", "Module Triggers" and "Vertex Animations".
Finished the chapters "Skin/Race-specific Animations", "Item Types/Classes", "Item Damage Types", "Item Modifiers", "Usage of ixmesh", "Item Extra Description", "Item Triggers", "Books".
Replaced German quotation mark with english one.
Little corrections and addons.

Edit Log 06.09.2021

Added intro to chapter Module Animations
Added descriptions to all known animation flags
Finished most parts at the subchapters "Animations and Item Types" and  "Animations and Item Capability Flags"
Added subchapter "Multi-meshing"
Finished "Item Capabilities"
Some work at "Item Properties"
Little Addon to possible effect when hidding hardcoded skills
Finished subsection "Troop Tree"
Little corrections and added passage

Edit Log 15.08.2021

Module Music is now nearly complete

Completed subchapters "Troop Image"

Reorganised chapter "BRF Resource Management", structuring and sorting it into subchapters.

Minor changes and corrections

Edit Log 05.06.2021

Minor update

New Chapter Structure at Module System Documentation, cheers to Swyter for the idea.
Finished subsubsection "Culture Flags"
Finished subsubsection "Tips for Music Designers"
Added intro description at module game menus, added menu flags with descriptions
Added intro description at chapter module presentations and opened up two subchapters at it

Added Intro description module meshes
Minor corrections

Edit Log 16.05.2021

Organisation update

Created Milestones and associated Issues for better overview about what still needs to be done
Sorted notes and commets to subsubchapters
Started some work at subchapters for module_music/sounds/animations.py
Improved Subchapter Structure at Game Engine Chapter, still needs better structure at latter parts
Little corrections

Edit Log 25.04.2021

Module Syntax and Usage

• new subsubchapter "Loop Extension" and little additions

Documentation Module System

• module_factions: new subsubchapters "Difference between Faction and Culture", "Changing Faction Relations", "Differentiating between Player's Faction and Player Supporters' Faction" and "Maximum Amount of Factions"
• module_skills: new subchapters "Maximum Skill Level" and "Adding, Combining, Deleting and/or Editing Skills"
• module_skins: added chapter intro; new subchapters "Adding a new Skin", "Skin Flag and Morph Key", "Face Keys Code", "Scaling Problems" and "Skins for Horses"
• module_troops: new subchapters "Scene Entry Point", "Random Attribute and Skill Points" and "Differences between Classes, Subclasses and Divisions"
• module_items: new subchapters "Maximum Weapon Damage", "Equipment Slots", "Damage Types", "Maximum Inventory Items" and "Morale Effect of Food"
• module_scene_props: new subchapter "Scene Prop Meta Types, Sub Kind ID and Variation IDs"
• module_scenes: new subchapter "Character Creation Screen aka Meeting Scene"
• module_parties: new subchapters "Maximum Number of Stacks", "Experience Constants" and "Fiefs' Association with each other"
• module_strings: new subchapters "Gender-based Alternation", "Strings and Syntax" and "Difference between Strings and Quick Strings"
• module_quests: new subchapter "Bare-bones for New Quests"
• module_dialogs: added chapter intro; new subchapters "Requirements and the Condition Block" and "Declarations for Dialogs"
• module_mission_template: new subchapters "Spawn Records" and "Jumping from Mission Template to Mission Template"
• At nearly each chapter little additions and unstructured notes for later integration

Documentation module.ini Expanded some descriptions

New chapter "Game Engine Settings, Formulas and Info Tidbits" with all its subchapters

Other

• Updated credit list
• Little corrections and expansions
• Little changes at format
• A lot of unstructured notes for later integration, sorry for the mess
• Uploaded other pictures to be available later for other authors

Edit Log 24.01.2021

• Added passage 'Using Modifiers for Item Variants'
• Added passage about timid and meek horse modifiers
• Added subsection 'Basic Colour Codes' to FAQ section
• Added Subsection Module Strings, by jik
• Added Subsection Module Quests, by jik
• Added Subsection Module Mission Template, by jik
• Started subsection Module Particle Systems
• Moved up section about module.ini and renamed it as well as section Documentation
• Added remark of Somebody at fall damage
• Little corrections and additions