New Feature: `autotraining` #1411

realSquidCoder · 2025-03-01T22:19:22Z

Code for dwarves to hit the gym when they yearn for the gains. Assigns dwarves to a military squad until they have fulfilled their need for Martial Training

Code for dwarves to hit the gym when they yearn for the gains. Assigns Dwarves to a military squad until they have fulfilled their need for Martial Training

chdoc · 2025-03-06T20:03:23Z

Here are some observations:

I'm not particularly fond of the name gym, because it makes me think of using screw pumps to increase strength. Maybe just call it martial-training or martial-arts-class
I think the squad should just be chosen from a list, instead of requiring the user to name a squad in a particular way. I think that squads are intended to use DF names, and I would not be surprised if the ability to just input strings would disappear. Maybe, if there is only a single squad that does not have a uniform set, default to that.
I would like an option to not automatically replace the squad leader. This way you could actually put a decently skilled teacher in charge of the squad. Also, squad leaders are nobles and this would avoid at least some of the historical figure noise.

chdoc · 2025-03-06T20:09:12Z

It would be nice to have an option to automatically exclude holders of relevant positions (e.g. the manager ...)

realSquidCoder · 2025-03-06T20:12:36Z

1. I'm not particularly fond of the name `gym`, because it makes me think of using screw pumps to increase strength. Maybe just call it `martial-training` or `martial-arts-class`

Ok thats not a terrible idea. the original name was just needs-training so maybe martial-training works

2. I think the squad should just be chosen from a list, instead of requiring the user to name a squad in a particular way. I think that squads are intended to use DF names, and I would not be surprised if the ability to just input strings would disappear. Maybe, if there is only a single squad that does not have a uniform set, default to that.

the reason you need to make a squad (tho i want to make the script make it's own squad in a later stage) is because it lets you give them the proper schedule and teacher leader.

3. I would like an option to not automatically replace the squad leader. This way you could actually put a decently skilled teacher in charge of the squad. Also, squad leaders are nobles and this would avoid at least some of the historical figure noise.

its not supposed to replace the leader, have you seen it doing that?

realSquidCoder · 2025-03-06T20:13:23Z

It would be nice to have an option to automatically exclude holders of relevant positions (e.g. the manager ...)

you can set up ppl to be ignored but auto ignoring ppl is not a bad idea either. who all should be ignored you think?

realSquidCoder · 2025-03-06T20:16:03Z

actually, because i intend this to join the automation tab, perhaps autotraining would be a better name

gym.lua

- Clean up documentation - Add option to change squad name. - persist the enabled state, the threshold, and the squad name. - fixed findNeed function - renamed script to `autotraining` - made the ignore flag more clear and more changable - fixed 1 sided military link in `addTraining`

Also tell the user when data was persisted (mostly for debugging)

and update the docs to account.

autotraining.lua

Co-authored-by: Christian Doczkal <[email protected]>

autotraining.lua

improvements to `autotraining`: - fix the argument error - avoid the double execution of the loop when enabling - consistently only count ignored units when they would otherwise qualify for training - allow enabling the tool from within `gui/autotraining` - sort the list of training candidates, so that the most needed candidates are preferred for training - move the argument handling out of the `start` function Co-Authored-By: Christian Doczkal <[email protected]>

realSquidCoder · 2025-07-27T19:09:32Z

pre-commit.ci autofix

ab9rf · 2025-08-16T21:05:51Z

Needs a changelog, otherwise I think this is ready to merge.

SilasD

I didn't see anything bad enough to justify delaying a merge.

I have some quibbles with command-line processing and with the enable/disable code.
enable autotraining
disable autotraining
It doesn't appear that these command-line commands will work. (not verified.)

I somewhat question the need for autotraining as a separate script. It seems to me that it could be rolled into gui/autotraining.

autotraining.lua

ab9rf · 2025-08-17T07:54:50Z

I somewhat question the need for autotraining as a separate script. It seems to me that it could be rolled into gui/autotraining.
i'm sorry, gui/autotraining? i looked for this and could not find it. to what are you referring?

chdoc · 2025-08-17T09:55:37Z

This pull-request adds both: autotraining as the tool that performs the actual work and can also be (partially) configured using the command-line and gui/autotraining a graphical interface to configure squads and ignored units. If we want to follow the convention that tools that open windows are invoked as gui/something and tools that perform automation are enabled as enable something we need two commands and therefore two files.

ab9rf · 2025-08-17T15:30:17Z

Is everyone ok with a squash merge on this one?

chdoc · 2025-08-17T15:32:10Z

During one of my last sessions I noticed something that I cannot yet explain:

autotraining: 1 training, 12 waiting, and 3 excluded units with training needs

The expected behavior would be 9 training units and 4 waiting units, no?

realSquidCoder · 2025-08-17T15:33:36Z

@chdoc frack its still doing that? as far as i know that thats a miscount bug not a wrong effect bug, i thought i had fixed all of them tho...

edit: wait no, what i misread that... what is it doing there? (still think we can merge this to get more testers)

autotraining.lua

realSquidCoder · 2025-08-17T16:01:37Z

@ab9rf everything seems to have passed so if the others have no issues im cool with a squash and merge. (and of course i'll be around to fix any bugs that are found in the next release)

realSquidCoder added 9 commits March 1, 2025 16:18

New Feature: gym

9da6925

Code for dwarves to hit the gym when they yearn for the gains. Assigns Dwarves to a military squad until they have fulfilled their need for Martial Training

Fix whitespace

81127f2

missed some

5c08fb6

MORE whitespace (and some other cleanup)

edb3e83

Update gym.lua

0c4f5b5

Create gym.rst

50d6a96

Fix EOF

deca155

Update gym.rst

74784f8

fix key error

f4cf0a0

realSquidCoder marked this pull request as draft March 2, 2025 04:22

more key errors

39f2c9c

realSquidCoder marked this pull request as ready for review March 2, 2025 18:50

realSquidCoder added 3 commits March 2, 2025 19:01

Update the documentation

a5d6c0a

Merge remote-tracking branch 'upstream/master' into sci-gym-script

105b0cc

Use the enable/disable stuff not args to start or stop

6c53215

Merge branch 'master' into sci-gym-script

f701f9f

Merge remote-tracking branch 'upstream/master' into sci-gym-script

f149d5c

chdoc reviewed Mar 9, 2025

View reviewed changes

realSquidCoder added 5 commits March 12, 2025 15:10

Merge remote-tracking branch 'upstream/master' into sci-gym-script

4492f3e

Do the documentation in one place

a6761bd

More cleanup

9463d79

Also tell the user when data was persisted (mostly for debugging)

rename the script itself

7dba7e4

and update the docs to account.

realSquidCoder changed the title ~~New Feature: gym~~ New Feature: autotraining Mar 12, 2025

fix docs

86967d7

realSquidCoder and others added 7 commits July 3, 2025 12:03

Update autotraining.lua

e274598

clean and de-nest training candidates

2250848

remove units who don't need training

c325bd3

use our precomputed good squads list

bc3d60f

Merge branch 'master' into sci-gym-script

9800e73

forgot a nil check

3f639ec

only count as ignored if they are ignored

04e34be

chdoc reviewed Jul 4, 2025

View reviewed changes

autotraining.lua Outdated Show resolved Hide resolved

autotraining.lua Outdated Show resolved Hide resolved

autotraining.lua Outdated Show resolved Hide resolved

autotraining.lua Outdated Show resolved Hide resolved

autotraining.lua Outdated Show resolved Hide resolved

realSquidCoder and others added 2 commits July 4, 2025 13:51

Apply suggestions from code review

5c18bba

Co-authored-by: Christian Doczkal <[email protected]>

code review changes

8cee911

chdoc reviewed Jul 17, 2025

View reviewed changes

autotraining.lua Outdated Show resolved Hide resolved

fix whitespace error

0a50575

SilasD reviewed Aug 16, 2025

View reviewed changes

autotraining.lua Outdated Show resolved Hide resolved

autotraining.lua Outdated Show resolved Hide resolved

realSquidCoder added 3 commits August 17, 2025 10:18

Update and fix changelog

b4503f1

only process cli args if we are running in the cli

5836945

Merge remote-tracking branch 'upstream/master' into sci-gym-script

2eab602

chdoc reviewed Aug 17, 2025

View reviewed changes

autotraining.lua Outdated Show resolved Hide resolved

skip units in squads (dont mark as ignored tho)

0f445c7

ab9rf merged commit a02935d into DFHack:master Aug 17, 2025
10 checks passed

github-project-automation bot moved this from Todo to Done in 51.11-r2 Aug 17, 2025

realSquidCoder deleted the sci-gym-script branch August 17, 2025 17:52

New Feature: autotraining #1411

New Feature: autotraining #1411

Uh oh!

Conversation

realSquidCoder commented Mar 1, 2025

Uh oh!

chdoc commented Mar 6, 2025

Uh oh!

chdoc commented Mar 6, 2025

Uh oh!

realSquidCoder commented Mar 6, 2025

Uh oh!

realSquidCoder commented Mar 6, 2025

Uh oh!

realSquidCoder commented Mar 6, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

realSquidCoder commented Jul 27, 2025

Uh oh!

ab9rf commented Aug 16, 2025

Uh oh!

SilasD left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ab9rf commented Aug 17, 2025

Uh oh!

chdoc commented Aug 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ab9rf commented Aug 17, 2025

Uh oh!

chdoc commented Aug 17, 2025

Uh oh!

realSquidCoder commented Aug 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

realSquidCoder commented Aug 17, 2025

Uh oh!

Uh oh!

Uh oh!

New Feature: `autotraining` #1411

New Feature: `autotraining` #1411

chdoc commented Aug 17, 2025 •

edited

Loading

realSquidCoder commented Aug 17, 2025 •

edited

Loading