booplaysgba/README.md

B00 plays GBA

B00 plays GBA is an interactive emulator made to entertain people during waiting phases, such as during TVn7 pre-shows.

Built with

Technologies

• Python
• mGBA
• Redis
• Websockets
• Nginx-RTMP
• FFmpeg

Tools

• Poetry
• Docker
• Kubernetes
• Docker-slim
• AGB-buttontest

VSCode

• ms-python
• Python Docstring Generator
• Conventional Commits
• Remote container
• EditorConfig
• Kubernetes
• Prettier
• Docker

Getting started

Installation

Clone the repository :

git clone git@git.inpt.fr:fainsil/booplaysgba.git --recursive

Build the mGBA python bindings:

cd booplaysgba
mkdir mgba/build
cd mgba/build
cmake -DBUILD_PYTHON=ON -DBUILD_QT=OFF -DBUILD_SDL=OFF -DUSE_DISCORD_RPC=OFF ..
make

Install the dependencies :

cd ../..
poetry run pip install --upgrade pip
BINDIR=`pwd`/mgba/build/ LIBDIR=`pwd`/mgba/build/ poetry install

Usage

To run locally the server :

python3 src/server.py

To run locally the emulator :

python3 src/emulator.py

Contributing

This repository is under the Contributing Covenant code of conduct.
See CONTRIBUTING.md for more information.
Please use conventional commits.

License

Distributed under the MIT license. See LICENSE for more information.

Contact

Laurent Fainsin <laurentfainsin@protonmail.com>