An input driver for mupen64plus that consumes from a python web server
C Makefile Python C++
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

mupen64plus-input-bot

An input driver for mupen64plus that consumes a JSON response from a web server. Intended for use with my TensorKart project that trains an AI using TensorFlow to play the classic N64 title MarioKart 64.

Building

make all

The project uses essentially a copy and paste of the Makefile from the regular input plugin for mupen64plus with the dynamic config lib and SDL dependencies removed. It includes flags to link libjson-c, which it assumes has been installed into /usr/lib and /usr/include. You can get this library on Ubuntu by installing the following packages (or if you prefer, you can build the latest from source here):

libjson-c2
libjson-c-dev

Note that all builds expect the mupen64plus-core source code to be available in the same directory.

eg.

src \
  mupen64plus-core \
    ...
  mupen64plus-input-bot \
    ...

Installing

After building run sudo make install to copy the driver to the default location.

/usr/local/lib/mupen64plus/mupen64plus-input-bot.so

Installing the driver to a standard system location allows downstream applications to configure mupen64plus automatically (for example the mupen64plus OpenAI gym)

Usage

mupen64plus --input /usr/local/lib/mupen64plus/mupen64plus-input-bot.so MarioKart64.z64

Protocol

The server attempts to deserialize the web response as a JSON object. It expects the JSON object to contain properties that represent each of the controller button states (as integers). If any buttons are not included in the response, their values will default to 0.

Example JSON response:

{
  "START_BUTTON": 0,
  "U_CBUTTON": 0,
  "L_DPAD": 0,
  "A_BUTTON": 1,
  "B_BUTTON": 0,
  "X_AXIS": -80,
  "L_CBUTTON": 0,
  "R_CBUTTON": 0,
  "R_TRIG": 0,
  "R_DPAD": 0,
  "D_CBUTTON": 0,
  "Z_TRIG": 0,
  "Y_AXIS": 80,
  "L_TRIG": 0,
  "U_DPAD": 0,
  "D_DPAD": 0
}

Testing

An example server is included in /test/server.py. This file is a minimal example that allows you to hard code the joystick input. This example is intended to be extracted into a program that determines the appropriate input somehow.

Future Work / Ideas

  • controller.c could be refactored into smaller functions
  • I'm sure my c code can be optimized and improved
  • This plugin might be useful for implementing network play with mupen64plus

Contributing

Open a PR! I'm friendly I promise :)