Total War: WARHAMMER II

Total War: WARHAMMER II

Find Idle Units
 This topic has been pinned, so it's probably important
paperpancake  [developer] Feb 6, 2020 @ 7:34pm
How do I use the configuration options?
You can continue to use the text file configuration described below, and/or you can use Vandy's new version of the Mod Configuration Tool. You do not need MCT or the text file for this mod to work, but I recommend using one or the other (or both).

Advantages of MCT 2: See and update your options from within the game. Keep options for all your mods in one place. Easier to see what the allowed settings are.

Advantages of the text file below: Doesn't require another mod. This can be especially helpful if an update causes MCT to be bugged or out of date for a short while.


If you want to use the text file for configuration, use the steps below.

  1. On your computer, go to the folder where your game is installed (the main folder, not the data folder). This will vary based on where you installed the game and what kind of computer you have, but a common place for it is
    C:\Program Files (x86)\Steam\steamapps\common\Total War WARHAMMER II
  2. Add a new folder called mod_config (if you haven't already for another mod). If you don't create this folder, this mod will just use default values and not read or write any config files.
  3. You now need to create the config file. Choose the way to create it that you think is easiest:
    • In the mod_config folder, create a new text file called find_idle_units_config.txt. Copy and paste the default file contents into your new file. You can find the default file contents in the next post.

    • - OR - With this mod enabled, start TW Warhammer II. Once you're at the main menu, minimize or exit the game. You'll now see a new file called find_idle_units_config.txt in the mod_config folder that you created for step #2. Open that text file.
  4. In your new text file you will see examples and default values that you can change and save.


Notes:
- This mod reads this file during the battle loading screen, so any changes you save to the config file will be used in the next battle you play. No need to restart the whole game to see your changes.
- This config file is a way that you can customize the mod without having to redo your work every time the mod updates.
Last edited by paperpancake; Aug 19, 2021 @ 1:10pm
< >
Showing 1-3 of 3 comments
paperpancake  [developer] Feb 6, 2020 @ 7:37pm 
-- Here is what is in the configuration file by default.
-- Read this and make changes if you want to customize how this mod works.

-- Anything that starts with a -- is a comment.
-- Comments are just notes to yourself. They don't do anything.
-- You can add, change, or delete comments all you'd like.
-- I put my comments above or on the line they refer to.

--------------------------------------------------------------------------------------------
-- How many seconds should the advisor be visible before being dismissed?
-- You can set this to false or 0 if you don't want it to appear at all.

popup_msg_duration = 1.3

--------------------------------------------------------------------------------------------
-- Change any of the below to true to disable a feature that's normally included in this mod

no_card_pulsing_for_toggle = false
no_ping_icon_for_toggle = false

no_ping_icon_for_next_unit = true
no_camera_pan_for_next_unit = false


---------------------------------------------------------------------------------------------
-- The "Find All Idle Units" toggle is normally off at the beginning of a battle.
-- If you want it to turn on automatically each battle, then change the value to be
-- the number of seconds to wait before turning on (decimals are allowed).
-- You can use 0 to have it turn on immediately
-- If you use a hotkey to turn this on even sooner in a battle, this will be ignored
-- Use false or a negative number to leave it turned off until you use a hotkey

toggle_on_automatically_after = false

---------------------------------------------------------------------------------------------
-- The following options tell this mod to exclude or ignore units
-- Excluded units won't be marked as idle or be included in "Next Idle Unit"
-- unless you include them again with the button or hotkey, or unless the conditions are met
-- for them to be automatically included again.
--
-- To use Save Camera Bookmark 12 as the exclusion
-- hotkey, set use_hotkey_to_exclude_unit = true
-- Then in the game's Controls menu you can
-- bind Save Camera Bookmark 12 to whatever key(s) you want.

add_button_to_exclude_unit = false
use_hotkey_to_exclude_unit = false
exclude_spellcasters_by_default = false -- this was added in 05/2020

-- The following don't do anything unless at least one of the exclude options is true

include_again_if_new_spell = false
include_again_if_mana_is_at_least = 99
include_again_if_gates_break = false

----------------------------------------------------------------------------------------------
-- To reduce false positives, this mod waits until a unit is idle for
-- at least seconds_idle_before_marked before marking it or including it in the
-- next idle unit hotkey.

seconds_idle_before_marked = 1.8
seconds_between_idle_checks = 0.6

----------------------------------------------------------------------------------------------
-- These options allow you to change the hotkeys this mod piggybacks on or to get rid of the
-- piggybacking altogether
-- You probably don't need to edit these unless you need them for another mod or you need
-- a lot of camera bookmark hotkeys and wish this mod didn't use so many.
-- Set these to have this function as described in mod's description ("Save Camera Bookmark 10" and 11)
-- Set either or both of these to false to not it use at all
-- Or you can set these to one of the allowed modding hotkeys (F2 to F4) like "script_shift_F2"

hotkey_for_toggle_find_all_idle = true
hotkey_for_next_idle_unit = true
Last edited by paperpancake; Dec 18, 2020 @ 12:04pm
paperpancake  [developer] May 24, 2020 @ 10:13am 
-- I updated the above post with the contents of the recently updated default configuration file.
-- If you already had a configuration file before an update, one or more of the following will be added to the
-- bottom of your configuration file the next time you open the game and go to the main menu:

----------------------------------------------------------------------------------------------
-- ******* New for 05/2020 *********
----------------------------------------------------------------------------------------------
-- All but one of the options that were placeholders should now work except for one:
-- Sadly, include_again_if_new_ability doesn't do anything,
-- so you can delete that line from the config file above
--
-- Excluded units won't be marked as idle or be included in "Next Idle Unit"
-- unless you include them again with the button or hotkey, or unless the conditions are met
-- for them to be automatically included again.
--
-- To use Save Camera Bookmark 12 as the exclusion
-- hotkey, set use_hotkey_to_exclude_unit = true
-- Then in the game's Controls menu you can
-- bind Save Camera Bookmark 12 to whatever key you want.
-- If that creates a conflict for you, the discussion on Steam explains other options.

---------------------------------------------------------------------------------------------
-- You can automatically start with all spellcasters excluded from this mod
-- at the beginning of the battle by setting the following to true.

exclude_spellcasters_by_default = false



----------------------------------------------------------------------------------------------
-- ******* New for 06/2020 *********
----------------------------------------------------------------------------------------------

-- To reduce false positives, this mod now waits until a unit is idle for
-- at least seconds_idle_before_marked before marking it or including it in the
-- next idle unit hotkey.

seconds_idle_before_marked = 1.8
seconds_between_idle_checks = 0.6



----------------------------------------------------------------------------------------------
-- ******* New for 08/2020 *********
----------------------------------------------------------------------------------------------

-- These options allow you to change this mod's primary hotkeys or get rid of them altogether
-- You probably don't need to edit these unless you need them for another mod or you need
-- a lot of camera bookmark hotkeys and wish this mod didn't use so many.
-- Set these to true to use the hotkeys in the mods description ("Save Camera Bookmark 10" and 11)
-- Set either or both of these to false to not use it at all
-- Or you can set these to one of the allowed modding hotkeys (F2 to F4) like "script_shift_F2"

hotkey_for_toggle_find_all_idle = true
hotkey_for_next_idle_unit = true
Last edited by paperpancake; Aug 3, 2020 @ 6:32pm
paperpancake  [developer] May 24, 2020 @ 12:24pm 
If you set use_hotkey_to_exclude_unit = true, it uses Save Camera Bookmark 12. That allows you to use any key combo you want by binding it in the game's controls menu. However, I know that mods are now starting to eat into a lot of camera bookmarks shortcuts, so there are a few other specific choices you can use instead if you don't want to use Save Camera Bookmark 12.

For all the usual options in the config file above, you don't use "quotation marks", but if you are using one of the following alternate options below, be sure to include the "quotation marks" where indicated.

To use F2, set use_hotkey_to_exclude_unit = "script_F2"

To use SHIFT + F2, set use_hotkey_to_exclude_unit = "script_shift_F2"

To use CTRL + F2, set use_hotkey_to_exclude_unit = "script_ctrl_F2"

To use F3, set use_hotkey_to_exclude_unit = "script_F3"

To use SHIFT + F3, set use_hotkey_to_exclude_unit = "script_shift_F3"

To use CTRL + F3, set use_hotkey_to_exclude_unit = "script_ctrl_F3"

To use F4, set use_hotkey_to_exclude_unit = "script_F4"

To use SHIFT + F4, set use_hotkey_to_exclude_unit = "script_shift_F4"

To use CTRL + F4, set use_hotkey_to_exclude_unit = "script_ctrl_F4"
< >
Showing 1-3 of 3 comments
Per page: 1530 50