Skip to content

Latest commit

 

History

History
121 lines (101 loc) · 7.03 KB

File metadata and controls

121 lines (101 loc) · 7.03 KB

[b][size=6]Yet Another Party Organiser (YAPO)[/size][/b]

[i][color=#ffd966][size=5]Another party organisation mod to add to your ever expanding collection![/size] [/color][/i] [size=3][b][color=#ff0000]IMPORTANT[/color][/b] If you used a version prior to 1.5.0, [i]ModLib[/i] is no longer a dependency. Make sure you delete the YAPO module folder before installing the new version.[/size]

[size=3][b][color=#ff0000]IMPORTANT[/color][/b] If you used a version prior to 1.5.0, there are new dependencies. See [i]Dependencies[/i] below.[/size]


Please post any issues and feature requests to the mod github [url=https://github.com/tbeswick96/BannerlordYetAnotherPartyOrganiser]https://github.com/tbeswick96/BannerlordYetAnotherPartyOrganiser[/url]

[b][size=4]Dependencies[/size][/b]

The following mods are required for this mod to work. Make sure they are enabled and listed above this mod within the launcher for it to function correctly.

[url=https://www.nexusmods.com/mountandblade2bannerlord/mods/2006]Harmony[/url] | [b]Required[/b] | [b]Load first[/b] [url=https://www.nexusmods.com/mountandblade2bannerlord/mods/2018]Butterlib[/url] | [b]Required[/b] | [b]Load second[/b] [url=https://www.nexusmods.com/mountandblade2bannerlord/mods/2102]UIExtender[/url] | [b]Required[/b] | [b]Load third[/b] [url=https://www.nexusmods.com/mountandblade2bannerlord/mods/612]MCMv4 (Beta)[/url] | [b]Required[/b] | [b]Load fourth. Load before Native[/b]

Make sure that the dependent mods are enabled and listed above this mod within the launcher.


[b][size=5]Features[/size][/b]

[size=5]Sorting[/size] [size=3] [/size][list] [][size=3]Separate Main Party and Other Party sorting[/size] [][size=3]Sorting modes:[/size] [list] [][size=3]Alphabetical (Name)[/size] [][size=3]Type (Infantry, Ranged, Cavalry, Ranged Cavalry)[/size] [][size=3]Group (Formation group)[/size] [][size=3]Tier[/size] [][size=3]Culture[/size] [][size=3]Count[/size] [/list][][size=3]Two sorting modes can be selected through two drop downs[/size][list] [][size=3]Sorting is treated as Sort By -> Then By[/size] [][size=3]Button to set opposite sorting direction between the Sort By -> Then By Modes, to allow more granular sorting rules[/size] [/list] [/list][][size=3]Customisable sorting rules[/size][list] [][size=3]Type sorting mode can be customised for each party and for each sort step. Select Type and press the * next to the dropdown[/size] [/list] [][size=3]Button to place upgradable troops at the top of the list[/size] [][size=3]Buttons will disable themselves if functionality is not available (e.g. cannot set opposite sorting if no Then By mode is selected)[/size] [][size=3]Sorting configuration is saved to a JSON file in your configs directory[/size] [/list] [size=5]Party Actions[/size]

[list] [][size=3]Upgrade all single-path and most multi-path upgradable troops based on the culture's strength[/size] [][size=3]Recruit recruitable prisoners - sort order is respected, party limit is respected but can be overridden by holding CTRL[/size] [*][size=3]Buttons will disable themselves if functionality is not available (e.g. no troops to upgrade)[/size] [/list] [size=5]Hotkeys[/size]

[list] [][size=3][b]LCTRL + LSHIFT + A[/b] - Sort Ascending (Both Sides)[/size] [][size=3][b]LCTRL + LSHIFT + D[/b] - Sort Descending (Both Sides)[/size] [][size=3][b]LCTRL + {Move troops arrow}[/b] - Moves entire stack of troops[/size] [][size=3][b]U[/b] - Upgrade Troops[/size] [*][size=3][b]R[/b] - Recruit Prisoners[/size] [/list] [size=5]Options[/size]

[size=3]Options can be found via the main menu option: Mod Options -> Yet Another Party Organiser[/size]

[size=3][list] [][b]Enable Auto Sorting[/b] [list] [][i]Default: On[/i] []Sorts troops and prisoners upon opening the party screen [/list][][b]Prefer ranged with specific weapons [/b] [list] [][i]Default: 0[/i] []Prefer specific ranged weapons when upgrading to ranged troop classes. (0 for no preference, 1 for Bows, 2 for crossbows) [/list][][b]Keep enough gold for X days of troop wages [/b] [list] [][i]Default: 3[/i] []Reserves gold to pay daily costs for X amount of days [/list][][b]Split upgrades if decision can't be made [/b] [list] [][i]Default: Off[/i] []Splits upgrade paths when no decision can be made [i]Note: decisions will be made based on culture strengths[/i] [/list][][b]Player decides on split upgrade path [/b] [list] [][i]Default: Off[/i] [*]Lets player decide on every upgrade when two upgrade options are available [/list][/list][/size]

[size=5]Planned Features [/size] [list][][size=3]Anything that fits within the scope of party organisation that anyone may suggest! Feel free to request features in the posts section![/size] [][size=3]Configurable group sort orders (Type: Done)[/size] [][size=3]Configurable upgrade rules[/size] [][size=3]Handling of all multi-path upgradable troops by ratio or by party composition[/size] [*][size=3]Configurable main party prisoner and other party troops/prisoner (after battle) recruitment rules[/size] [/list]


[size=5]Versions [/size] [list][]We maintain separate versions for Bannerlord Stable and Beta branches. The beta-compatible branch is clearly labelled with BETA in the files section. []We will aim to do the majority of development on the beta-compatible version, so new features will most likely hit that version before they hit stable. []For bugs and crashes, we will aim to make fixes for these available on both versions, depending on their nature. []Please make sure you identify which version you are using when reporting any issues on the github repository. [/list]

[size=5]Known Issues [/size] [list][*][b]None[/b] [/list]

[size=5]Contributing [/size] This mod is [url=https://github.com/tbeswick96/BannerlordYetAnotherPartyOrganiser]open source[/url] so please feel free to explore it. It isn't perfect but we are working on it. If you want to help don't hesitate to get into contact and have a look at our [url=https://github.com/tbeswick96/BannerlordYetAnotherPartyOrganiser/wiki/Contributing]contribution guide[/url].