|
|
| (3 intermediate revisions by 3 users not shown) |
| Line 1: |
Line 1: |
| This tutorial will take you through setting up the Sonic Decompilation 3DS ports. | | This tutorial will take you through setting up the Sonic Decompilation 3DS ports. |
| {{critical|text=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|text=If you are on Old 3DS, then every game except Sonic CD will not work! Special Stages will run poorly across all games on both Old & New 3DS.}} |
| {{critical|text=Due to these forks of the decompilations being heavily outdated, there are some things to note before starting<br><br>1. Data files from Sonic Origins will not work<br>2. Script mods for RSDKv3/RSDKv4 cannot be installed due to the decompiled scripts using an updated syntax, which these versions do not support}} | | {{critical|text=Due to these forks of the decompilations being heavily outdated, there are some things to note before starting: |
| | * Data files from Sonic Origins will not work |
| | * 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) === | | === Technical Details (optional) === |
| These ports are based on the decompilations by the {{GitHub|RSDKModding}} group for the mobile versions of Sonic 1, Sonic CD, Sonic 2, and Sonic Mania. | | These ports are based on the decompilations by the {{GitHub|RSDKModding}} group for the mobile versions of Sonic 1, Sonic CD, Sonic 2, and Sonic Mania. |
| Line 7: |
Line 9: |
| They require a <code>data.rsdk</code> file from a legal copy of the game(s) to be able to run. | | They require a <code>data.rsdk</code> file from a legal copy of the game(s) to be able to run. |
|
| |
|
| </noinclude>
| |
| <tabber> | | <tabber> |
| |-|Sonic 1 (2013)= | | |-|Sonic 1 (2013)= |
| Line 55: |
Line 56: |
| <li>Insert your SD card into your computer</li> | | <li>Insert your SD card into your computer</li> |
| <li>Navigate to <code>/3ds/Sonic1/</code>, then create a folder named <code>mods</code> if it doesn't already exist</li> | | <li>Navigate to <code>/3ds/Sonic1/</code>, then create a folder named <code>mods</code> if it doesn't already exist</li> |
| <li>Extract your mods <code>.zip</code> file and copy the folder to <code>/3ds/Sonic1/mods/</code></li> | | <li>Extract your mods <code>.zip</code> file and copy the folder to <code>/3ds/Sonic1/mods/</code> |
| <ul> | | <ul> |
| <li>Your mod folder should look like this | | <li>Your mod folder should look like this</li> |
| {{Tree list}} | | {{Tree list}} |
| * [[File:Gnome-media-flash.svg|20px|link=]] (root) | | * [[File:Gnome-media-flash.svg|20px|link=]] (root) |
| Line 66: |
Line 67: |
| ****** [[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}}</li></ul> | | {{Tree list/end}}</ul></li> |
| <li>Reinsert your SD card into your console</li> | | <li>Reinsert your SD card into your console</li> |
| <li>Power on your console</li> | | <li>Power on your console</li> |
| Line 78: |
Line 79: |
| {{success|text=You're done! You've successfully installed a Sonic 1 mod on your console.}} | | {{success|text=You're done! You've successfully installed a Sonic 1 mod on your console.}} |
| </span> | | </span> |
| | | |-|Sonic 2 (2013)= |
| | |
| |-|Sonic CD (2011)= | |
|
| |
|
| <span> | | <span> |
| {{Infobox homebrew | | {{Infobox homebrew |
| | title=Sonic CD (2011) for 3DS | | | title=Sonic the Hedgehog 1 & 2 for New 3DS |
| | developers= SaturnSH2x2, rubberduckycooly | | | developers= JeffRuLz, rubberduckycooly |
| | image= SonicCDBanner.png | | | image= Sonic1Banner.png |
| | imagealt= The banner for the Sonic CD 3DS Homebrew port | | | imagealt= The banner for the Sonic 1/2 3DS Homebrew port |
| | for3ds= 1 | | | for3ds= 1 |
| | releasedate= 2021-8-20 | | | releasedate= 2022-11-4 |
| | version= 1.3.0 | | | version= 1.3.0 |
| | github = SaturnSH2x2/Sonic-CD-11-3DS | | | github = JeffRuLz/Sonic-1-2-2013-Decompilation |
| }} | | }} |
| == What you need == | | == What you need == |
| * A <code>data.rsdk</code> file from either the [https://play.google.com/store/apps/details?id=com.sega.soniccd.classic&pcampaignid=web_share Mobile port] or the [https://store.steampowered.com/app/200940/Sonic_CD/ delisted Steam release] | | * A <code>data.rsdk</code> file from the [https://play.google.com/store/apps/details?id=com.sega.sonic1px&pcampaignid=web_share Mobile port] |
| ** Mobile: Follow [https://gamebanana.com/tuts/14942 this tutorial.] | | ** Tutorial can be found [https://gamebanana.com/tuts/14492 here.] |
| ** 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 [[udb:3ds/sonic-1--2|Sonic 2 (3DS)]] (<code>Sonic2.cia</code>) |
| * The latest release of [[udb:3ds/sonic-cd|Sonic CD (3DS)]] (the <code>.cia</code> file) | | ** If you have issues, try to use the <code>rev01</code> version instead. |
| ** For old 3DS users, download the <code>HW</code> version | |
| ** For new 3DS users, download the <code>SW</code> version
| |
| == Instructions == | | == Instructions == |
| === Section I - Prep Work === | | === Section I - Prep Work === |
| Line 105: |
Line 102: |
| #Insert your SD card into your computer | | #Insert your SD card into your computer |
| #Create a folder named <code>cias</code> on the root of your SD card if it does not already exist | | #Create a folder named <code>cias</code> on the root of your SD card if it does not already exist |
| #Copy SonicCD<code>.cia</code> to the <code>/cias/</code> folder on your SD card | | #Copy <code>Sonic2.cia</code> to the <code>/cias/</code> folder on your SD card |
| #Create a folder named <code>3ds</code> on the root of your SD card if it does not already exist | | #Create a folder named <code>3ds</code> on the root of your SD card if it does not already exist |
| #Create a folder named <code>SonicCD</code> in the 3ds folder on your SD card if it does not already exist | | #Create a folder named <code>Sonic2</code> in the 3ds folder on your SD card if it does not already exist |
| #Copy <code>data.rsdk</code> to the <code>/3ds/SonicCD/</code> folder on your SD card | | #Copy <code>data.rsdk</code> to the <code>/3ds/Sonic2/</code> folder on your SD card |
| #Reinsert your SD card into your console | | #Reinsert your SD card into your console |
| #Power on your console | | #Power on your console |
| Line 114: |
Line 111: |
| #Launch FBI from the HOME Menu | | #Launch FBI from the HOME Menu |
| #Navigate to <code>SD</code> -> <code>cias</code> | | #Navigate to <code>SD</code> -> <code>cias</code> |
| #Press {{B|A}} on Sonic CD, and select "Install and delete CIA" | | #Press {{B|A}} on Sonic 2, and select "Install and delete CIA" |
| #Once installed, press {{B|Home}}, then {{B|X}} to close FBI | | #Once installed, press {{B|Home}}, then {{B|X}} to close FBI |
| {{success|text=You're done! You've successfully installed Sonic CD on your console.}} | | {{success|text=You're done! You've successfully installed Sonic 2 on your console.}} |
| == '''Optional''' - Installing mods == | | == '''Optional''' - Setting up mods == |
| {{info|text=As said above, script mods will not work properly}} | | {{info|text=As said above, script mods will not work properly}} |
|
| |
|
| == 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/6526 A mod from the Sonic 2 GameBanana page that contains no Scripts folder] |
| == Instructions == | | == Instructions == |
| ===Section I - Prep Work=== | | ===Section I - Prep Work=== |
| <ol> | | <ol> |
| <li>Power off your console | | <li>Power off your console</li> |
| <li>Insert your SD card into your computer | | <li>Insert your SD card into your computer</li> |
| <li>Navigate to <code>/3ds/SonicCD/</code>, then create a folder named <code>mods</code> if it doesn't already exist | | <li>Navigate to <code>/3ds/Sonic2/</code>, then create a folder named <code>mods</code> if it doesn't already exist</li> |
| <li>Extract your mods <code>.zip</code> file and copy the folder to <code>/3ds/SonicCD/mods/</code> | | <li>Extract your mods <code>.zip</code> file and copy the folder to <code>/3ds/Sonic2/mods/</code> |
| <ul> | | <ul> |
| <li>Your mod folder should look like this | | <li>Your mod folder should look like this</li> |
| {{Tree list}} | | {{Tree list}} |
| * [[File:Gnome-media-flash.svg|20px|link=]] (root) | | * [[File:Gnome-media-flash.svg|20px|link=]] (root) |
| ** [[File:Icons8 flat opened folder.svg|20px|link=]] 3ds | | ** [[File:Icons8 flat opened folder.svg|20px|link=]] 3ds |
| *** [[File:Icons8 flat opened folder.svg|20px|link=]] SonicCD | | *** [[File:Icons8 flat opened folder.svg|20px|link=]] Sonic2 |
| **** [[File:Icons8 flat opened folder.svg|20px|link=]] mods | | **** [[File:Icons8 flat opened folder.svg|20px|link=]] mods |
| ***** [[File:Icons8 flat opened folder.svg|20px|link=]] NameOfMod | | ***** [[File:Icons8 flat opened folder.svg|20px|link=]] NameOfMod |
| ****** [[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}}</ul></li> |
| </li></ul>
| | <li>Reinsert your SD card into your console</li> |
| <li>In <code>/3ds/SonicCD/</code>, open settings.ini
| | <li>Power on your console</li> |
| <ul>
| |
| <li>If settings.ini does not exist, launch the game first.</li></ul>
| |
| <li>Set <code>DevMenu</code> to true
| |
| <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> | | </ol> |
| === Section II - Loading the mod === | | === Section II - Loading the mod === |
| #Launch Sonic CD from the HOME Menu | | #Launch Sonic 2 from the HOME Menu |
| #Open the dev menu by pressing {{B|Select}}
| |
| #Press {{B|A}} on <code>MODS</code> | | #Press {{B|A}} on <code>MODS</code> |
| #Press {{B|A}} on on your mod to activate it | | #Press {{B|A}} on on your mod to activate it |
| #Press {{B|B}} to exit the mods list | | #Press {{B|B}} to exit the mods list |
| #Once the game has reloaded, start the game by pressing {{B|Start}}. | | #Once the game has reloaded, start the game. |
| {{success|text=You're done! You've successfully installed a Sonic CD mod on your console.}} | | {{success|text=You're done! You've successfully installed a Sonic 2 mod on your console.}} |
| </span> | | </span> |
|
| |
|
| |-|Sonic 2 (2013)= | | |-|Sonic CD (2011)= |
|
| |
|
| <span> | | <span> |
| {{Infobox homebrew | | {{Infobox homebrew |
| | title=Sonic the Hedgehog 1 & 2 for New 3DS | | | title=Sonic CD (2011) for 3DS |
| | developers= JeffRuLz, rubberduckycooly | | | developers= SaturnSH2x2, rubberduckycooly |
| | image= Sonic1Banner.png | | | image= SonicCDBanner.png |
| | imagealt= The banner for the Sonic 1/2 3DS Homebrew port | | | imagealt= The banner for the Sonic CD 3DS Homebrew port |
| | for3ds= 1 | | | for3ds= 1 |
| | releasedate= 2022-11-4 | | | releasedate= 2021-8-20 |
| | version= 1.3.0 | | | version= 1.3.0 |
| | github = JeffRuLz/Sonic-1-2-2013-Decompilation | | | github = SaturnSH2x2/Sonic-CD-11-3DS |
| }} | | }} |
| == What you need == | | == What you need == |
| * A <code>data.rsdk</code> file from the [https://play.google.com/store/apps/details?id=com.sega.sonic1px&pcampaignid=web_share Mobile port] | | * A <code>data.rsdk</code> file from either the [https://play.google.com/store/apps/details?id=com.sega.soniccd.classic&pcampaignid=web_share Mobile port] or the [https://store.steampowered.com/app/200940/Sonic_CD/ delisted Steam release] |
| ** Tutorial can be found [https://gamebanana.com/tuts/14492 here.] | | ** Mobile: Follow [https://gamebanana.com/tuts/14942 this tutorial.] |
| * The latest release of [[udb:3ds/sonic-1--2|Sonic 2 (3DS)]] (<code>Sonic2.cia</code>) | | ** PC: Browse the games local files via Steam (Right click the game on the sidebar -> Browse Local Files) and keep the directory open. |
| ** If you have issues, try to use the <code>rev01</code> version instead. | | * The latest release of [[udb:3ds/sonic-cd|Sonic CD (3DS)]] (the <code>.cia</code> file) |
| | ** For old 3DS users, download the <code>HW</code> version |
| | ** For new 3DS users, download the <code>SW</code> version |
| == Instructions == | | == Instructions == |
| === Section I - Prep Work === | | === Section I - Prep Work === |
| Line 183: |
Line 174: |
| #Insert your SD card into your computer | | #Insert your SD card into your computer |
| #Create a folder named <code>cias</code> on the root of your SD card if it does not already exist | | #Create a folder named <code>cias</code> on the root of your SD card if it does not already exist |
| #Copy <code>Sonic2.cia</code> to the <code>/cias/</code> folder on your SD card | | #Copy SonicCD<code>.cia</code> to the <code>/cias/</code> folder on your SD card |
| #Create a folder named <code>3ds</code> on the root of your SD card if it does not already exist | | #Create a folder named <code>3ds</code> on the root of your SD card if it does not already exist |
| #Create a folder named <code>Sonic2</code> in the 3ds folder on your SD card if it does not already exist | | #Create a folder named <code>SonicCD</code> in the 3ds folder on your SD card if it does not already exist |
| #Copy <code>data.rsdk</code> to the <code>/3ds/Sonic2/</code> folder on your SD card | | #Copy <code>data.rsdk</code> to the <code>/3ds/SonicCD/</code> folder on your SD card |
| #Reinsert your SD card into your console | | #Reinsert your SD card into your console |
| #Power on your console | | #Power on your console |
| Line 192: |
Line 183: |
| #Launch FBI from the HOME Menu | | #Launch FBI from the HOME Menu |
| #Navigate to <code>SD</code> -> <code>cias</code> | | #Navigate to <code>SD</code> -> <code>cias</code> |
| #Press {{B|A}} on Sonic 2, and select "Install and delete CIA" | | #Press {{B|A}} on Sonic CD, and select "Install and delete CIA" |
| #Once installed, press {{B|Home}}, then {{B|X}} to close FBI | | #Once installed, press {{B|Home}}, then {{B|X}} to close FBI |
| {{success|text=You're done! You've successfully installed Sonic 2 on your console.}} | | {{success|text=You're done! You've successfully installed Sonic CD on your console.}} |
| == '''Optional''' - Setting up mods == | | == '''Optional''' - Installing mods == |
| {{info|text=As said above, script mods will not work properly}} | | {{info|text=As said above, script mods will not work properly}} |
|
| |
|
| == What you need == | | == What you need == |
| *[https://gamebanana.com/games/6526 A mod from the Sonic 2 GameBanana page that contains no Scripts folder] | | *[https://gamebanana.com/games/6108 A mod from the Sonic CD GameBanana page that contains no Scripts folder] |
| == Instructions == | | == Instructions == |
| ===Section I - Prep Work=== | | ===Section I - Prep Work=== |
| Line 205: |
Line 196: |
| <li>Power off your console</li> | | <li>Power off your console</li> |
| <li>Insert your SD card into your computer</li> | | <li>Insert your SD card into your computer</li> |
| <li>Navigate to <code>/3ds/Sonic2/</code>, then create a folder named <code>mods</code> if it doesn't already exist</li> | | <li>Navigate to <code>/3ds/SonicCD/</code>, then create a folder named <code>mods</code> if it doesn't already exist</li> |
| <li>Extract your mods <code>.zip</code> file and copy the folder to <code>/3ds/Sonic2/mods/</code></li> | | <li>Extract your mods <code>.zip</code> file and copy the folder to <code>/3ds/SonicCD/mods/</code> |
| <ul> | | <ul> |
| <li>Your mod folder should look like this | | <li>Your mod folder should look like this</li> |
| {{Tree list}} | | {{Tree list}} |
| * [[File:Gnome-media-flash.svg|20px|link=]] (root) | | * [[File:Gnome-media-flash.svg|20px|link=]] (root) |
| ** [[File:Icons8 flat opened folder.svg|20px|link=]] 3ds | | ** [[File:Icons8 flat opened folder.svg|20px|link=]] 3ds |
| *** [[File:Icons8 flat opened folder.svg|20px|link=]] Sonic2 | | *** [[File:Icons8 flat opened folder.svg|20px|link=]] SonicCD |
| **** [[File:Icons8 flat opened folder.svg|20px|link=]] mods | | **** [[File:Icons8 flat opened folder.svg|20px|link=]] mods |
| ***** [[File:Icons8 flat opened folder.svg|20px|link=]] NameOfMod | | ***** [[File:Icons8 flat opened folder.svg|20px|link=]] NameOfMod |
| ****** [[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}}</li></ul> | | {{Tree list/end}}</ul></li> |
| | <li>In <code>/3ds/SonicCD/</code>, open settings.ini |
| | <ul> |
| | <li>If settings.ini does not exist, launch the game first.</li></ul></li> |
| | <li>Set <code>DevMenu</code> to true |
| | <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> |
| <li>Reinsert your SD card into your console</li> | | <li>Reinsert your SD card into your console</li> |
| <li>Power on your console</li> | | <li>Power on your console</li> |
| </ol> | | </ol> |
| === Section II - Loading the mod === | | === Section II - Loading the mod === |
| #Launch Sonic 2 from the HOME Menu | | #Launch Sonic CD from the HOME Menu |
| | #Open the dev menu by pressing {{B|Select}} |
| #Press {{B|A}} on <code>MODS</code> | | #Press {{B|A}} on <code>MODS</code> |
| #Press {{B|A}} on on your mod to activate it | | #Press {{B|A}} on on your mod to activate it |
| #Press {{B|B}} to exit the mods list | | #Press {{B|B}} to exit the mods list |
| #Once the game has reloaded, start the game. | | #Once the game has reloaded, start the game by pressing {{B|Start}}. |
| {{success|text=You're done! You've successfully installed a Sonic 2 mod on your console.}} | | {{success|text=You're done! You've successfully installed a Sonic CD mod on your console.}} |
| </span> | | </span> |
| | |
| |-|Sonic Mania= | | |-|Sonic Mania= |
|
| |
|
| Line 246: |
Line 245: |
| == What you need == | | == What you need == |
| * A <code>Data.rsdk</code> file from any version of Sonic Mania you can obtain it from (i.e. PC, Nintendo Switch) | | * A <code>Data.rsdk</code> file from any version of Sonic Mania you can obtain it from (i.e. PC, Nintendo Switch) |
| **Switch: Dump the <code>romfs</code> with {{GitHub|NXDumpTool}}, and copy the <code>Data.rsdk</code> to your PC. | | **Switch: Dump the <code>romfs</code> with {{GitHub|DarkMatterCore/nxdumptool/releases|NXDumpTool}}, and copy the <code>Data.rsdk</code> 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 (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 <code>...</code> in your Library -> "Manage" -> press the folder icon, then keep the directory open. | | **PC (Epic Games): Press the <code>...</code> in your Library -> "Manage" -> press the folder icon, then keep the directory open. |
(root)
3ds
mod.ini
