2021-11-01 17:44:29 +00:00
|
|
|
# B00 plays GBA
|
|
|
|
|
|
|
|
|
|
## Built with
|
|
|
|
|
|
2021-11-05 12:53:08 +00:00
|
|
|
- [Python](https://www.python.org/)
|
|
|
|
|
- [mGBA](https://mgba.io/)
|
2021-11-01 17:44:29 +00:00
|
|
|
- [VS Code](https://code.visualstudio.com/)
|
|
|
|
|
- [Websockets](https://websockets.readthedocs.io/)
|
2021-11-03 20:46:19 +00:00
|
|
|
- [Redis](https://redis.io/)
|
2021-11-04 14:21:36 +00:00
|
|
|
- [Nginx-RTMP](https://hub.docker.com/r/tiangolo/nginx-rtmp/)
|
2021-11-05 12:53:08 +00:00
|
|
|
- [AGB-buttontest](https://github.com/heroldev/AGB-buttontest)
|
2021-11-01 17:44:29 +00:00
|
|
|
|
|
|
|
|
## Getting started
|
|
|
|
|
|
|
|
|
|
### Prerequisites
|
|
|
|
|
|
|
|
|
|
[Poetry](https://python-poetry.org/) should manage every dependencies for you. \
|
|
|
|
|
It is recommended to use [VS Code](https://code.visualstudio.com/) with these extensions :
|
|
|
|
|
|
|
|
|
|
- [ms-python](https://marketplace.visualstudio.com/items?itemName=ms-python.python)
|
2021-11-05 12:53:08 +00:00
|
|
|
- [EditorConfig](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig)
|
|
|
|
|
- [Python Docstring Generator](https://marketplace.visualstudio.com/items?itemName=njpwerner.autodocstring)
|
2021-11-01 17:44:29 +00:00
|
|
|
|
|
|
|
|
### Installation
|
|
|
|
|
|
|
|
|
|
Clone the repository :
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
git clone git@git.inpt.fr:fainsil/booplaysgba.git --recursive
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Build the mGBA python bindings:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
cd booplaysgba
|
|
|
|
|
mkdir mgba/build
|
|
|
|
|
cd mgba/build
|
2021-11-09 17:19:55 +00:00
|
|
|
cmake -DBUILD_PYTHON=ON -DBUILD_QT=OFF -DBUILD_SDL=OFF -DUSE_DISCORD_RPC=OFF ..
|
2021-11-01 17:44:29 +00:00
|
|
|
make
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Install the dependencies :
|
|
|
|
|
|
|
|
|
|
```bash
|
2021-11-09 17:19:55 +00:00
|
|
|
poetry run pip install --upgrade pip
|
|
|
|
|
BINDIR=`pwd`/mgba/build/ LIBDIR=`pwd`/mgba/build/ poetry install
|
2021-11-01 17:44:29 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Usage
|
|
|
|
|
|
|
|
|
|
To run locally the server :
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
python3 src/server.py
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
To run locally the emulator :
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
python3 src/emulator.py
|
|
|
|
|
```
|
|
|
|
|
|
2021-11-01 17:58:44 +00:00
|
|
|
To access the remote controller :
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
firefox src/client.py
|
|
|
|
|
```
|
|
|
|
|
|
2021-11-01 17:44:29 +00:00
|
|
|
## Contributing
|
|
|
|
|
|
|
|
|
|
This repository is under the [Contributing Covenant](https://www.contributor-covenant.org/) code of conduct.
|
|
|
|
|
See [`CONTRIBUTING.md`](https://git.inpt.fr/fainsil/booplaysgba/-/blob/master/CONTRIBUTING.md) for more information.\
|
|
|
|
|
Please use [conventional commits](https://www.conventionalcommits.org/).
|
|
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
|
|
|
|
|
Distributed under the [MIT](https://choosealicense.com/licenses/mit/) license.
|
|
|
|
|
See [`LICENSE`](https://git.inpt.fr/fainsil/booplaysgba/-/blob/master/LICENSE) for more information.
|
|
|
|
|
|
|
|
|
|
## Contact
|
|
|
|
|
|
|
|
|
|
Laurent Fainsin \<[laurentfainsin@protonmail.com](mailto:laurentfainsin@protonmail.com)\>
|
