Sonic 1 and 2 3DS: Difference between revisions

Sonic 1 and 2
Sonic 1 and 2
General
Author	JeffRuLz
Type	Platform
Version	1.3
License	Mixed
Last Updated	2022/11/04
Links
	Download
	Website
	Source

Latest revision as of 01:59, 4 April 2024

This is a port of Sonic 1 and 2 to the 3DS, based on Rubberduckycooly's Sonic 1/2 (2013) decompilation. A New 3DS is required for these games to play smoothly.

Note: You will need the assets from the official releases to run this decompilation.

Installation

Release contains 3DSX and CIA builds.

3DSX - Place them in sd:/3ds/Sonic1/ and sd:/3ds/Sonic2/.
CIA - Install it with the CIA manager of your choice.
Rev01 - Use this versions only if you encounter problems with the regular versions.

Before you can play you need to extract the data.rsdk files from your copy of Sonic 1 and 2 (2013). Do this once for each game:

Rename the .apk file extension into a .zip.
Open it, and navigate go into the assets folder.
Extract the Data.rsdk.xmf file and rename it to Data.rsdk.
Place them in sd:/3ds/Sonic1/ and sd:/3ds/Sonic2/.

You can get the official release of Sonic 1 and Sonic 2 from:

Even if your platform isn't supported by the official releases, buy it for the assets (you don't need to run the official release, you just need the game assets).

If you want to transfer your save from the Android pre-forever versions, go to Android/data/com.sega.sonic1 or 2/SGame.bin and copy it to the SData.bin in the EXE folder.

Mods

Follow these steps if you want to use mods:

Download the decompiled scripts and place them in the game folders.
Create a mods folder inside of the game folders. Your mods go there.

Your Sonic1 folder should look something like this:

There are many outdated mods that do not work on v1.3.0. Make sure they work on the PC version before reporting they do not work on the 3DS port.

Some mods are simply missing a mod.ini file.
Other mods are based on outdated scripts and need a lot more work to fix.

Some mods need to be loaded before others. Edit the mods/modconfig.ini file to change the order mods are loaded in. Mods higher on the list will have higher priority.

Lastly, not all mods are compatible with each other. Remember your modding common sense.

User guide

3DS specific features

Added a built in script compiler, similar to CD, but tweaked up to match the new syntax for the scripts used in RSDKv4.
There is now a settings.ini file that the game uses to load all settings, similar to Sonic Mania.
Dev menu can now be accessed from anywhere by pressing the ESC key if enabled in the config.
The f12 pause, f11 step over & fast forward debug features from sonic mania have all be ported and are enabled if devMenu is enabled in the config.
If devMenu is enabled in the config, pressing f10 will activate a palette overlay that shows the game's 8 internal palettes in real time.

Limitations

A New 3DS is required. It does not run (well) on an old 3DS.
These do not feature the fancy 3D menus.
The Sonic 2 special stages run at a low frame rate.
It does not support the data files from Sonic Origins.
Load times are a bit slow. Most notably, the Sonic 1 credits scene will go out of sync.
There are no multiplayer or networking features.
There is no 3D effect of any kind.

FAQ

Q. The screen is tearing, how do I fix it?

Try turning on vsync.

Q. I found a bug/I have a feature request!

Submit an issue in the issues tab.

Q. Is there a port of the Sonic CD (2011) decompilation?

Yes! You can check out SaturnSH2x2's port.

Screenshots

Media

Sonic 1 and 2 (Genesis) - Longplay (Amy Rose Longplays)

Compatibility

On a New 3DS they run at full speed almost all of the time outside of special stages. Special stages are playable, but run at a low frame rate.

On an old 3DS the games are too slow to be enjoyable.

Changelog

v1.3

Now based on RSDKv4 version 1.3.0.
Mods can now be used.
REV01 builds are now provided.
- Adds compatibility for certain data files.
- Only use if you're having issues with the normal builds.
Audio processing is now done in a separate thread on a separate core.
Performance boost to special stages, due to the new audio thread.
- Sonic 1 special stages run at 30-60fps.
- Sonic 2 special stages run 15-30fps.
Added warning screens for some common user errors.
Hotfix October 9th: Fixed a bug that prevented multiple mods from loading.
October 11th: Debug text is no longer displayed when debug mode is disabled. (Except for specific situations.)
November 4th: Fixed game options not working properly (Thanks to @MegAmi24)

v1.1.1.2

Button mapping in 'settings.ini' now works (important: if you're updating from an older version you must delete your old 'settings.ini' file otherwise inputs may not work.)
The bottom screen can be used if 'ScreenWidth' is set to 320.

v1.1.1.1

Fixed data folder mode not working with cia builds.
Added music and sound to the main menu.

v1.1.1

Merged changes from the v1.1.1 update from the main project.
Optimized screen drawing thanks to @hax0kartik. Gives a slight performance boost in special stages.
Disabled the useless touch screen buttons from the main menu.
The select button can now pause the game.

v1.0

First release of this 3DS port, based on v1.1.0 of the main project.
A New 3DS is required for these games to play smoothly.

Credits

RMGRich.
Everyone in the Retro Engine Modding Server.

External links

@@ Line 4: / Line 4: @@
 |description=Sonic 1 & 2 (2013) port for New 3DS.
 |author=JeffRuLz
-|lastupdated=2021/02/13
+|lastupdated=2022/11/04
 |type=Platform
-|version=1.1.1.2
+|version=1.3
 |license=Mixed
-|download=https://dlhb.gamebrew.org/3dshomebrews/sonic1and2.7z
+|download=https://dlhb.gamebrew.org/3dshomebrews/sonic1and2.7z?k33p0fil35
 |website=https://github.com/JeffRuLz/Sonic-1-2-2013-Decompilation
 |source=https://github.com/JeffRuLz/Sonic-1-2-2013-Decompilation
@@ Line 20: / Line 20: @@
 * 3DSX - Place them in sd:/3ds/Sonic1/ and sd:/3ds/Sonic2/.
 * CIA - Install it with the CIA manager of your choice.
+* Rev01 - Use this versions only if you encounter problems with the regular versions.
 Before you can play you need to extract the data.rsdk files from your copy of Sonic 1 and 2 (2013). Do this once for each game:
@@ Line 38: / Line 39: @@
 If you want to transfer your save from the Android pre-forever versions, go to <code>Android/data/com.sega.sonic1 or 2/SGame.bin</code> and copy it to the <code>SData.bin</code> in the EXE folder.
+===Mods===
+Follow these steps if you want to use mods:
+* Download the [https://github.com/Rubberduckycooly/Sonic-1-Sonic-2-2013-Script-Decompilation decompiled scripts] and place them in the game folders.
+* Create a mods folder inside of the game folders. Your mods go there.
+Your Sonic1 folder should look something like this:
+https://dlhb.gamebrew.org/3dshomebrews/sonic1and2folder.png
+There are many outdated mods that do not work on v1.3.0. Make sure they work on the PC version before reporting they do not work on the 3DS port.
+* Some mods are simply missing a mod.ini file.
+* Other mods are based on outdated scripts and need a lot more work to fix.
+Some mods need to be loaded before others. Edit the mods/modconfig.ini file to change the order mods are loaded in. Mods higher on the list will have higher priority.
+Lastly, not all mods are compatible with each other. Remember your modding common sense.
 ==User guide==
-===Additional Tweaks===
+===3DS specific features===
 * Added a built in script compiler, similar to CD, but tweaked up to match the new syntax for the scripts used in RSDKv4.
 * There is now a <code>settings.ini</code> file that the game uses to load all settings, similar to Sonic Mania.
@@ Line 46: / Line 64: @@
 * The <code>f12</code> pause, <code>f11</code> step over & fast forward debug features from sonic mania have all be ported and are enabled if devMenu is enabled in the config.
 * If <code>devMenu</code> is enabled in the config, pressing <code>f10</code> will activate a palette overlay that shows the game's 8 internal palettes in real time.
+===Limitations===
+* A New 3DS is required. It does not run (well) on an old 3DS.
+* These do not feature the fancy 3D menus.
+* The Sonic 2 special stages run at a low frame rate.
+* It does not support the data files from Sonic Origins.
+* Load times are a bit slow. Most notably, the Sonic 1 credits scene will go out of sync.
+* There are no multiplayer or networking features.
+* There is no 3D effect of any kind.
 ===FAQ===
@@ Line 65: / Line 92: @@
 ==Media==
-'''Tutorial on how to find your legally obtained Data.rsdk''' ([https://www.youtube.com/watch?v=gzIfRW91IxE Axanery]) <br>
-<youtube>gzIfRW91IxE</youtube>
 '''Sonic 1 and 2 (Genesis) - Longplay''' ([https://www.youtube.com/watch?v=hfAmktT3hXI Amy Rose Longplays]) <br>
 <youtube>hfAmktT3hXI</youtube>
@@ Line 77: / Line 101: @@
 ==Changelog==
+'''v1.3'''
+* Now based on RSDKv4 version 1.3.0.
+* Mods can now be used.
+* REV01 builds are now provided.
+** Adds compatibility for certain data files.
+** Only use if you're having issues with the normal builds.
+* Audio processing is now done in a separate thread on a separate core.
+* Performance boost to special stages, due to the new audio thread.
+** Sonic 1 special stages run at 30-60fps.
+** Sonic 2 special stages run 15-30fps.
+* Added warning screens for some common user errors.
+* Hotfix October 9th: Fixed a bug that prevented multiple mods from loading.
+*October 11th: Debug text is no longer displayed when debug mode is disabled. (Except for specific situations.)
+*November 4th: Fixed game options not working properly (Thanks to @MegAmi24)
 '''v1.1.1.2'''
 * Button mapping in 'settings.ini' now works (important: if you're updating from an older version you must delete your old 'settings.ini' file otherwise inputs may not work.)