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.

IMPORTANT:

• This mod has been developed by an individual and is not associated with the game's developer in any way. Please refrain from asking the developer any questions regarding this mod.
• This mod has been developed with the sole intention of single-player usage. Please be aware that it is not supported for server operation, and we kindly request your understanding in this matter.

Features

TIP: Each of the features described below can be completely disabled using the "Disable Module" option in the configuration.

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 mapping

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 icon pack: You can also define your own icons in png and json files. See docs/custom-icon-pack.adoc for custom icon pack specifications.

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

Modifies tamable creatures so that they can eat food from containers and the player's inventory, not just items 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.

Automatic mining

Automatically mines minerals in the player's surroundings. You can also add a shortcut key that allows you to mine at any time.

Automatic pickup

Automatically pick up items around the player. You can also add a shortcut key that searches the surroundings for the same items as the interacted item and pick up them all.

Console commands

Automatics add a few commands to help the user.

automatics

Usage: automatics (OPTIONS...)

Displays the usage of commands added by Automatics.

OPTIONS

printnames

Usage: printnames (OPTIONS...) (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$)

OPTIONS

Examples

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

printobjects

Usage: printobjects [TYPE] (OPTIONS...)

Display objects that can be handled by Automatics in the nearby.

NOTE: The result of this command may show objects that you feel are not of the target type. For example, a Flint appear in the Flora search. This is not a bug but means that Automatics can treat Flint as Flora.

TYPE

Type of object to be displayed. Specify one of the following: animal, container, door, dungeon, flora, mineral, monster, spawner, spot, vehicle, other.

OPTIONS

removemappins

Usage: removemappins (OPTIONS...)

Remove map pins that match the specified conditions. If no options are specified, all duplicate pins will be deleted.

NOTE: Please disable the "Automatic Mapping" feature before using this command. It may cause malfunctions.

OPTIONS

Configurations

I recommend using Configuration Manager.

The README would be too large if we described all the details of the configuration, so we split it into separate file.

Open CONFIG.adoc to see the configuration details.

Adding object definitions to Automatics

You can use the Configuration Manager to define objects that you want Automatics to work with.

Open docs/add-user-defined-object.adoc to learn more about adding user-defined objects.

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

Contacts

Only bug reports are accepted under Issues.

Questions, suggestions and comments are welcome on the Discord Server.

Credits

• Dependencies:
  • Configuration Manager
  • LitJSON
  • NDesk.Options

License

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