Toggle menu
Toggle preferences menu
Toggle personal menu
Not logged in
Your IP address will be publicly visible if you make any edits.

3DS:Sonic Decompilations: Difference between revisions

From Hacks Guide Wiki
(Replace S1F & S2A tutorials with general mod install tutorials, add notes for Origins Datafiles and script mods)
m (fix step ordering)
 
Line 48: Line 48:


== What you need ==
== What you need ==
*[https://gamebanana.com/games/6108 A mod from the Sonic CD GameBanana page that contains no Scripts folder]
*[https://gamebanana.com/games/6620 A mod from the Sonic 1 GameBanana page that contains no Scripts folder]
== Instructions ==
== Instructions ==
===Section I - Prep Work===
===Section I - Prep Work===
#Power off your console
<ol>
#Insert your SD card into your computer
<li>Power off your console</li>
#Navigate to <code>/3ds/Sonic1/</code>, then create a folder named <code>mods</code> if it doesn't already exist
<li>Insert your SD card into your computer</li>
#Extract your mods <code>.zip</code> file and copy the folder to <code>/3ds/Sonic1/mods/</code>
<li>Navigate to <code>/3ds/Sonic1/</code>, then create a folder named <code>mods</code> if it doesn't already exist</li>
*Your mod folder should look like this
<li>Extract your mods <code>.zip</code> file and copy the folder to <code>/3ds/Sonic1/mods/</code></li>
<ul>
<li>Your mod folder should look like this
{{Tree list}}
{{Tree list}}
* [[File:Gnome-media-flash.svg|20px|link=]] (root)
* [[File:Gnome-media-flash.svg|20px|link=]] (root)
Line 64: Line 66:
****** [[File:Icons8 flat opened folder.svg|20px|link=]] Data
****** [[File:Icons8 flat opened folder.svg|20px|link=]] Data
****** [[File:Icons8 flat file.svg|20px|link=]] mod.ini
****** [[File:Icons8 flat file.svg|20px|link=]] mod.ini
{{Tree list/end}}
{{Tree list/end}}</li></ul>
#Reinsert your SD card into your console
<li>Reinsert your SD card into your console</li>
#Power on your console
<li>Power on your console</li>
</ol>
=== Section II - Loading the mod ===
=== Section II - Loading the mod ===
#Launch Sonic 1 from the HOME Menu
#Launch Sonic 1 from the HOME Menu
Line 121: Line 124:
== Instructions ==
== Instructions ==
===Section I - Prep Work===
===Section I - Prep Work===
#Power off your console
<ol>
#Insert your SD card into your computer
<li>Power off your console
#Navigate to <code>/3ds/SonicCD/</code>, then create a folder named <code>mods</code> if it doesn't already exist
<li>Insert your SD card into your computer
#Extract your mods <code>.zip</code> file and copy the folder to <code>/3ds/SonicCD/mods/</code>
<li>Navigate to <code>/3ds/SonicCD/</code>, then create a folder named <code>mods</code> if it doesn't already exist
*Your mod folder should look like this
<li>Extract your mods <code>.zip</code> file and copy the folder to <code>/3ds/SonicCD/mods/</code>
<ul>
<li>Your mod folder should look like this
{{Tree list}}
{{Tree list}}
* [[File:Gnome-media-flash.svg|20px|link=]] (root)
* [[File:Gnome-media-flash.svg|20px|link=]] (root)
Line 135: Line 140:
****** [[File:Icons8 flat file.svg|20px|link=]] mod.ini
****** [[File:Icons8 flat file.svg|20px|link=]] mod.ini
{{Tree list/end}}
{{Tree list/end}}
#In <code>/3ds/SonicCD/</code>, open settings.ini
</li></ul>
*If settings.ini does not exist, launch the game first.
<li>In <code>/3ds/SonicCD/</code>, open settings.ini
#Set <code>DevMenu</code> to true
<ul>
*This will allow you have access to enable mods from the game itself instead of editing <code>modconfig.ini</code> manually
<li>If settings.ini does not exist, launch the game first.</li></ul>
#Reinsert your SD card into your console
<li>Set <code>DevMenu</code> to true
#Power on your console
<ul>
<li>This will allow you have access to enable mods from the game itself instead of editing <code>modconfig.ini</code> manually</li></ul>
<li>Reinsert your SD card into your console
<li>Power on your console
</ol>
=== Section II - Loading the mod ===
=== Section II - Loading the mod ===
#Launch Sonic CD from the HOME Menu
#Launch Sonic CD from the HOME Menu
Line 193: Line 202:
== Instructions ==
== Instructions ==
===Section I - Prep Work===
===Section I - Prep Work===
#Power off your console
<ol>
#Insert your SD card into your computer
<li>Power off your console</li>
#Navigate to <code>/3ds/Sonic2/</code>, then create a folder named <code>mods</code> if it doesn't already exist
<li>Insert your SD card into your computer</li>
#Extract your mods <code>.zip</code> file and copy the folder to <code>/3ds/Sonic2/mods/</code>
<li>Navigate to <code>/3ds/Sonic2/</code>, then create a folder named <code>mods</code> if it doesn't already exist</li>
*Your mod folder should look like this
<li>Extract your mods <code>.zip</code> file and copy the folder to <code>/3ds/Sonic2/mods/</code></li>
<ul>
<li>Your mod folder should look like this
{{Tree list}}
{{Tree list}}
* [[File:Gnome-media-flash.svg|20px|link=]] (root)
* [[File:Gnome-media-flash.svg|20px|link=]] (root)
Line 206: Line 217:
****** [[File:Icons8 flat opened folder.svg|20px|link=]] Data
****** [[File:Icons8 flat opened folder.svg|20px|link=]] Data
****** [[File:Icons8 flat file.svg|20px|link=]] mod.ini
****** [[File:Icons8 flat file.svg|20px|link=]] mod.ini
{{Tree list/end}}
{{Tree list/end}}</li></ul>
#Reinsert your SD card into your console
<li>Reinsert your SD card into your console</li>
#Power on your console
<li>Power on your console</li>
</ol>
=== Section II - Loading the mod ===
=== Section II - Loading the mod ===
#Launch Sonic 2 from the HOME Menu
#Launch Sonic 2 from the HOME Menu

Latest revision as of 14:58, 19 February 2025

This tutorial will take you through setting up the Sonic Decompilation 3DS ports.

Critical icon If you are on Old 3DS, then every game except Sonic CD will not work! and Special Stages will run poorly across all games on both Old & New 3DS.
Critical icon Due to these forks of the decompilations being heavily outdated, there are some things to note before starting

1. Data files from Sonic Origins will not work
2. Script mods for RSDKv3/RSDKv4 cannot be installed due to the decompiled scripts using an updated syntax, which these versions do not support

Technical Details (optional)

These ports are based on the decompilations by the RSDKModding group for the mobile versions of Sonic 1, Sonic CD, Sonic 2, and Sonic Mania.

They require a data.rsdk file from a legal copy of the game(s) to be able to run.


What you need

  • A data.rsdk file from the Mobile port
    • Tutorial can be found here.
  • The latest release of Sonic 1 (3DS) (Sonic1.cia)
    • If you have issues, try to use the rev01 version instead.

Instructions

Section I - Prep Work

  1. Power off your console
  2. Insert your SD card into your computer
  3. Create a folder named cias on the root of your SD card if it does not already exist
  4. Copy Sonic1.cia to the /cias/ folder on your SD card
  5. Create a folder named 3ds on the root of your SD card if it does not already exist
  6. Create a folder named Sonic1 in the 3ds folder on your SD card if it does not already exist
  7. Copy data.rsdk to the /3ds/Sonic1/ folder on your SD card
  8. Reinsert your SD card into your console
  9. Power on your console

Section II - Installation

  1. Launch FBI from the HOME Menu
  2. Navigate to SD -> cias
  3. Press A on Sonic 1, and select "Install and delete CIA"
  4. Once installed, press Home, then X to close FBI
Success icon You're done! You've successfully installed Sonic 1 on your console.

Optional - Installing mods

Info icon As said above, script mods will not work properly

What you need

Instructions

Section I - Prep Work

  1. Power off your console
  2. Insert your SD card into your computer
  3. Navigate to /3ds/Sonic1/, then create a folder named mods if it doesn't already exist
  4. Extract your mods .zip file and copy the folder to /3ds/Sonic1/mods/
    • Your mod folder should look like this
      • Gnome-media-flash.svg (root)
        • Icons8 flat opened folder.svg 3ds
          • Icons8 flat opened folder.svg Sonic1
            • Icons8 flat opened folder.svg mods
              • Icons8 flat opened folder.svg NameOfMod
                • Icons8 flat opened folder.svg Data
                • Icons8 flat file.svg mod.ini
  5. Reinsert your SD card into your console
  6. Power on your console

Section II - Loading the mod

  1. Launch Sonic 1 from the HOME Menu
  2. Press A on MODS
  3. Press A on on your mod to activate it
  4. Press B to exit the mods list
  5. Once the game has reloaded, start the game.
Success icon You're done! You've successfully installed a Sonic 1 mod on your console.

What you need

  • A data.rsdk file from either the Mobile port or the delisted Steam release
    • Mobile: Follow this tutorial.
    • PC: Browse the games local files via Steam (Right click the game on the sidebar -> Browse Local Files) and keep the directory open.
  • The latest release of Sonic CD (3DS) (the .cia file)
    • For old 3DS users, download the HW version
    • For new 3DS users, download the SW version

Instructions

Section I - Prep Work

  1. Power off your console
  2. Insert your SD card into your computer
  3. Create a folder named cias on the root of your SD card if it does not already exist
  4. Copy SonicCD.cia to the /cias/ folder on your SD card
  5. Create a folder named 3ds on the root of your SD card if it does not already exist
  6. Create a folder named SonicCD in the 3ds folder on your SD card if it does not already exist
  7. Copy data.rsdk to the /3ds/SonicCD/ folder on your SD card
  8. Reinsert your SD card into your console
  9. Power on your console

Section II - Installation

  1. Launch FBI from the HOME Menu
  2. Navigate to SD -> cias
  3. Press A on Sonic CD, and select "Install and delete CIA"
  4. Once installed, press Home, then X to close FBI
Success icon You're done! You've successfully installed Sonic CD on your console.

Optional - Installing mods

Info icon As said above, script mods will not work properly

What you need

Instructions

Section I - Prep Work

  1. Power off your console
  2. Insert your SD card into your computer
  3. Navigate to /3ds/SonicCD/, then create a folder named mods if it doesn't already exist
  4. Extract your mods .zip file and copy the folder to /3ds/SonicCD/mods/
    • Your mod folder should look like this
      • Gnome-media-flash.svg (root)
        • Icons8 flat opened folder.svg 3ds
          • Icons8 flat opened folder.svg SonicCD
            • Icons8 flat opened folder.svg mods
              • Icons8 flat opened folder.svg NameOfMod
                • Icons8 flat opened folder.svg Data
                • Icons8 flat file.svg mod.ini
  5. In /3ds/SonicCD/, open settings.ini
    • If settings.ini does not exist, launch the game first.
  6. Set DevMenu to true
    • This will allow you have access to enable mods from the game itself instead of editing modconfig.ini manually
  7. Reinsert your SD card into your console
  8. Power on your console

Section II - Loading the mod

  1. Launch Sonic CD from the HOME Menu
  2. Open the dev menu by pressing Select
  3. Press A on MODS
  4. Press A on on your mod to activate it
  5. Press B to exit the mods list
  6. Once the game has reloaded, start the game by pressing Start.
Success icon You're done! You've successfully installed a Sonic CD mod on your console.

What you need

  • A data.rsdk file from the Mobile port
    • Tutorial can be found here.
  • The latest release of Sonic 2 (3DS) (Sonic2.cia)
    • If you have issues, try to use the rev01 version instead.

Instructions

Section I - Prep Work

  1. Power off your console
  2. Insert your SD card into your computer
  3. Create a folder named cias on the root of your SD card if it does not already exist
  4. Copy Sonic2.cia to the /cias/ folder on your SD card
  5. Create a folder named 3ds on the root of your SD card if it does not already exist
  6. Create a folder named Sonic2 in the 3ds folder on your SD card if it does not already exist
  7. Copy data.rsdk to the /3ds/Sonic2/ folder on your SD card
  8. Reinsert your SD card into your console
  9. Power on your console

Section II - Installation

  1. Launch FBI from the HOME Menu
  2. Navigate to SD -> cias
  3. Press A on Sonic 2, and select "Install and delete CIA"
  4. Once installed, press Home, then X to close FBI
Success icon You're done! You've successfully installed Sonic 2 on your console.

Optional - Setting up mods

Info icon As said above, script mods will not work properly

What you need

Instructions

Section I - Prep Work

  1. Power off your console
  2. Insert your SD card into your computer
  3. Navigate to /3ds/Sonic2/, then create a folder named mods if it doesn't already exist
  4. Extract your mods .zip file and copy the folder to /3ds/Sonic2/mods/
    • Your mod folder should look like this
      • Gnome-media-flash.svg (root)
        • Icons8 flat opened folder.svg 3ds
          • Icons8 flat opened folder.svg Sonic2
            • Icons8 flat opened folder.svg mods
              • Icons8 flat opened folder.svg NameOfMod
                • Icons8 flat opened folder.svg Data
                • Icons8 flat file.svg mod.ini
  5. Reinsert your SD card into your console
  6. Power on your console

Section II - Loading the mod

  1. Launch Sonic 2 from the HOME Menu
  2. Press A on MODS
  3. Press A on on your mod to activate it
  4. Press B to exit the mods list
  5. Once the game has reloaded, start the game.
Success icon You're done! You've successfully installed a Sonic 2 mod on your console.

Warning icon If you want to access the Sonic Mania Plus DLC, then you must compile the port yourself.
Warning icon This port has no modding support.

What you need

  • A Data.rsdk file from any version of Sonic Mania you can obtain it from (i.e. PC, Nintendo Switch)
    • Switch: Dump the romfs with NXDumpTool, and copy the Data.rsdk to your PC.
    • PC (Steam): Browse the games local files via Steam (Right click the game on the sidebar -> Browse Local Files) and keep the directory open.
    • PC (Epic Games): Press the ... in your Library -> "Manage" -> press the folder icon, then keep the directory open.
  • The latest release of Sonic Mania (3DS) (the .cia file)
    • If you compiled the port, you can find the .cia you built in the cloned repository directory, then /dependencies/v5_3DS/3ds/out/

Instructions

Section I - Prep Work

  1. Power off your console
  2. Insert your SD card into your computer
  3. Create a folder named cias on the root of your SD card if it does not already exist
  4. Copy SonicMania.cia to the /cias/ folder on your SD card
  5. Create a folder named 3ds on the root of your SD card if it does not already exist
  6. Create a folder named SonicMania in the 3ds folder on your SD card if it does not already exist
  7. Copy Data.rsdk to the /3ds/SonicMania/ folder on your SD card
  8. Reinsert your SD card into your console
  9. Power on your console

Section II - Installation

  1. Launch FBI from the HOME Menu
  2. Navigate to SD -> cias
  3. Press A on Sonic Mania, and select "Install and delete CIA"
  4. Once installed, press Home, then X to close FBI
Success icon You're done! You've successfully installed Sonic Mania on your console.