Automatics - Valheim Mod

Automatics is a mod that automates the tedious tasks of life in Valheim. Most of its features exist in existing mods, but it has been re-designed to make it easier for me to use.

Features

Automatic door

Automatically opens and closes the door near the player. The interval and distance to detect the player can be changed from the configuration.

Automatic map pinning

Automatic pinning animals, monsters, floras, veins, dungeons, etc. that exist around the player to the map. The pinning allows for each object and the detection range of the object can be changed from the config.

Custom map icons

Using png files and json, you can customize icons for pins added by Automatic map pinning.

Directory structure

Place the necessary files in "/Valheim/BepInEx/plugins/Automatics/Textures" to make the custom icons work.

• /Valheim/BepInEx/plugins/Automatics/Textures

  • custom-map-icon.json

    • Describe information such as which icons to customize and which images to use. Details are described in the Format of custom-map-icon.json section.

  • ICON.png

    • Icon image file. PNG files with transparency information are preferred. Prepare the number of icons required.

Format of custom-map-icon.json

Root <Array>

• target <Object>

  • name <String>

    • Specify a display name such as "Boar" or an internal name such as "$enemy_boar"; See the Matching by "Display name" and "Internal name" section for the difference between matching by display name and internal name.

  • metadata <Object> (Optional)

    • level <Number>

      • By setting up this field, you can set up icons for different levels of animals and monsters. Note that the unstarred state is level 1. One star is level 2 and two stars are level 3. Also, do not set the metada field if matching by level is not required.

• sprite <Object>

  • file <String>

    • Specify the name of the image file to be used for the icon. It is best to keep the image size between 16x16 and 32x32, as too large an icon will be obtrusive.

  • width <Number>

    • Specify the width of the icon.

  • height <Number>

    • Specify the height of the icon.

Example files

I don’t feel I have explained it very well, so I have prepared a sample file. Please click here to check the structure of the file that actually works. You can also download the zip file and check the operation on your PC.

• Example files (Github)

• Example files (Zip)

NOTE: Zip is not guaranteed to work with mod loaders other than Vortex; if you are using a mod loader other than Vortex, please manually place the files in the Zip into the appropriate directory.

Automatic processing

Refueling pieces that need fuel. Deliver materials to pieces that process materials, and store items produced by pieces. These tasks can be automated via containers around the piece.

Automatic feeding

Animals and other creatures that consume food will be able to consume food from containers and the player’s inventory, not just from food on the ground.

Automatic repair

It can automatically repair items when the player is near a crafting station or when the crafting station GUI is opened or automatically repair nearby pieces when the player has a hammer equipped.

Console commands

Automatics add a few commands to help the user.

automatics [COMMAND]

Displays the usage of commands added by Automatics.

• COMMAND: Command name to display usage. If there is an exact match, it will be displayed. Otherwise, it will display the first partially matched command found. If omitted, the usage of the automatics command itself is displayed.

printnames (WORD|REGEXP)...

Outputs internal or display names that contain the specified string or match the specified regular expression. If multiple arguments are specified, only those matching all of them will be output.

• WORD: A text contained in the internal or display name. (e.g. $enemy_, $item_, $piece_, Boar, Mushroom, Wood door); All partially matching internal and display names are output.

• REGEXP: A regular expression of the internal or display name to be output. Must be prefixed with "r/". (e.g. r/^[$]item_, r/^boar$)

Examples:

• printnames ling r/^[$]enemy_
• printnames r/^[$@]location_.+(?<!_(enter|exit))$
• printnames mushroom r/^[$]item_.+(?<!_description)$

Configurations

I recommend using Configuration Manager.

Please check the details from GitHub as the README will be too large to upload to Thunderstore if all the optional details are described.

Supplementary explanation

Matching by "Display name" and "Internal name"

In some features of Automatics, there is an option that allows the user to add targets as needed. The "Display name" and "Internal name" are used to identify these targets. The display name and internal name are matched according to different rules.

Display name

Display names are the names that appear in the game, such as Boar, Deer, Dandelion, etc. The matching rule for "Display name" is a partial match, meaning that if the target display name contains the specified string, it matches. It is case-insensitive.

Internal name

Internal names are the names used inside the game program, such as $enemy_boar, $enemy_deer, $item_dandelion, etc. The matching rule for "Internal name" is an exact match, meaning that if the target internal name is identical to the specified string, it matches. It is case-insensitive. Note that internal names for translations added by Automatics are prefixed with @, not $, as in @internal_name

Matching Samples

Target data

Display name	Internal name
Greyling	$enemy_greyling
Greydwarf	$enemy_greydwarf
Surtling	$enemy_surtling

Matching result

	Grey	ling	$enemy_greyling	$enemy_greydwarf	$enemy_
Greyling	Match	Match	Match	No match	No match
Greydwarf	Match	No match	No match	Match	No match
Surtling	No match	Match	No match	No match	No match

Languages

Language	Translators	Status
English	Translation Tools	100%
Japanese	EideeHi	100%

Credits

• Dependencies:

  • Configuration Manager

  • LitJSON

License

Automatics is developed and released under the MIT license. For the full text of the license, please see the LICENSE file.

Changelog

v1.2.1 [2022-04-19]

• Change the automatic door to not work if there is an obstacle between the player and the door
• Change the minimum automatic door process interval to 0
  • Setting the value below 0.1 disables automatic opening or closing. The substantive minimum interval remains unchanged from 0.1
• Change so that the printnames command searches all translations
  • With this change, the printnames command can now take multiple arguments, allowing for more powerful filtering
  • See printnames usage for command details

v1.2.0 [2022-04-16]

• Change the format of the Cutom Map Icon settings file from csv to json
  • See "Format of custom-map-icon.json" for more information on json files
• Change translation files format from csv to json
• Fix 'Standing brazier' was omitted from 'Automatic Processing'
• Fix to be able to output names of fish, birds and dungeons with the 'printnames' command
• Fix a bug that prevented some config values from being read accurately

v1.1.2 [2022-04-14]

• Add command to output internal and display names
  • See "Console commands" in the README for details
• Add options to suppress automatic processing based on item count
• Add option to automatic refuel only when materials supplied
• Change 'Automatic Repair' not to work during game pauses
• Change 'Allow...(Custom)' options to evaluate for exact match if an internal name is specified, or partial match if a display name is specified
  • The "$enemy_boar" matches only "Boar", but "Greydwarf" matches "Greydwarf brute" and "Greydwarf shaman" in addition to "Greydwarf"
  • The same goes for TARGET for Custom Map Icon

v1.1.1 [2022-04-10]

• Fix package task of mod files for Thunderstore
• Fix a bug in which the 'Repair Pieces' function continued to work even though the 'Automatic Repair' feature was disabled in the configuration

v1.1.0 [2022-04-07]

• Add the feature of 'Automatic Feeding'
• Add the feature of 'Automatic Repair'
• Add option to allow automatic opening/closing for any door
• Fix a bug where the generated items would be lost if Smelter could not find the container when 'Automatic Store' was enabled
• Fix a bug where the honey to be set over the maximum if Beehive could not find the container when 'Automatic Store' was enabled

v1.0.6 [2022-04-04]

• Fix a bug that prevented automatic pinning of player existing in the open air under certain conditions, judging that they exist in the dungeon
• Add elements added in patch 0.207.20 to be the target for automatic pinning
• Change the maximum value of the container search range in 'Automatic Processing' to 64
• Change to remove pins added by automatic pinning when some veins are destroyed

v1.0.5 [2022-03-28]

• Add shortcut key to perform searches for static objects
• Add shortcut key to enable/disable automatic door
• Fix a bug that caused dynamic pins to remain on the map when auto-pinning was disabled from the config
• Change the initial value of the 'Automatic Map Pinning' configuration

v1.0.4 [2022-03-18]

• Fix a bug fish were not pinned
• Fix a bug that caused pins to be deleted at unintended times
• Fix a bug in which automatic pinning of ship was enabled regardless of the config value
• Add the feature to customize the icons of pins added by auto pinning
  • There are no custom icons bundled with Automatics, please add your own

v1.0.3 [2022-03-16]

• Fix a bug where tamed animals continue to be pinned
• Add options for users to add map pinning targets (animals, monsters, flora, veins, and spawners)
  • As a result, elements added by mods are no longer automatic pinning unless this option is used
• Add an option to allow ships to be automatic pinning
  • This is dynamic pinning, but unlike other dynamic pins, the pins is saved in the save data

v1.0.2 [2022-03-15]

• Improvement of FPS drop due to Automatic Map Pinning
  • In particular, FPS is greatly improved in areas with a lot of flora, such as farms
• Reduce the processing load on Automatic Door
• Add Portal to the Automatic Map Pinning target
  • Portal is added to 'Allow Pinning Other Objects'

v1.0.1 [2022-03-06]

• Fix a bug that prevented some Tar Pits from being pinning
• Fix a bug in which automatic map pinning of static objects causes a significant drop in FPS
• Fix logic for determining if a vein is in ground
• Change the Automatic Map Pinning process is not called when the game is paused
• Change Automatic Door options so that Open and Close can be specified separately

v1.0.0 [2022-01-23]

• Initial release