Subscribe to download
Automation

This mod allows assigning a set of rules to a building. The rules execute logic "If This Then That" (a.k.a. IFTTT). Each rule has a condition to check and an action to execute if the condition evaluates to "true." The rules are written with a simple scripting language. However, it is not required to learn this language to make simple rules, since for this purpose a UI is provided. The UI is designed to be simple and intuitive, so you can easily create rules without writing any code.

If you feel like you can learn the scripting language, you can do so. The scripting language is simple and easy to learn. Read about it here[github.com].

English
Русский


Rules can be created and edited via the Rules editor dialog. The dialog is opened by clicking on the related button in the building's entity UI.



For the simple and frequently used cases, a set of templates is provided. You can select a set of buildings and apply a template to them. The template will automatically create the rules needed to achieve the desired behavior. The created rules can be modified via the editor dialog later if needed.

All templates are grouped by their purpose. The root menu has an icon for each group.



There are also special actions available, not related to the rules:

• Pause/resume tool. Use it to quickly change the state of a set of buildings.
  
• Chained construction tool. Apply this rule to the unfinished buildings. This rule will try to order the constructions so that the builders aren't getting blocked while working. It is not guaranteed that the builders will not get blocked, but it is a good way to reduce the number of blocks.
  
• Pause when almost ready. This tool applies rules that stop the construction at the last moment. Just in case you need to have control of it!
  
• [Dev mode only] Immediate completion of the selected buildings. Select buildings to complete, and they all will instantly finish.
  
• [Dev mode only] Inspects components and navmeshes on the buildings. Useful for those who make mods.

* Press Shift+Alt+Z to activate dev mode

Templates to create rules that automatically detonate a dynamite and place a new one at the same place. This action is repeated multiple times. It can be handy when doing massive terraform. Be careful not to kill your workers! Once one dynamite is activated, the whole field will explode. The safest usage is to dig holes below the surface (for example, from the bridges or at the cliff).



Templates to create rules that trigger on the weather season change:

• Pause/resume a building on the season change.
  
• Close/open floodgates based on the current season.
  
• Open/close the water control buildings during the drought season.

Templates to create rules that trigger based on the building's storage.

• Start emptying the building when there is too much product in the inventory. In this mode, all the available workers, including the ones from the idle buildings, will rush to help move the goods out of the building to the appropriate storage with spare capacity.
  
• Prioritize building to haulers when the building construction completes. The game doesn't allow setting it via UI, but with automation you can do it.

Templates to create rules that trigger based on the current beaver or bot population size. The buildings will pause if the population is too high and resume if it is too low. It is a good way to control the bot population. Also, it will work well for the Ironteeth faction to control the beaver population.




This group is for the advanced players. When you need to make a rule based on a stat value of another building, the very first thing you need to do is to create a custom signal. This signal can be used in the conditions of other buildings.

The floodgate group template demonstrates how the custom signals system can be used to synchronize the behavior on the similar buildings.



Note that Steam has a special tab called "Discussions." It is a better place to ask questions or discuss features than doing so in the comments. I will do my best to answer all questions there, so don't hesitate to ask.

---

Discord:

• If you haven't joined the Timberborn server yet, here is the invite link: https://discord.gg/qfbKAXR7
  
• If you have already joined, this is the link to the channel: https://discord.com/channels/558398674389172225/1190169064383991858

See more details in the Wiki: https://github.com/ihsoft/TimberbornMods/wiki/Automation
Report a bug: https://github.com/ihsoft/TimberbornMods/labels/automation
GitHub repository: https://github.com/ihsoft/TimberbornMods