DIAMBRA™ Arena. Built with OpenAI Gym Python interface, easy to use, transforms popular video games into Reinforcement Learning environments
Linkedin • Discord • Twitch • YouTube • Twitter
DIAMBRA Arena is a software package featuring a collection of high-quality environments for Reinforcement Learning research and experimentation. It provides a standard interface to popular arcade emulated video games, offering a Python API fully compliant with OpenAI Gym/Gymnasium format, that makes its adoption smooth and straightforward.
It supports all major Operating Systems (Linux, Windows and MacOS) and can be easily installed via Python PIP, as described in the installation section below. It is completely free to use, the user only needs to register on the official website.
In addition, it comes with a comprehensive documentation, and this repository provides a collection of examples covering main use cases of interest that can be run in just a few steps.
All environments are episodic Reinforcement Learning tasks, with discrete actions (gamepad buttons) and observations composed by screen pixels plus specific RAM states (like characters health bars or characters stage side).
They all support both single player (1P) as well as two players (2P) mode, making them the perfect resource to explore all the following Reinforcement Learning subfields:
 |  |  |  |  |  |
|---|---|---|---|---|---|
| Standard RL | Competitive Multi-Agent | Competitive Human-Agent | Self-Play | Imitation Learning | Human-in-the-Loop |
Interfaced games have been selected among the most popular fighting retro-games. While sharing the same fundamental mechanics, they provide slightly different challenges, with specific features such as different type and number of characters, how to perform combos, health bars recharging, etc.
Whenever possible, games are released with all hidden/bonus characters unlocked.
Additional details can be found in the dedicated section of our Documentation.
 |  |  |  |  |  |
|---|---|---|---|---|---|
| Dead Or Alive ++ | Street Fighter III 3rd Strike | Tekken Tag Tournament | Ultimate Mortal Kombat 3 | Samurai Showdown 5 Special | The King of Fighers '98 Ultimate Match Hero |
 |  |  |
|---|---|---|
| Marvel VS Capcom | X-Men VS Street Fighter | Soul Calibur |
Many more are coming soon...
Our competition platform allows you to submit your agents and compete with other coders around the globe in epic video games tournaments!
It features a public global leaderboard where users are ranked by the best score achieved by their agents in our different environments.
It also offers you the possibility to unlock cool achievements depending on the performances of your agent.
Submitted agents are evaluated and their episodes are streamed on our Twitch channel.
We aimed at making the submission process as smooth as possible, join us and try it now!
Create an account on our website, it requires just a few clicks and is 100% free
Install DIAMBRA Command Line Interface: python3 -m pip install diambra
Install DIAMBRA Arena: python3 -m pip install diambra-arena
Using a virtual environment to isolate your python packages installation is strongly suggested
DIAMBRA Arena usage follows the standard RL interaction framework: the agent sends an action to the environment, which process it and performs a transition accordingly, from the starting state to the new state, returning the observation and the reward to the agent to close the interaction loop. The figure below shows this typical interaction scheme and data flow.
Check out available games:
diambra arena list-roms
Output extract:
[...]
Title: Dead Or Alive ++ - GameId: doapp
Difficulty levels: Min 1 - Max 4
SHA256 sum: d95855c7d8596a90f0b8ca15725686567d767a9a3f93a8896b489a160e705c4e
Original ROM name: doapp.zip
Search keywords: ['DEAD OR ALIVE ++ [JAPAN]', 'dead-or-alive-japan', '80781', 'wowroms']
Characters list: ['Kasumi', 'Zack', 'Hayabusa', 'Bayman', 'Lei-Fang', 'Raidou', 'Gen-Fu', 'Tina', 'Bass', 'Jann-Lee', 'Ayane']
[...]
Search ROMs on the web using Search Keywords provided by the game list command reported above. Pay attention, follow game-specific notes reported there, and store all ROMs in the same folder, whose absolute path will be referred in the following as your/roms/local/path.
Specific game ROM files are required, check validity of the downloaded ROMs:
diambra arena check-roms your/roms/local/path/romFileName.zip
The output for a valid ROM file would look like:
Correct ROM file for Dead Or Alive ++, sha256 = d95855c7d8596a90f0b8ca15725686567d767a9a3f93a8896b489a160e705c4e
Make sure to check out our Terms of Use, and in particular Section 7. By using the software, you accept them in full.
Running a complete episode with a random agent requires about 10 python lines:
import diambra.arena
env = diambra.arena.make("doapp", render_mode="human")
observation, info = env.reset(seed=42)
while True:
env.render()
actions = env.action_space.sample()
observation, reward, terminated, truncated, info = env.step(actions)
if terminated or truncated:
observation, info = env.reset()
break
env.close()
To execute the script run:
diambra run -r your/roms/local/path python script.py
Additional details and use cases are provided in the Getting Started section of the documentation.
The examples/ folder contains ready to use scripts representing the most important use-cases, in particular:
These examples show how to leverage both single and two players modes, how to set up environment wrappers specifying all their options, how to record human expert demonstrations and how to load them to apply imitation learning. They can be used as templates and starting points to explore all the features of the software package.
DIAMBRA Arena is built to maximize compatibility will all major Reinforcement Learning libraries. It natively provides interfaces with the two most import packages: Stable Baselines 3 and Ray RLlib, while Stable Baselines is also available but deprecated. Their usage is illustrated in detail in the documentation and in the DIAMBRA Agents repository. It can easily be interfaced with any other package in a similar way.
Native interfaces, installed with the specific options listed below, are tested with the following versions:
pip install diambra-arena[stable-baselines3] (Docs - GitHub - Pypi): 2.1.*pip install diambra-arena[ray-rllib] (Docs - GitHub - Pypi): 2.7.*pip install diambra-arena[stable-baselines] (Docs - GitHub - Pypi): 2.10.2To receive support, use the dedicated channel in our Discord Server.
To request features or report bugs, use the GitHub Issue Tracker.
Paper: https://arxiv.org/abs/2210.10595
@article{Palmas22,
author = {{Palmas}, Alessandro},
title = "{DIAMBRA Arena: a New Reinforcement Learning Platform for Research and Experimentation}",
journal = {arXiv e-prints},
keywords = {reinforcement learning, transfer learning, multi-agent, games},
year = 2022,
month = oct,
eid = {arXiv:2210.10595},
pages = {arXiv:2210.10595},
archivePrefix = {arXiv},
eprint = {2210.10595},
primaryClass = {cs.AI}
}
DIAMBRA Arena software package is subject to our Terms of Use. By using it, you accept them in full.
FAQs
DIAMBRA™ Arena. Built with OpenAI Gym Python interface, easy to use, transforms popular video games into Reinforcement Learning environments
We found that diambra-arena demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.