# Sonic Retro

<div align="left"><figure><img src="https://raw.githubusercontent.com/fabricecaruso/es-theme-carbon/5e8d8070cabfa15865e3d2a2b873bb55ec1e1768/art/logos/sonicretro.svg" alt=""><figcaption></figcaption></figure></div>

Game engine to play Sonic 1, Sonic 2 and Sonic CD.

{% embed url="<https://github.com/Rubberduckycooly/Sonic-1-2-2013-Decompilation>" %}

{% embed url="<https://github.com/Rubberduckycooly/Sonic-CD-11-Decompilation>" %}

## Information

<table data-header-hidden><thead><tr><th width="240"></th><th></th></tr></thead><tbody><tr><td><strong>Emulators</strong></td><td><ul><li>sonicretro</li><li>sonicretrocd</li></ul></td></tr><tr><td><strong>File folder</strong></td><td><span data-gb-custom-inline data-tag="emoji" data-code="1f4c2">📂</span> roms \ <span data-gb-custom-inline data-tag="emoji" data-code="1f4c2">📂</span> sonicretro</td></tr><tr><td><strong>File extension</strong></td><td>.rsdk</td></tr><tr><td><strong>Saves location</strong></td><td><em>rom folder</em><br>Copied to <em>saves\sonicretro\&#x3C;game folder></em></td></tr></tbody></table>

## BIOS

No BIOS required.

## Controls

To be added.

## System Features

### Game files organization

The engine requires the "Data.rsdk" from the different games.

The folder organization is the following:

```
└── roms\
    └── sonicretro\
        ├── sonic1\
        │   └── Data.rsdk
        └── sonic2\
        │   └── Data.rsdk
        └── soniccd\
        │   └── Data.rsdk
```

The files can be retrieved from multiple sources.

#### Sonic 1 and 2:

* Windows
  * Via Steam, from [Sonic Origins](https://store.steampowered.com/app/1794960)
  * Via the Epic Games Store, from [Sonic Origins](https://store.epicgames.com/en-US/p/sonic-origins)
* iOS
  * [Sonic 1, Via the App Store](https://apps.apple.com/au/app/sonic-the-hedgehog-classic/id316050001)
  * [Sonic 2, Via the App Store](https://apps.apple.com/au/app/sonic-the-hedgehog-2-classic/id347415188)
  * A tutorial for finding the game assets from the iOS versions can be found [here](https://gamebanana.com/tuts/14491).
* Android
  * [Sonic 1, Via Google Play](https://play.google.com/store/apps/details?id=com.sega.sonic1px)
  * [Sonic 2, Via Google Play](https://play.google.com/store/apps/details?id=com.sega.sonic2.runner)
  * [Sonic 1, Via Amazon](https://www.amazon.com.au/Sega-of-America-Sonic-Hedgehog/dp/B00D74DVKM)
  * [Sonic 2, Via Amazon](https://www.amazon.com.au/Sega-of-America-Sonic-Hedgehog/dp/B00HAPRVWS)
  * A tutorial for finding the game assets from the Android versions can be found [here](https://gamebanana.com/tuts/14492).

#### Sonic CD:

* Windows
  * Via Steam, whether it's the original release or from [Sonic Origins](https://store.steampowered.com/app/1794960)
  * Via the Epic Games Store, from [Sonic Origins](https://store.epicgames.com/en-US/p/sonic-origins)
* [iOS (Via the App Store)](https://apps.apple.com/us/app/sonic-cd-classic/id454316134)
  * A tutorial for finding the game assets from the iOS version can be found [here](https://gamebanana.com/tuts/14491).
* Android
  * [Via Google Play](https://play.google.com/store/apps/details?id=com.sega.soniccd.classic)
  * [Via Amazon](https://www.amazon.com/Sega-of-America-Sonic-CD/dp/B008K9UZY4/)
  * A tutorial for finding the game assets from the Android version can be found [here](https://gamebanana.com/tuts/14942).
