Skip to content

scarletcafe/TASauria

Repository files navigation

Issues


TASauria

a plugin and library for remotely controlling BizHawk with Python
English | 日本語
Read the documentation


TASauria is a collection of two main components:

  • An plugin ("external tool") for BizHawk that allows the client to be controlled via a WebSocket connection,
  • A Python library that provides a flexible, object-oriented, and Pythonic interface to the plugin to make writing Python scripts for BizHawk easy.

The name TASauria is a portmanteau of TAS (Tool Assisted Speedrun), and Sauria, the monophyletic group that bridges the Hawk and the Python.

Installation

Important

You can view more detailed installation instructions, as well as a user guide and information on how to make your own scripts, on the documentation website.

Download the appropriate plugin file for your BizHawk version from the releases page, and place it into your ExternalTools directory alongside EmuHawk.exe.

If the plugin is installed and detected correctly, you should be able to open the TASauria window from the Tools > External Tool menu.

You can then install the Python library using pip:

pip install -U tasauria

Acknowledgements

I would like to thank all BizHawk contributors for having a great impact in keeping the passion for old video games alive. TASing is some of the most fun I've had, and I hope it continues to inspire people to love these games into the future.