Metadata-Version: 2.4
Name: tasauria
Version: 1.0.4
Summary: A library for remotely controlling BizHawk with custom scripts
Author: scarletcafe
License: The MIT License (MIT)
        
        Copyright (c) 2025-present Devon (scarlet.cafe) R.
        
        Permission is hereby granted, free of charge, to any person obtaining a
        copy of this software and associated documentation files (the "Software"),
        to deal in the Software without restriction, including without limitation
        the rights to use, copy, modify, merge, publish, distribute, sublicense,
        and/or sell copies of the Software, and to permit persons to whom the
        Software is furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in
        all copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
        OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
        FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
        DEALINGS IN THE SOFTWARE.
        
Project-URL: Issue tracker, https://github.com/scarletcafe/tasauria/issues
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Games/Entertainment
Classifier: Topic :: Internet
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: System :: Emulators
Classifier: Typing :: Typed
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: aiohttp<4,>=3.11
Requires-Dist: click<9,>=8.1
Provides-Extra: lint
Requires-Dist: ruff<1.0,>=0.13; extra == "lint"
Provides-Extra: documentation
Requires-Dist: lxml<7.0,>=6.0; extra == "documentation"
Dynamic: license-file


[![Issues](https://img.shields.io/github/issues/scarletcafe/TASauria.svg?colorB=3333ff)](https://github.com/scarletcafe/TASauria/issues)

***
<div align="center">
<img src="https://raw.githubusercontent.com/scarletcafe/TASauria/7469b1b004fb45034992c02ab5e0abbff1cacb60/.github/assets/tasauria_logo.svg" height="128">
</div>
<h1 align="center">
TASauria
</h1>
<p align="center">
<sup>
a plugin and library for remotely controlling BizHawk with Python
</sup>
<br>
<sup>
    <b>English</b> | <a href="README.ja.md">日本語</a>
</sup>
<br>
<sup>
    <a href="https://scarletcafe.github.io/TASauria/">Read the documentation</a>
</sup>
</p>

***

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](https://tasvideos.org/WelcomeToTASVideos#WhatIsATas)), and [Sauria](https://en.wikipedia.org/wiki/Sauria), the monophyletic group that bridges the [Hawk](https://tasvideos.org/Bizhawk) and the [Python](https://www.python.org/).

## 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](https://scarletcafe.github.io/TASauria/).

Download the appropriate plugin file for your BizHawk version from the [releases page](https://github.com/scarletcafe/tasauria/releases), 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`:
```bash
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.
