jaller94 / matrix-plays-pokemon

Control the mgba emulator via Matrix chat

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Matrix Plays Pokémon

Similar to Twitch Plays Pokémon this lets the members of a Matrix chat room control an mGBA emulator.

Features

  • Write A, B, Up, Left, Right, Down, Start or Select into the chat for the button to be pressed.
  • Write screenshot into the chat to receive a screenshot.
  • It's not limited to Pokémon games. All GameBoy and GameBoy Advance games can be controlled.
    • For the supported Pokémon games, the party information (names, levels, HP) is send to Matrix.
  • There's no limit on how many Matrix users can control the emulator at once.
  • Currently, only "anarchy" mode is implemented. Everyone's input gets pressed.
  • The GameBoy Advance's sholder buttons L and R aren't implemented.

Pokémon ROMs with party info support

  • Pokémon Red, Blue, Yellow (US)
  • Pokémon Gold, Silver, Crystal (US)
  • Pokémon Ruby, Saphir (US)

Requirements

  • mGBA 0.10.0 or newer
    • Must support Lua scripts
  • NodeJS

Setup

  1. In matrix-bot/config, rename config.sample.json to config.json and edit it with a text editor.
  2. Run cd matrix-bot && npm install && cd - to install code dependencies.
  3. For screenshots to work, edit the file path in matrix-plays-pokemon.lua to the folder matrix-bot/emulator-data.

Run it

  1. Launch mGBA and load a Pokémon ROM.
  2. Load the lua script.
  3. Launch the Matrix bot: cd matrix-bot && npm run start && cd -

License

MLP-2.0 to match the license of mGBA.

About

Control the mgba emulator via Matrix chat

License:Mozilla Public License 2.0


Languages

Language:Lua 83.3%Language:TypeScript 16.2%Language:Dockerfile 0.5%