From eb3a3434b5301bf0023cd621ed30e7dbc05fe0f7 Mon Sep 17 00:00:00 2001 From: lizzie Date: Wed, 10 Dec 2025 06:36:57 +0000 Subject: [PATCH] update handbook; merge sections and make it easier for the end user --- ...EdenToSRM_SteamDeck.md => AddEdenToSRM.md} | 0 ...mesToSRM_SteamDeck.md => AddGamesToSRM.md} | 0 .../{AlterDate-Time.md => AlterDateTime.md} | 0 docs/user/ControllerProfileByGame.md | 28 --- docs/user/ControllerProfiles.md | 33 ++- docs/user/EdenFailsToLaunch_Windows.md | 91 -------- ...oControls_SteamDeck.md => GyroControls.md} | 4 +- ...tingSaves_Windows.md => ImportingSaves.md} | 12 +- docs/user/InstallingAtmosphereMods.md | 2 +- ...Updates-DLC.md => InstallingUpdatesDLC.md} | 2 +- .../{QuickStart_Windows.md => QuickStart.md} | 46 +++- docs/user/QuickStart_SteamDeck.md | 42 ---- docs/user/README.md | 30 ++- .../{RunOnMacOS_MacOS.md => RunOnMacOS.md} | 0 docs/user/SyncthingGuide.md | 211 ++++++++++++++++++ docs/user/SyncthingGuide_General.md | 66 ------ docs/user/SyncthingGuide_Linux.md | 96 -------- docs/user/SyncthingGuide_Windows.md | 95 -------- docs/user/Troubleshoot.md | 86 +++++++ ...{UsingAmiibo_Windows.md => UsingAmiibo.md} | 14 +- ...{UsingCheats_Android.md => UsingCheats.md} | 92 ++++++-- docs/user/UsingCheats_Windows.md | 83 ------- 22 files changed, 489 insertions(+), 544 deletions(-) rename docs/user/{AddEdenToSRM_SteamDeck.md => AddEdenToSRM.md} (100%) rename docs/user/{AddGamesToSRM_SteamDeck.md => AddGamesToSRM.md} (100%) rename docs/user/{AlterDate-Time.md => AlterDateTime.md} (100%) delete mode 100644 docs/user/ControllerProfileByGame.md delete mode 100644 docs/user/EdenFailsToLaunch_Windows.md rename docs/user/{GyroControls_SteamDeck.md => GyroControls.md} (97%) rename docs/user/{ImportingSaves_Windows.md => ImportingSaves.md} (92%) rename docs/user/{InstallingUpdates-DLC.md => InstallingUpdatesDLC.md} (96%) rename docs/user/{QuickStart_Windows.md => QuickStart.md} (56%) delete mode 100644 docs/user/QuickStart_SteamDeck.md rename docs/user/{RunOnMacOS_MacOS.md => RunOnMacOS.md} (100%) create mode 100644 docs/user/SyncthingGuide.md delete mode 100644 docs/user/SyncthingGuide_General.md delete mode 100644 docs/user/SyncthingGuide_Linux.md delete mode 100644 docs/user/SyncthingGuide_Windows.md rename docs/user/{UsingAmiibo_Windows.md => UsingAmiibo.md} (93%) rename docs/user/{UsingCheats_Android.md => UsingCheats.md} (50%) delete mode 100644 docs/user/UsingCheats_Windows.md diff --git a/docs/user/AddEdenToSRM_SteamDeck.md b/docs/user/AddEdenToSRM.md similarity index 100% rename from docs/user/AddEdenToSRM_SteamDeck.md rename to docs/user/AddEdenToSRM.md diff --git a/docs/user/AddGamesToSRM_SteamDeck.md b/docs/user/AddGamesToSRM.md similarity index 100% rename from docs/user/AddGamesToSRM_SteamDeck.md rename to docs/user/AddGamesToSRM.md diff --git a/docs/user/AlterDate-Time.md b/docs/user/AlterDateTime.md similarity index 100% rename from docs/user/AlterDate-Time.md rename to docs/user/AlterDateTime.md diff --git a/docs/user/ControllerProfileByGame.md b/docs/user/ControllerProfileByGame.md deleted file mode 100644 index 3bc1a31263..0000000000 --- a/docs/user/ControllerProfileByGame.md +++ /dev/null @@ -1,28 +0,0 @@ -# Setting Controller Profiles By Game - -Use this guide when you want to set up specific controller profiles for specific games. This can be useful for certain games like *Captain Toad Treasure Tracker* where a blue dot appears in the middle of the screen when you have docked mode enabled, but not handheld mode. - -**Click [Here](https://evilperson1337.notion.site/Setting-Controller-Profiles-By-Game-2b057c2edaf681658a57f0c199cb6083) for a version of this guide with images & visual elements.** - ---- - -### Pre-Requisites - -- Eden Emulator set up and fully configured -- Controller Profile Created - - See [*Configuring Controller Profiles*](./ControllerProfiles.md) for instructions on how to do this if needed. - ---- - -## Steps - -1. *Right-Click* the game you want to apply the profile to in the main window and select **Properties.** -2. Navigate to the **Input Profiles** tab in the window that appears. Drop down on *Player 1 profile* (or whatever player profile you want to apply it to) and select the profile you want. - - -1. Click **OK** to apply the profile mapping. -2. Launch the game and confirm that the profile is applied, regardless of what the global configuration is. \ No newline at end of file diff --git a/docs/user/ControllerProfiles.md b/docs/user/ControllerProfiles.md index c9a232f730..3b4898f447 100644 --- a/docs/user/ControllerProfiles.md +++ b/docs/user/ControllerProfiles.md @@ -12,9 +12,38 @@ Use this guide for when you want to configure specific controller settings to be --- -## Steps +### Steps 1. Launch Eden and wait for it to load. 2. Navigate to *Emulation > Configure…* 3. Select **Controls** from the left-hand menu and configure your controller for the way you want it to be in game. 4. Select **New** and enter a name for the profile in the box that appears. Press **OK** to save the profile settings. -5. Select **OK** to close the settings menu. \ No newline at end of file +5. Select **OK** to close the settings menu. + +## Setting Controller Profiles By Game + +Use this guide when you want to set up specific controller profiles for specific games. This can be useful for certain games like *Captain Toad Treasure Tracker* where a blue dot appears in the middle of the screen when you have docked mode enabled, but not handheld mode. + +**Click [Here](https://evilperson1337.notion.site/Setting-Controller-Profiles-By-Game-2b057c2edaf681658a57f0c199cb6083) for a version of this guide with images & visual elements.** + +--- + +### Pre-Requisites + +- Eden Emulator set up and fully configured +- Controller Profile Created + - See [*Configuring Controller Profiles*](./ControllerProfiles.md) for instructions on how to do this if needed. + +--- + +### Steps + +1. *Right-Click* the game you want to apply the profile to in the main window and select **Properties.** +2. Navigate to the **Input Profiles** tab in the window that appears. Drop down on *Player 1 profile* (or whatever player profile you want to apply it to) and select the profile you want. + + +1. Click **OK** to apply the profile mapping. +2. Launch the game and confirm that the profile is applied, regardless of what the global configuration is. diff --git a/docs/user/EdenFailsToLaunch_Windows.md b/docs/user/EdenFailsToLaunch_Windows.md deleted file mode 100644 index 9a30348092..0000000000 --- a/docs/user/EdenFailsToLaunch_Windows.md +++ /dev/null @@ -1,91 +0,0 @@ -# Eden Fails to Launch and Does Not Leave Any Logs - -**Click [Here](https://evilperson1337.notion.site/Windows-Eden-Fails-to-Launch-and-Does-Not-Leave-Any-Logs-2b057c2edaf68156b640cf1ac549870a) for a version of this guide with images & visual elements.** - ---- - -## Error Details - -*Behavior*: Program appears not to launch or exits immediately without leaving any log entries. -*Platform(s) Affected*: -- **Windows** - -**Error Log Entries:** - -``` -None -``` -**Example Error Message Entry in Windows Event Viewer** -``` -Faulting application name: eden.exe, version: 0.0.0.0, time stamp: 0x6795dc3c -Faulting module name: ntdll.dll, version: 10.0.26100.3037, time stamp: 0x95e6c489 -Exception code: 0xc0000005 -Fault offset: 0x0000000000014778 -Faulting process id: 0x2AF0 -Faulting application start time: 0x1DB7C30D2972402 -Faulting application path: C:\temp\Eden-Windows\eden.exe -Faulting module path: C:\WINDOWS\SYSTEM32\ntdll.dll -Report Id: 4c8a6e13-9637-438c-b4d0-e802d279af66 -Faulting package full name: -Faulting package-relative application ID: -``` - ---- - -## Causes - - - - \ No newline at end of file diff --git a/docs/user/GyroControls_SteamDeck.md b/docs/user/GyroControls.md similarity index 97% rename from docs/user/GyroControls_SteamDeck.md rename to docs/user/GyroControls.md index 2a98e676ec..0df9088c1e 100644 --- a/docs/user/GyroControls_SteamDeck.md +++ b/docs/user/GyroControls.md @@ -3,7 +3,7 @@ Use this guide when you want to use the Steam Deck's native gyro functionality f **Click [Here](https://evilperson1337.notion.site/Getting-Gyro-Motion-Controls-Working-on-Steam-Deck-2b057c2edaf681a1aaade35db6e0fd1b) for a version of this guide with images & visual elements.** ---- +## Steamdeck ### Pre-Requisites @@ -13,7 +13,7 @@ Use this guide when you want to use the Steam Deck's native gyro functionality f --- -## Steps +### Steps 1. Go into Steam Deck's Desktop Mode, and use the shortcut to launch EmuDeck. 2. Install [SteamDeckGyroDSU](https://github.com/kmicki/SteamDeckGyroDSU/releases) by going to *3rd Party Tools > Gyroscope* and clicking **Install.** diff --git a/docs/user/ImportingSaves_Windows.md b/docs/user/ImportingSaves.md similarity index 92% rename from docs/user/ImportingSaves_Windows.md rename to docs/user/ImportingSaves.md index 1827a6d6b7..428609f69c 100644 --- a/docs/user/ImportingSaves_Windows.md +++ b/docs/user/ImportingSaves.md @@ -4,15 +4,13 @@ Use this guide when you want to manually import save files for use in the Eden e **Click [Here](https://evilperson1337.notion.site/Importing-Saves-Into-Eden-2b057c2edaf681fe968df8d63821ccae) for a version of this guide with images & visual elements.** ---- - ### Pre-Requisites - Eden emulator already set up and configured. - The save file(s) you want to import ---- +## Desktop -## Steps +### Steps 1. Open Eden and wait for it to load. 2. Start the game and create a save file to establish the directories. 3. *Right-Click* the game for which you want to load a save in. @@ -25,4 +23,8 @@ Use this guide when you want to manually import save files for use in the Eden e 7. Close the file explorer as it is no longer needed. -8. Launch the game in Eden and verify that the save data appears through whatever method the game implements. \ No newline at end of file +8. Launch the game in Eden and verify that the save data appears through whatever method the game implements. + +## Android + +TBD diff --git a/docs/user/InstallingAtmosphereMods.md b/docs/user/InstallingAtmosphereMods.md index 77eeea6080..ae8e4b37d2 100644 --- a/docs/user/InstallingAtmosphereMods.md +++ b/docs/user/InstallingAtmosphereMods.md @@ -1,4 +1,4 @@ -# Installing Atmosphere Mods +# User Handbook - Installing Atmosphere Mods Use this guide for when you want to install an Atmosphere-based mod for use in Eden. diff --git a/docs/user/InstallingUpdates-DLC.md b/docs/user/InstallingUpdatesDLC.md similarity index 96% rename from docs/user/InstallingUpdates-DLC.md rename to docs/user/InstallingUpdatesDLC.md index 6cb0099d85..2fdf40dde9 100644 --- a/docs/user/InstallingUpdates-DLC.md +++ b/docs/user/InstallingUpdatesDLC.md @@ -1,4 +1,4 @@ -# Working with Updates/DLC in Eden +# User Handbook - Working with Updates/DLC in Eden Use this guide when you want to install Updates or DLC for your games in Eden. diff --git a/docs/user/QuickStart_Windows.md b/docs/user/QuickStart.md similarity index 56% rename from docs/user/QuickStart_Windows.md rename to docs/user/QuickStart.md index 9b90f622ce..c7e7f566d6 100644 --- a/docs/user/QuickStart_Windows.md +++ b/docs/user/QuickStart.md @@ -4,21 +4,18 @@ Use this guide to get starting using the Eden emulator. **Click [Here](https://evilperson1337.notion.site/Eden-Quick-Start-2b057c2edaf6817b9859d8bcdb474017) for a version of this guide with images & visual elements.** ---- +## Windows ### Pre-Requisites - - The [*latest C++ Redistributable*](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170#latest-supported-redistributable-version) from Microsoft. - - Eden will not even launch without it see [*Eden Fails to Launch*](./EdenFailsToLaunch.md) for more information. + - Eden will not even launch without it see [*Eden Fails to Launch*](./Troubleshoot.md) for more information. - Firmware dumped from your console - Keys extracted from your console - Games dumped from your console - Internet Connection ---- - -## Steps +### Steps 1. Download either the *Stable* or *Nightly* Eden application. -## Steps - ---- +### Steps 1. Launch Eden and launch the game you want to load Amiibo for. 5. Upon loading a valid file, you will get a confirmation screen and your bonus content will be unlocked/functionality activated. -6. Repeat with any other Amiibo you want to use. \ No newline at end of file +6. Repeat with any other Amiibo you want to use. diff --git a/docs/user/UsingCheats_Android.md b/docs/user/UsingCheats.md similarity index 50% rename from docs/user/UsingCheats_Android.md rename to docs/user/UsingCheats.md index cd7538be9d..f0da068582 100644 --- a/docs/user/UsingCheats_Android.md +++ b/docs/user/UsingCheats.md @@ -1,10 +1,10 @@ -# Using Cheats with Eden +# User Handbook - Using Cheats Use this guide when you want to add cheats into a game to alter gameplay for use with the Eden emulator. **Click [Here](https://evilperson1337.notion.site/Using-Cheats-with-Eden-2b057c2edaf6818fab66c276e2304bb4) for a version of this guide with images & visual elements.** ---- +## Android ### Pre-Requisites @@ -21,11 +21,7 @@ Another option would be to launch the game in Eden and close it - then go into t ---- - -## Steps - -### Configuring a Cheat +### Step 1: Configuring a Cheat 1. Create a directory somewhere accessible on your phone with the name of the cheat. The name you choose only affects how it is displayed in Eden. 2. Create a directory inside of this folder called **cheats.** @@ -52,9 +48,7 @@ Another option would be to launch the game in Eden and close it - then go into t 2. You should now see the cheat appear in the **Add-ons** screen. 3. Launch the game and confirm that the cheat is applied. ---- - -### Multiple Cheats +### Step 2: Multiple Cheats In order to install multiple cheats, you must repeat the steps above with the new cheat, creating a new directory with the name of the cheat and cheats directory. You **cannot** install multiple cheats with a single file. @@ -79,9 +73,7 @@ Community Member [Ninjistix](https://github.com/Ninjistix) created a utility (Wi 040E0000 0048A818 52800028 ``` ---- - -### Enabling/Disabling Cheats +### Step 3: Enabling/Disabling Cheats Cheats are enabled by default, but can be disabled so they don’t affect gameplay fairly easily using the game properties. @@ -89,4 +81,76 @@ Cheats are enabled by default, but can be disabled so they don’t affect gamepl 2. Scroll down on the properties until you see **Add-ons**, select this option. 3. *Select/Deselect* the name of the cheat you wish to enable/disable. 4. Click **OK** to close the window. -5. Launch the game to confirm the cheat is/is not active. \ No newline at end of file +5. Launch the game to confirm the cheat is/is not active. + +## Desktop + +### Pre-Requisites + +- Eden Emulator fully set up and configured +- The cheat(s) you want to apply +- The **Build ID** of the game. + + + +### Step 1: Configuring a Cheat + +1. Copy the Hex Code of the cheat into a text file, optionally with the cheat name at the beginning like the example. Here this code will set the timer to 999 in *New Super Mario Bros. U Deluxe.* + + ```bash + [Time = 999] + 58000000 00C88A70 + 78001000 00000090 + 64000000 00000000 003E6F00 + ``` + +1. Save the file as a **txt** file with the Build ID of the game. For my example, my Build ID is **AEE6DCCC06D9C05B** so my file would be `AEE6DCCC06D9C05B.txt`. +2. Launch Eden and wait for the program to load. +3. *Right-Click* the game in Eden and select **Open Mod Data Location**. A file explorer window should appear. +4. Create a folder inside of the file explorer window with the name of the cheat. This name does not matter and only affects how it appears in the game properties inside of Eden. +5. Navigate inside of this folder and create another folder called **cheats.** +6. Move the txt file you created earlier into this **cheats** folder. (e.g. `/Time 999/cheats/AEE6DCCC06D9C05B.txt` ) +7. Go back to Eden and *right-click* the game. Select *Configure Game* and you should now see the cheat you created appear in the **Add-Ons** section with the name of the folder from step 6. +8. Launch the game to verify that the cheat is enabled. + +### Step 2: Multiple Cheats + +In order to install multiple cheats, you must repeat the steps above with the new cheat, creating a new directory with the name of the cheat and cheats directory. You **cannot** install multiple cheats with a single file. + +Community Member [Ninjistix](https://github.com/Ninjistix) created a utility (Windows or anything that can run Python) that can take a file with multiple cheats and create the files/structure for you with a provided Build ID. To download and run it, see the [GitHub Project](https://github.com/Ninjistix/nxCheat_Splitter) page. + +**Example cheat TXT file with multiple cheats. It must be in this format to work:** +``` +[Super Mario Bros. Wonder - Various] <- Optional + +[♯ 1. Always Star Power] +040E0000 00880580 52800035 + +[♯ 2. Star Power + Bubble Mode (Invincible)] +040E0000 00880580 52800075 + +[♯ 3. Can Fast Travel to Any Course and World] +040E0000 00935E10 52800036 +040E0000 0048A528 52800028 +040E0000 005D9F58 52800028 + +[♯ 4. Got All Top of Flag Poles] +040E0000 0048A818 52800028 +``` + +### Step 3: Enabling/Disabling Cheats + +Cheats are enabled by default, but can be disabled so they don’t affect gameplay fairly easily using the game properties. + +1. *Right-Click* the game and select *Configure Game*. +2. In the **Add-Ons** section, locate the cheat you wish to enable. +3. *Select/Deselect* the name of the cheat you wish to enable/disable. +4. Click **OK** to close the window. +5. Launch the game to confirm the cheat is/is not active. diff --git a/docs/user/UsingCheats_Windows.md b/docs/user/UsingCheats_Windows.md deleted file mode 100644 index c2a23f869c..0000000000 --- a/docs/user/UsingCheats_Windows.md +++ /dev/null @@ -1,83 +0,0 @@ -# Using Cheats with Eden - -Use this guide when you want to add cheats into a game to alter gameplay for use with the Eden emulator. - -**Click [Here](https://evilperson1337.notion.site/Using-Cheats-with-Eden-2b057c2edaf6818fab66c276e2304bb4) for a version of this guide with images & visual elements.** - ---- - -### Pre-Requisites - -- Eden Emulator fully set up and configured -- The cheat(s) you want to apply -- The **Build ID** of the game. - - - -## Steps - ---- - -### Configuring a Cheat - -1. Copy the Hex Code of the cheat into a text file, optionally with the cheat name at the beginning like the example. Here this code will set the timer to 999 in *New Super Mario Bros. U Deluxe.* - - ```bash - [Time = 999] - 58000000 00C88A70 - 78001000 00000090 - 64000000 00000000 003E6F00 - ``` - -1. Save the file as a **txt** file with the Build ID of the game. For my example, my Build ID is **AEE6DCCC06D9C05B** so my file would be `AEE6DCCC06D9C05B.txt`. -2. Launch Eden and wait for the program to load. -3. *Right-Click* the game in Eden and select **Open Mod Data Location**. A file explorer window should appear. -4. Create a folder inside of the file explorer window with the name of the cheat. This name does not matter and only affects how it appears in the game properties inside of Eden. -5. Navigate inside of this folder and create another folder called **cheats.** -6. Move the txt file you created earlier into this **cheats** folder. (e.g. `/Time 999/cheats/AEE6DCCC06D9C05B.txt` ) -7. Go back to Eden and *right-click* the game. Select *Configure Game* and you should now see the cheat you created appear in the **Add-Ons** section with the name of the folder from step 6. -8. Launch the game to verify that the cheat is enabled. - -### Multiple Cheats - -In order to install multiple cheats, you must repeat the steps above with the new cheat, creating a new directory with the name of the cheat and cheats directory. You **cannot** install multiple cheats with a single file. - -Community Member [Ninjistix](https://github.com/Ninjistix) created a utility (Windows or anything that can run Python) that can take a file with multiple cheats and create the files/structure for you with a provided Build ID. To download and run it, see the [GitHub Project](https://github.com/Ninjistix/nxCheat_Splitter) page. - -**Example cheat TXT file with multiple cheats. It must be in this format to work:** -``` -[Super Mario Bros. Wonder - Various] <- Optional - -[♯ 1. Always Star Power] -040E0000 00880580 52800035 - -[♯ 2. Star Power + Bubble Mode (Invincible)] -040E0000 00880580 52800075 - -[♯ 3. Can Fast Travel to Any Course and World] -040E0000 00935E10 52800036 -040E0000 0048A528 52800028 -040E0000 005D9F58 52800028 - -[♯ 4. Got All Top of Flag Poles] -040E0000 0048A818 52800028 -``` - ---- - -### Enabling/Disabling Cheats - -Cheats are enabled by default, but can be disabled so they don’t affect gameplay fairly easily using the game properties. - -1. *Right-Click* the game and select *Configure Game*. -2. In the **Add-Ons** section, locate the cheat you wish to enable. -3. *Select/Deselect* the name of the cheat you wish to enable/disable. -4. Click **OK** to close the window. -5. Launch the game to confirm the cheat is/is not active. \ No newline at end of file