|
|
(5 intermediate revisions by 2 users not shown) |
Line 1: |
Line 1: |
| This tutorial will take you through setting up the Sonic Decompilation 3DS ports. | | {{Page WIP}} This tutorial will take you through setting up the Sonic 1, CD, 2, and Mania 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.}} | | {{info|text=Please make any edits if you see any issues! - Temporary Message}} |
| | {{critical|text=If you are on Old 3DS, then every game here (except Sonic CD) will not work!}} |
| | {{critical|text=Special Stages will run poorly across all games.}} |
| === Technical Details (optional) === | | === Technical Details (optional) === |
| These ports are based on the decompilations by {{GitHub|Rubberduckycooly}} for the mobile versions of Sonic 1, CD, 2, and Sonic Mania. | | These ports are based on the decompilations by {{GitHub|Rubberduckycooly}} for the mobile versions of Sonic 1, CD, 2, and Sonic Mania. |
|
| |
|
| 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. |
| | |
| | {{info|text=Select the game you want to set up by using the options at the bottom.}} |
| </noinclude> | | </noinclude> |
| <tabber> | | <tabber> |
Line 24: |
Line 28: |
| * 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 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.] | | ** Tutorial can be found [https://gamebanana.com/tuts/14492 here.] |
| * The latest release of [[udb:3ds/sonic-1--2|Sonic 1 (3DS)]] (<code>Sonic1.cia</code>) | | * The latest release of [[udb:3ds/sonic-1--2|Sonic 1 (3DS)]] (the <code>.cia</code> file) |
| ** If you have issues, try to use the <code>rev01</code> version instead. | | ** It doesn't matter whenever you use the <code>rev01</code> version or the standard version |
| == Instructions == | | == Instructions == |
| === Section I - Prep Work === | | === Section I - Prep Work === |
Line 31: |
Line 35: |
| #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>Sonic1.cia</code> to the <code>/cias/</code> folder on your SD card | | #Copy the CIA file (<code>Sonic1.cia</code> or <code>Sonic1_rev01.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>Sonic1</code> in the 3ds folder on your SD card if it does not already exist | | #Create a folder named <code>Sonic1</code> in the 3ds folder on your SD card if it does not already exist |
Line 40: |
Line 44: |
| #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 1, and select "Install and delete CIA" | | #Press {{B|A}} on Sonic 1, and select "Install 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 1 on your console.}} | | {{success|text=You're done! You've successfully installed Sonic 1 on your console.}} |
Line 52: |
Line 56: |
| #Power off your console | | #Power off your console |
| #Insert your SD card into your computer | | #Insert your SD card into your computer |
| #Navigate to <code>/3ds/Sonic1/</code>, then create a folder named <code>mods</code> | | #Navigate to <code>/3ds/Sonic1/</code> |
| | #Create a folder named <code>mods</code> in the 3ds folder on your SD card if it does not already exist |
| #Extract <code>SonicForeverMod</code> from the Sonic 1 Forever <code>.zip</code> and copy it to <code>/3ds/Sonic1/mods/</code> | | #Extract <code>SonicForeverMod</code> from the Sonic 1 Forever <code>.zip</code> and copy it to <code>/3ds/Sonic1/mods/</code> |
| #Reinsert your SD card into your console | | #Reinsert your SD card into your console |
Line 82: |
Line 87: |
| == 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 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.] | | ** Mobile: Follow [https://gamebanana.com/tuts/14942 this tutorial on GameBanana.] |
| ** PC: Browse the games local files via Steam (Right click the game on the sidebar -> Browse Local Files) and keep the directory open. | | ** 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) | | * The latest release of [[udb:3ds/sonic-cd|Sonic CD (3DS)]] (the <code>.cia</code> file) |
Line 92: |
Line 97: |
| #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 the CIA file (<code>SonicCD_HW.cia</code> or <code>Sonic1_rev01.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>SonicCD</code> in the 3ds folder on your SD card if it does not already exist |
Line 101: |
Line 106: |
| #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 CD, and select "Install 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 CD on your console.}} |
Line 122: |
Line 127: |
| * 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 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.] | | ** 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-1--2|Sonic 2 (3DS)]] (the <code>.cia</code> file) |
| ** If you have issues, try to use the <code>rev01</code> version instead. | | ** It doesn't matter whenever you use the <code>rev01</code> version or the standard version |
| == Instructions == | | == Instructions == |
| === Section I - Prep Work === | | === Section I - Prep Work === |
Line 129: |
Line 134: |
| #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 the CIA file (<code>Sonic2.cia</code> or <code>Sonic2_rev01.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>Sonic2</code> in the 3ds folder on your SD card if it does not already exist |
Line 138: |
Line 143: |
| #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 2, and select "Install 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 2 on your console.}} |
| == '''Optional''' - Setting up Sonic 2 Absolute ==
| |
| {{info|text=This is using the outdated 1.1.1 version of the mod (latest is 1.2.1), but it's the most recent that works the best on 3DS.}}
| |
|
| |
| == What you need ==
| |
| *[https://teamforeveronline.wixsite.com/home/sonic-2-absolute Sonic 2 Absolute] (the 1.1.1 mod only release)
| |
| == Instructions ==
| |
| ===Section I - Prep Work===
| |
| #Power off your console
| |
| #Insert your SD card into your computer
| |
| #Navigate to <code>/3ds/Sonic2/</code>, then create a folder named <code>mods</code>
| |
| #Extract <code>S2A</code> from the Sonic 2 Absolute <code>.zip</code> and copy it to <code>/3ds/Sonic2/mods/</code>
| |
| #Reinsert your SD card into your console
| |
| #Power on your console
| |
| === Section II - Loading the mod ===
| |
| #Launch Sonic 2 from the HOME Menu
| |
| #Press {{B|A}} on <code>MODS</code>
| |
| #Press {{B|A}} on <code>Sonic 2 Absolute</code> to activate it
| |
| #Press {{B|B}} to exit the mods list
| |
| #Once the game has reloaded, press {{B|Home}}, then {{B|X}} to close Sonic 2
| |
| #Relaunch Sonic 2 from the HOME Menu
| |
| {{success|text=You're done! You've successfully installed Sonic 2 Absolute (1.1.1) on your console.}}
| |
| </span> | | </span> |
| |-|Sonic Mania= | | |-|Sonic Mania= |
Line 171: |
Line 155: |
| | developers= SaturnSH2x2, rubberduckycooly | | | developers= SaturnSH2x2, rubberduckycooly |
| | image= SonicManiaBanner.png | | | image= SonicManiaBanner.png |
| | imagealt= The banner for the Sonic Mania 3DS Homebrew port | | | imagealt= The banner for the Sonic 1/2 3DS Homebrew port |
| | for3ds= 1 | | | for3ds= 1 |
| | releasedate= 2022-9-12 | | | releasedate= 2022-11-4 |
| | version= 1.0 | | | version= 1.3.0 |
| | github = SaturnSH2x2/RSDKv5-Decompilation | | | github = SaturnSH2x2/RSDKv5-Decompilation |
| }} | | }} |
| == 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|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 (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. |
| * The latest release of [[udb:3ds/sonic-mania|Sonic Mania (3DS)]] (the <code>.cia</code> file) | | * The latest release of [[udb:3ds/sonic-sonic-mania|Sonic Mania (3DS)]] (the <code>.cia</code> file) |
| ** If you compiled the port, you can find the <code>.cia</code> you built in the cloned repository directory, then <code>/dependencies/v5_3DS/3ds/out/</code> | | ** If you compiled the port, you can find the <code>.cia</code> you built in <code>/dependencies/v5_3DS/3ds/out/</code> in the cloned repository directory |
| == Instructions == | | == Instructions == |
| === Section I - Prep Work === | | === Section I - Prep Work === |
Line 189: |
Line 173: |
| #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>SonicMania.cia</code> to the <code>/cias/</code> folder on your SD card | | #Copy the CIA file (<code>SonicMania.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>SonicMania</code> in the 3ds folder on your SD card if it does not already exist | | #Create a folder named <code>SonicMania</code> in the 3ds folder on your SD card if it does not already exist |
Line 198: |
Line 182: |
| #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 Mania, and select "Install and delete CIA" | | #Press {{B|A}} on Sonic Mania, and select "Install 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 Mania on your console.}} | | {{success|text=You're done! You've successfully installed Sonic Mania on your console.}} |