Skip to content

Commit

Permalink
Updated README.md,: added tutorial, fixed typos (#106)
Browse files Browse the repository at this point in the history
  • Loading branch information
MatPoliquin authored Jan 15, 2024
1 parent af2ae7f commit 79e12cb
Showing 1 changed file with 13 additions and 5 deletions.
18 changes: 13 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,16 +119,16 @@ cd retro/examples
python3 ppo.py --game='Airstriker-Genesis'
```

Additional examples:
More advanced examples:
[https://github.com/MatPoliquin/stable-retro-scripts](https://github.com/MatPoliquin/stable-retro-scripts)

## Citation

```
@misc{stable-retro,
author = {Mathieu and Poliquin},
title = {Stable Retro, a fork of OpenAI's gym-retro},
year = {2023},
author = {Poliquin, Mathieu},
title = {Stable Retro, a maintained fork of OpenAI's gym-retro},
year = {2024},
publisher = {GitHub},
journal = {GitHub repository},
howpublished = {\url{https://github.com/Farama-Foundation/stable-retro}},
Expand All @@ -137,6 +137,9 @@ Additional examples:

## Tutorials

Windows WSL2 + Ubuntu 22.04 setup guide:
https://www.youtube.com/watch?v=vPnJiUR21Og

Game Integration tool:
https://www.youtube.com/playlist?list=PLmwlWbdWpZVvWqzOxu0jVBy-CaRpYha0t

Expand All @@ -158,7 +161,7 @@ Plateforms:
- macOS 10.13 (High Sierra), 10.14 (Mojave)
- Linux (manylinux1)

CPU with `SSSE3` or better
CPU with `SSE3` or better

Supported Pythons: 3.7 to 3.12

Expand All @@ -174,6 +177,11 @@ Each game integration has files listing memory locations for in-game variables,

Please note that ROMs are not included and you must obtain them yourself. Most ROM hashes are sourced from their respective No-Intro SHA-1 sums.

Run this script in the roms folder you want to import. If the checksum matches it will import them in the related game folder in stable-retro.
```bash
python3 -m retro.import .
```

The following non-commercial ROMs are included with Stable Retro for testing purposes:

- [the 128 sine-dot](http://www.pouet.net/prod.php?which=2762) by Anthrox
Expand Down

0 comments on commit 79e12cb

Please sign in to comment.