TAS Helper


Allows you to record player actions and export them to make tool-assisted speedruns.

Utilities
1 year, 9 months ago
1.1
78
Owner:
larkexploitingprodmodules
Source:
N/A
Homepage:
N/A
License:
MIT
Created:
1 year, 9 months ago
Latest Version:
0.1.0 (1 year, 9 months ago)
Factorio version:
1.1
Downloaded by:
78 users

TAS Helper

This mod allows you to record your actions and then export those actions for use in creating tool-assisted speedruns.

Currently it supports exporting to EZRaiderz TAS Helper (youtube showcase, Getting on track like a pro TAS World Record, github).
You will need to copy/paste the exported tasks into the TAS Helper save file.

How to use it

Here is a recommended workflow:

  1. Save - In EZRaiderz TAS Helper, save your current tasks, say to tas_save.txt.
  2. Generate Script - as normal.
  3. Open save file in a text editor - Open/reopen tas_save.txt so that it is up to date (because you are going to be pasting into it and then saving!).
  4. Play the script - as normal with the TAS mod and this mod enabled. (Also check out Game Speed Controls to speed up/pause the playback.) If there are any errors/mistakes in your tasks list, then fix them in the EZRaiderz TAS tool and repeat from step 1. Remember to save and reopen tas_save.txt so that it is up to date!
  5. Record - Press the 'Record' button and do your desired actions.
  6. Export - Press 'Export (EZR)' and follow the instructions to add your new actions to tas_save.txt.
  7. Open save file in the TAS tool - Open the file in EZRaiderz to see your additions.
  8. Repeat!

Make sure to make regular backups of the TAS save file (tas_save.txt) in case you accidentally make a mistake while copy/pasting! You don't want to accidentally paste over all your work then close your text editor without realising! (You can just make a copy of tas_save.txt in your file explorer after every few changes.)

Hotkeys

Hover over the GUI buttons or check out the controls settings in-game to see the default hotkeys.

Notes

Some actions are captured, and some cannot be captured because of limitations in/difficulties with the Factorio modding API.

Here are the actions that are captured:

  • Build
  • Rotate
  • Mine (including buildings as well as ore/trees/rocks etc)
  • Take/Put - But only when 'fast transferring' (ie 'ctrl + click' or 'shift + click' on an entity). If you click on a building to open your/its inventory and then transfer by clicking on item stacks, it will not be captured.
  • Set recipe, chest limit, splitter priority/filter or filter inserter filters - Including copy/pasting settings between entities. (However some of these cannot be exported because of bugs in EZRaiderz TAS tool, see below.)
  • Researching a tech
  • Crafting
  • Walking - This is only captured when you click the 'Add walk task' button (or press the corresponding hotkey)

The following are not captured:

  • Pick up/drop item (i.e. pressing 'F' or 'Z')

Additionally, there are some bugs in EZRaiderz TAS tool which mean that some things cannot be exported (even if they are recorded correctly):

  • Splitter priority/filters and filter inserter filters.
  • Clearing recipe.
  • Some technologies are broken because the names were changed in 1.1.0, but they're military techs so I believe none of them are important for speedruns.
  • Putting or taking from some more obscure buildings might be broken because of EZR jank, but I think all of the buildings relevant to speedrunning work correctly (e.g. shipwreck, rocket silo, beacons, etc.).

Also you can use editor mode, however some actions will not be captured if the game is paused. Unpausing the game should make everything work normally.