booplaysgba/README.md
Laureηt dadc628abb
fix(README): bad links
feat(README): more extensions
2021-11-05 13:53:08 +01:00

2 KiB

B00 plays GBA

Built with

Getting started

Prerequisites

Poetry should manage every dependencies for you.
It is recommended to use VS Code with these extensions :

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 ..
make

Install the dependencies :

poetry install

Usage

To run locally the server :

python3 src/server.py

To run locally the emulator :

python3 src/emulator.py

To access the remote controller :

firefox src/client.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>