3DS:Sonic Decompilations: Difference between revisions
From Hacks Guide Wiki
More actions
Replace S1F & S2A tutorials with general mod install tutorials, add notes for Origins Datafiles and script mods |
IHaveNoIdeas (talk | contribs) m correct nxdt link |
||
| (4 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! | {{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 | {{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. | ||
<tabber> | <tabber> | ||
|-|Sonic 1 (2013)= | |-|Sonic 1 (2013)= | ||
| Line 48: | Line 49: | ||
== What you need == | == What you need == | ||
*[https://gamebanana.com/games/ | *[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=== | ||
<ol> | |||
<li>Power off your console</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>Extract your mods <code>.zip</code> file and copy the folder to <code>/3ds/Sonic1/mods/</code> | |||
<ul> | |||
<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 64: | 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}} | {{Tree list/end}}</ul></li> | ||
<li>Reinsert your SD card into your console</li> | |||
<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 75: | 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 | |||
<span> | <span> | ||
{{Infobox homebrew | {{Infobox homebrew | ||
| title=Sonic | | title=Sonic the Hedgehog 1 & 2 for New 3DS | ||
| developers= | | developers= JeffRuLz, rubberduckycooly | ||
| image= | | image= Sonic1Banner.png | ||
| imagealt= The banner for the Sonic | | imagealt= The banner for the Sonic 1/2 3DS Homebrew port | ||
| for3ds= 1 | | for3ds= 1 | ||
| releasedate= | | releasedate= 2022-11-4 | ||
| version= 1.3.0 | | version= 1.3.0 | ||
| github = | | github = JeffRuLz/Sonic-1-2-2013-Decompilation | ||
}} | }} | ||
== What you need == | == What you need == | ||
* A <code>data.rsdk</code> file from | * A <code>data.rsdk</code> file from the [https://play.google.com/store/apps/details?id=com.sega.sonic1px&pcampaignid=web_share Mobile port] | ||
** | ** Tutorial can be found [https://gamebanana.com/tuts/14492 here.] | ||
* The latest release of [[udb:3ds/sonic-1--2|Sonic 2 (3DS)]] (<code>Sonic2.cia</code>) | |||
* The latest release of [[udb:3ds/sonic- | ** If you have issues, try to use the <code>rev01</code> version instead. | ||
** | |||
== Instructions == | == Instructions == | ||
=== Section I - Prep Work === | === Section I - Prep Work === | ||
| Line 102: | 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 | #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> | #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/ | #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 111: | 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 | #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 | {{success|text=You're done! You've successfully installed Sonic 2 on your console.}} | ||
== '''Optional''' - | == '''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/ | *[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> | |||
<li>Power off your console</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>Extract your mods <code>.zip</code> file and copy the folder to <code>/3ds/Sonic2/mods/</code> | |||
<ul> | |||
<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=]] | *** [[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>Reinsert your SD card into your console</li> | |||
<li>Power on your console</li> | |||
</ol> | |||
=== Section II - Loading the mod === | === Section II - Loading the mod === | ||
#Launch Sonic | #Launch Sonic 2 from the HOME Menu | ||
#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. | ||
{{success|text=You're done! You've successfully installed a Sonic | {{success|text=You're done! You've successfully installed a Sonic 2 mod on your console.}} | ||
</span> | </span> | ||
|-|Sonic | |-|Sonic CD (2011)= | ||
<span> | <span> | ||
{{Infobox homebrew | {{Infobox homebrew | ||
| title=Sonic | | title=Sonic CD (2011) for 3DS | ||
| developers= | | developers= SaturnSH2x2, rubberduckycooly | ||
| image= | | image= SonicCDBanner.png | ||
| imagealt= The banner for the Sonic | | imagealt= The banner for the Sonic CD 3DS Homebrew port | ||
| for3ds= 1 | | for3ds= 1 | ||
| releasedate= | | releasedate= 2021-8-20 | ||
| version= 1.3.0 | | version= 1.3.0 | ||
| github = | | github = SaturnSH2x2/Sonic-CD-11-3DS | ||
}} | }} | ||
== What you need == | == What you need == | ||
* A <code>data.rsdk</code> file from | * 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] | ||
** | ** Mobile: Follow [https://gamebanana.com/tuts/14942 this tutorial.] | ||
* The latest release of [[udb:3ds/sonic- | ** 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-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 174: | 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> | #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> | #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/ | #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 183: | 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 | #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 | {{success|text=You're done! You've successfully installed Sonic CD on your console.}} | ||
== '''Optional''' - | == '''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/ | *[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=== | ||
<ol> | |||
<li>Power off your console</li> | |||
<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> | |||
<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</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=]] | *** [[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}} | {{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>Power on your console</li> | |||
</ol> | |||
=== Section II - Loading the mod === | === Section II - Loading the mod === | ||
#Launch Sonic | #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 | {{success|text=You're done! You've successfully installed a Sonic CD mod on your console.}} | ||
</span> | </span> | ||
|-|Sonic Mania= | |-|Sonic Mania= | ||
| Line 234: | 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. | ||