Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jessetg/libretro.py
A Python binding for libretro. Intended for writing test scripts for cores, but can be used for any purpose.
https://github.com/jessetg/libretro.py
ctypes emulation emulator libretro libretro-api libretro-cores libretro-frontend retro retroarch retrocomputing retrogaming test-automation testing testing-tools
Last synced: about 5 hours ago
JSON representation
A Python binding for libretro. Intended for writing test scripts for cores, but can be used for any purpose.
- Host: GitHub
- URL: https://github.com/jessetg/libretro.py
- Owner: JesseTG
- License: mit
- Created: 2023-10-23T03:49:19.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-24T00:08:17.000Z (22 days ago)
- Last Synced: 2024-10-24T13:53:17.178Z (21 days ago)
- Topics: ctypes, emulation, emulator, libretro, libretro-api, libretro-cores, libretro-frontend, retro, retroarch, retrocomputing, retrogaming, test-automation, testing, testing-tools
- Language: Python
- Homepage:
- Size: 1.11 MB
- Stars: 8
- Watchers: 2
- Forks: 3
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# libretro.py
A Python binding for [libretro][libretro] intended for testing cores,
but suitable for any purpose.
Ease of use, flexibility, and complete API support are top priorities.
[](https://github.com/JesseTG/libretro.py/actions/workflows/release.yml)
[](https://pypi.org/project/libretro.py)
[](LICENSE)
# Supported Environments
libretro.py has the following requirements:
- Python 3.11 or newer.
May not work on alternative Python implementations like PyPy.
- Supported on Windows, macOS, and Linux.
May work on other platforms, but no promises.
Nothing else is required for most functionality,
but some [extra features](#extras) have additional dependencies or constraints.
If contributing then [`just`][just] is optional but recommended,
as it will simplify most development tasks.
For details, run `just` (no arguments) in the project root.
# Installing
libretro.py supports **Python 3.11 or newer**.
Nothing else is required for most functionality,
but some extra features have additional dependencies.
You can install libretro.py with `pip` like so:
```bash
# Install the base libretro.py
pip install libretro.py
```
Using a virtual environment is recommended:
```bash
# Create a virtual environment
python -m venv ./venv
# Activate the virtual environment (in Bash)
source ./venv/bin/activate
# Activate the virtual environment (in PowerShell)
./venv/Scripts/activate.ps1
```
Or if you have [`just`][just] installed, let it figure out the details for you:
```bash
just venv
```
## Extras
To install additional features,
add one or more of the following extras to the `install` command:
- **`cli`:** Test scripts that don't rely on the nuances of any particular core.
Use these to simplify your own core's test process.
- **`dev`:** Assorted tools used to help develop libretro.py.
Required if contributing to libretro.py.
- **`opengl`:** Support for the built-in OpenGL video driver.
Required if testing a core's OpenGL support.
- **`opengl-window`:** Same as the `opengl` extra,
but with support for opening an actual window.
Can help simplify some debugging tasks,
e.g. RenderDoc usage.
For example, if you want to submit an improvement to the OpenGL video driver,
you would install libretro.py like so:
```bash
pip install libretro.py[opengl,dev]
```
And if you just want to test your libretro core's OpenGL support:
```bash
pip install libretro.py[opengl]
```
Some of these extras have additional dependencies.
### OpenGL
If using OpenGL support on Linux,
you may need to install the `libopengl0` package.
[just]: https://just.systems
[libretro]: https://www.libretro.com