birds-eye-lib 0.1.0

A BizHawk external tool + python library for python scripts to communicate with the BizHawk emulator.

birds-eye

A BizHawk external tool + python library giving a (hopefully) convenient interface for python scripts to communicate with the BizHawk emulator.

This is the first project I've made with the intent of others using it, so any kind of suggestion would be incredibly helpful.

Thank you :]

This library is VERY bares bones at the moment, with only the current features available:

• Connecting to the external tool
  

• Retrieving memory data from the external tool (addresses are set in the ext. tool)
  

• Sending inputs to be executed in the emulator
  

I plan on adding a lot more as I continue to use this library myself. (see TODO section below)

Tested using BizHawk version 2.6.2, however other versions might work.

Setup

External Tool

The external tool can be found and downloaded in the birds-eye github repository. (check releases)

Move BirdsEye.dll to the ExternalTools directory in your BizHawk folder.

It should look like this afterwords:

BizHawk

+--ExternalTools

|   +--BirdsEye.dll

|   +--...

+--EmuHawk.exe

+--...

If everything is correct, then you should be able to open up the external tool by running the emulator, then going to

Tools -> External Tools -> BirdsEye

Installing the library

pip install birds-eye-lib

Communication Modes

Determines how the external tool communicates with the emulator and a connected python script.

Manual

The external tool will not send or receive messages to and from a connected python script. User will still have

full control over the emulator using the external tool or the emulator itself.

Commandeer

This mode will allow a connected python script to begin interacting with the emulator by sending and receiving

messages to and from the external tool.

TODO

This is a list of the current improvements that are currently being worked on, or plan to be.

Library

• Check if socket disconnects
  

• Method for reconnecting to the ext. tool after prematurely disconnecting
  

External Tool

• Save selected memory addresses to be read from for later sessions.