Skip to content

Commit 6c966cb

Browse files
committed
Revise documentation, add changelog entry
1 parent 5e76734 commit 6c966cb

File tree

2 files changed

+18
-13
lines changed

2 files changed

+18
-13
lines changed

changelog.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ Template for new versions:
2727
# Future
2828

2929
## New Tools
30+
- `fix/archery-practice`: combine ammo items in units' quivers to fix 'Soldier (no item)' issue
3031

3132
## New Features
3233

docs/fix/archery-practice.rst

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,11 @@ Usage
1818
Combine ammo items inside quivers that are assigned for training.
1919
Do not print to console.
2020

21-
This tool will only combine ammo items inside the quivers of units in
22-
a squad that is currently set to train.
21+
This tool will combine ammo items inside the quivers of units in squads
22+
that are currently set to train with the objective of ensuring that each
23+
unit hold only one combined stack of ammo item assigned for training in
24+
their quiver. Any ammo items left over after the combining operation
25+
will be dropped on the ground.
2326

2427
The 'Soldier (no item)' issue
2528
-----------------------------
@@ -29,17 +32,17 @@ able to practice archery at the archery range when their quiver contains
2932
more than one stack of ammo item that is assigned to them for training.
3033
This is indicated on the unit by the 'Soldier (no item)' status.
3134

32-
The issue occurs when the game assigns an ammo item with a stack sizes of
35+
The issue occurs when the game assigns an ammo item with a stack size of
3336
less than 25 to the unit, prompting the game to assign additional stacks
3437
of ammo items to make up for the deficit.
3538

36-
The workaround to this issue is to ensure the squad ammo assignments for
37-
use in training are filled with ammo items with stack sizes of at least 25.
38-
Since training bolts that are often made of wood or bone are created in
39-
stacks of 5, the use of ``combine`` on ammo stockpiles is recommended to
40-
reduce the frequency of this issue occurring, while "incomplete" stacks of
41-
ammo items that are already inside the quivers of training units can be
42-
managed by this tool.
39+
The workaround to this issue is to ensure the squad ammo assignments
40+
for use in training contain as few ammo items with stack sizes smaller
41+
than 25 as possible. Since training bolts are often made from wood or
42+
bone which are created in stacks of 5, the use of the ``combine`` tool on
43+
ammo stockpiles is recommended to reduce the frequency of this issue
44+
occurring, while "incomplete" stacks of ammo items that are already
45+
picked up by training units can be managed by this tool.
4346

4447
Any other stacks of ammo items inside the quiver that are not assigned
4548
for training will not affect the unit's ability to practice archery.
@@ -48,9 +51,10 @@ Limitations
4851
-----------
4952

5053
Due to the very limited number of ammo items a unit's quiver might contain,
51-
the material, quality and maker of the items are ignored when combining them.
52-
Only ammo items assigned for training will be combined, while ammo items
53-
inside the quiver that are assigned for combat will not be affected.
54+
the material, quality, and maker of the items are ignored when performing
55+
the combining operation on them. Only ammo items assigned for training will
56+
be combined, while ammo items inside the quiver that are assigned for combat
57+
will not be affected.
5458

5559
Although this tool will consolidate ammo items inside quivers and discard
5660
any surplus items, the training units may not immediately go for archery

0 commit comments

Comments
 (0)