lizzie
2 months ago
22 changed files with 489 additions and 544 deletions
-
0docs/user/AddEdenToSRM.md
-
0docs/user/AddGamesToSRM.md
-
0docs/user/AlterDateTime.md
-
28docs/user/ControllerProfileByGame.md
-
33docs/user/ControllerProfiles.md
-
91docs/user/EdenFailsToLaunch_Windows.md
-
4docs/user/GyroControls.md
-
12docs/user/ImportingSaves.md
-
2docs/user/InstallingAtmosphereMods.md
-
2docs/user/InstallingUpdatesDLC.md
-
46docs/user/QuickStart.md
-
42docs/user/QuickStart_SteamDeck.md
-
30docs/user/README.md
-
0docs/user/RunOnMacOS.md
-
211docs/user/SyncthingGuide.md
-
66docs/user/SyncthingGuide_General.md
-
96docs/user/SyncthingGuide_Linux.md
-
95docs/user/SyncthingGuide_Windows.md
-
86docs/user/Troubleshoot.md
-
14docs/user/UsingAmiibo.md
-
92docs/user/UsingCheats.md
-
83docs/user/UsingCheats_Windows.md
@ -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. |
|||
|
|||
<aside> |
|||
|
|||
***NOTE***: You may have to resize the window to see all tabs, or press the arrows by the tabs to see **Input Profiles**. |
|||
|
|||
</aside> |
|||
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. |
|||
@ -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 |
|||
|
|||
<aside> |
|||
|
|||
### Issue 1: Missing C++ Redistributable |
|||
|
|||
--- |
|||
|
|||
*Eden requires the latest C++ redistributable from Microsoft in order to run. Like many other programs, it relies on aspects and libraries included in this runtime, without it - the program cannot run.* |
|||
|
|||
1. Download the [Latest C++ Redistributable](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170#visual-studio-2015-2017-2019-and-2022) from Microsoft for your machine. |
|||
2. Double Click the downloaded executable file and wait for the software to install. |
|||
3. Restart the computer. |
|||
4. Launch Eden again, if the main window appears, you are good to go. If not, proceed to the next issue. |
|||
</aside> |
|||
|
|||
<aside> |
|||
|
|||
### Issue 2: Corrupted System Files |
|||
|
|||
--- |
|||
|
|||
*A corruption of necessary system files can cause odd behaviors when Eden tries to access them. It is a very rare case and you would likely see other programs misbehaving if this is what your issue is, but you can try if you have no other options.* |
|||
|
|||
1. Launch Eden to generate a crash. |
|||
2. Confirm there are no logs created in the log directory. |
|||
1. See the [How to Access Logs](./HowToAccessLogs.md) page for the log location if you need it. |
|||
2. If there are any entries in here since you tried step 1, this is likely not your issue. |
|||
3. Navigate to your *Windows Event Viewer* (Start Menu → **eventvwr.msc)**. |
|||
4. Expand **Windows Logs** and select **Application.** |
|||
|
|||
5. Look for an entry with the Level of Error, and look for a message similar to the following |
|||
|
|||
``` |
|||
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: |
|||
``` |
|||
|
|||
6. Run a Command Prompt terminal Window as Administrator. |
|||
7. Enter the following command and wait for it to complete. It will take a while, just be patient and do other things while it completes. |
|||
|
|||
``` |
|||
DISM /Online /Cleanup-Image /RestoreHealth |
|||
``` |
|||
|
|||
8. Reboot your computer. |
|||
9. Launch Eden and verify it is now working. |
|||
</aside> |
|||
@ -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. |
|||
|
|||
@ -1,42 +0,0 @@ |
|||
# Eden Quick Start |
|||
|
|||
Use this guide to get starting using the Eden emulator on Steam Deck. |
|||
|
|||
**Click [Here](https://evilperson1337.notion.site/Eden-Quick-Start-2b757c2edaf680d49ffdcda291a32840) for a version of this guide with images & visual elements.** |
|||
|
|||
--- |
|||
|
|||
### Pre-Requisites |
|||
|
|||
- Firmware dumped from your console |
|||
- Keys extracted from your console |
|||
- Games dumped from your console |
|||
- Internet Connection |
|||
|
|||
--- |
|||
|
|||
## Steps |
|||
|
|||
1. Access Steam Desktop Mode. |
|||
2. Download either the *Stable* or *Nightly* Eden AppImage onto your Steam Deck and save it somewhere accessible. |
|||
|
|||
<aside> |
|||
|
|||
***TIP***: If you have questions about the requirements, architectures, or general information surrounding what release you need - see the [*Basics Guide*](./Basics.md) and [*Architectures Guide*](./Architectures.md). |
|||
|
|||
</aside> |
|||
|
|||
3. Double-Click the Eden executable to launch the program. |
|||
<aside> |
|||
|
|||
***NOTE***: The first time you run the AppImage you will get a notification asking you to confirm you want to launch the program. Hit **Continue**. |
|||
|
|||
</aside> |
|||
|
|||
4. If you have had a different Switch emulator installed, it will detect and ask if you want to import those settings. Make your selection to close the screen. |
|||
5. Eden will now launch and notify you about missing Encryption keys. Close the dialog box by hitting **OK**. |
|||
6. Navigate to **Tools → Install Decryption Keys**, navigate to the folder containing your ***prod.keys*** file and select the file and hit **Open**. |
|||
7. Navigate to **Tools → Install Firmware →** *Select **From Folder*** or ***From ZIP*** - depending on how your firmware is stored, navigate to where it is stored and select it. |
|||
8. Double-Click the main window to add the folder containing your games. |
|||
9. Go to *Emulation > Configure > Input* and set up your controller. Click **OK** to close the dialog window. |
|||
10. Double-Click a game to run it. |
|||
@ -0,0 +1,211 @@ |
|||
# User Handbook - Backing Up/Syncing Eden Game Saves |
|||
|
|||
Use this guide for when you want to configure automated backup/syncing of your Eden save files using [*Syncthing*](https://syncthing.net/). |
|||
|
|||
**Click [Here](https://evilperson1337.notion.site/Backing-Up-Syncing-Eden-Game-Saves-2b357c2edaf68000b40cfab2c2c3dc0a) for a version of this guide with images & visual elements.** |
|||
|
|||
### Pre-Requisites |
|||
|
|||
- Eden already installed, configured, and functioning. |
|||
- Devices to run Syncthing on. |
|||
- Ability to allow a program to communicate through the firewall of your device. |
|||
|
|||
## Introduction |
|||
|
|||
<aside> |
|||
|
|||
***WARNING***: You should manually back up your save files before proceeding with this guide. If you incorrectly perform the steps, you risk losing them! |
|||
|
|||
</aside> |
|||
|
|||
- While this is a de-centralized model without the concepts of a Server/Client, Parent/Child, etc. - For the purposes of these guides, we will borrow from this models terminology to avoid sync conflicts and potential data loss. After the initial setup, all the devices in the sync network are equals and can push & pull files from any other device. |
|||
- In order for this to work, you should get all of the save files in Eden in the save folder on the Parent. |
|||
- If you need help doing that, see the ***Importing Saves into Eden*** guide for the platform you elect to act as the Parent, and delete the save files on the "Child" devices. |
|||
|
|||
### Terminology |
|||
|
|||
- **Sync Network**: All the devices configured in *Syncthing* to push/pull files. |
|||
- **Parent**: This will be the device that you elect to push files to the other devices. There can only be one here initially in order to avoid sync conflicts. |
|||
- **Child**: All the other devices added to the Sync Network. These devices will pull files from the Parent. |
|||
|
|||
## Overview |
|||
|
|||
Rather than giving a breakdown of all the platforms and configurations, those will be in the platform’s specific guides - this will serve as a general overview of Syncthing. |
|||
|
|||
### What is Syncthing Anyway? |
|||
|
|||
Syncthing is a continuous file synchronization program (in the layman’s - make sure 2 or more systems with the same files are always up to date). This is perfect for game saves where we would want to play on 1 device, save our game, and then continue playing it on another device. This technology is what Epic/Steam/etc. use to allow you to do this on games run through their respective services. Syncthing is an open source implementation of this technology that you control, rather than relying on a 3rd party. This has a few key benefits, most notably - better security, privacy, and speed (when on your LAN). |
|||
|
|||
### What are some common issues? |
|||
|
|||
Syncthing is fairly robust and doesn’t have many issues luckily, but there are some things you should watch out for (almost all of them a user issue). |
|||
|
|||
- Sync conflicts |
|||
- If for whatever reason you update the same file on 2 different machines, the system does not know which updated file is considered the one to sync across. This results in a ***sync conflict*** where it may not sync the files as you would expect. Worst case scenario, this can result in your save progress being lost if you are not careful. When one of these occurs, it will create a copy of the file and store it with a specific name, like this example, *Paper Mario.sync-conflict-20251102-072925-TZBBN6S.srm.* To resolve this, you must remove the other files and remove the *.sync-conflict-<TIMESTAMP>-<Syncthing Device ID>* from the file name of the file you want to keep. |
|||
- Accidental Deletions |
|||
- If you delete a file from one of the devices, it will also remove the file on the other devices when they perform a sync so be careful when doing this. |
|||
|
|||
## Windows |
|||
|
|||
### Pre-Requisites |
|||
|
|||
- Eden already installed, configured, and functioning. |
|||
- Ability to allow a program to communicate through the firewall in Windows. |
|||
- Ability to extract archive (.zip/.7z/.rar) files. |
|||
|
|||
### Steps |
|||
|
|||
<aside> |
|||
|
|||
***WARNING***: You should manually back up your save files before proceeding with this guide. If you incorrectly perform the steps, you risk losing them! |
|||
|
|||
</aside> |
|||
|
|||
#### Downloading and Installing *Syncthing* |
|||
|
|||
1. Download [*Syncthing Tray*](https://martchus.github.io/syncthingtray/#downloads-section). |
|||
1. While it is available as a command line interface, for most people I would recommend *Syncthing Tray* on Windows. For most people here, you would download the **64-bit (Intel/AMD)** version. |
|||
2. Open the downloaded archive and extract the **syncthingtray.exe** to wherever you want to store the executable. |
|||
3. Double-Click the application to run it, select the **Start guided setup** on the splash screen that appears and press **Next**. |
|||
|
|||
<aside> |
|||
|
|||
***NOTE***: You may get a Windows Defender Smart Screen pop up, this is a known thing, just accept and run anyway. |
|||
|
|||
</aside> |
|||
4. It will then look for an existing Syncthing instance to pull settings from, but will likely fail to do so if you are here. Regardless, select the **Yes, continue configuration** option. |
|||
5. Select ***Start Syncthing application that is built into Syncthing Tray***, this means it will use a built in Syncthing executable rather than relying on an externally provided one. Press **Next** to continue. |
|||
6. Check the box to start Syncthing Tray on login - as the name implies, this means the program will run automatically whenever you log onto the computer. Press Next to continue. |
|||
7. You will now be presented with a confirmation window with your selections, confirm they are what you want and hit **Apply** to continue. |
|||
8. You will now be prompted with a confirmation window and a message to allow it through the firewall. Allow the access through the firewall to close that pop up. The confirmation screen has a QR code and the devices identifier - you will need one of these to add other devices to the sync system. |
|||
9. *Syncthing/Syncthing Tray* are now installed. |
|||
|
|||
#### Configuring this Machine as a Parent |
|||
|
|||
Use this when you want to set this machine as the initial source of truth (push files out to all the other devices). Afterwards they will all be equal partners, not a parent/child relationship, this just helps with initial setup. |
|||
|
|||
1. Right-Click the *Syncthing* Tray icon in your taskbar and select **Open Syncthing.** |
|||
2. You will now have a browser window open up to a web GUI to configure *Syncthing*. You will get a pop up about allowing anonymous usage and setting a password, make your selections to close them. |
|||
3. We’ll start by adding the folder with our save files that we want to sync by Pressing **+ Add Folder**. |
|||
4. A pop-up window will appear, fill in the Folder label field with whatever you want to call it, like Switch Saves. |
|||
5. Enter the Full folder path to where your save files are stored on this machine. |
|||
|
|||
<aside> |
|||
|
|||
***TIP***: The easiest way to do this would be to open Eden, right-click a game that has a save, hit ***Open Save Data Location,*** and then go up 1 directory. It should contain folders with the TitleID of your games. |
|||
|
|||
It should look similar to this: ..*\nand\user\save\0000000000000000\EC573727F509799675F6E5112C581D7E* |
|||
|
|||
</aside> |
|||
|
|||
6. Ignore the other tabs for now and hit **Save**. |
|||
7. The folder is now ready to be shared with other devices. |
|||
|
|||
#### Configuring this Machine as a Child |
|||
|
|||
Use this when you want to set this machine up as a child (pull files from the other devices). Afterwards they will all be equal partners, not a parent/child relationship, this just helps with initial setup. |
|||
|
|||
1. Install Syncthing Tray on the client device following the section above. Copy the child’s ID and store it so it is accessible to the Parent. |
|||
2. ***ON THE PARENT***: Right-Click the *Syncthing* Tray icon in your taskbar and select **Open Syncthing** if it is not open already**.** |
|||
3. You will now have a browser window open up to a web GUI to configure *Syncthing*. You will get a pop up about allowing anonymous usage and setting a password, make your selections to close them. |
|||
4. Navigate down to **+ Add Remote Device**, we are going to add our Child device, so I hope you have its ID handy. If not, go back and get it. |
|||
5. Add the ID and Name the device, the device may appear as a **nearby device**, in which case you can just click it to pre-populate the Device ID. |
|||
6. Click the **Sharing** Tab, and check the box next to the folder you set up on the Parent (Switch Saves in my case). Hit **Save.** |
|||
7. We are done with the parent, now **SWITCH OVER TO THE CHILD.** |
|||
8. ***ON THE CHILD***: Right-Click the *Syncthing* Tray icon in your taskbar and select **Open Syncthing** if it is not open already**.** |
|||
9. You should now see a connection request from the parent. Hit **+ Add Device** to add the device. |
|||
10. Hit **Save** to finish adding the device. |
|||
11. That pop-up will close and you will get notification that the device wants to share a folder now. Hit **Add.** |
|||
12. Enter the path to the save folder in Eden and hit **Save.** |
|||
|
|||
<aside> |
|||
|
|||
***TIP***: The easiest way to do this would be to open Eden, right-click a game that has a save, hit ***Open Save Data Location,*** and then go up 1 directory. It should contain folders with the TitleID of your games. |
|||
|
|||
It should look similar to this: ..*\nand\user\save\0000000000000000\EC573727F509799675F6E5112C581D7E* |
|||
|
|||
</aside> |
|||
|
|||
13. *Syncthing* will now pull all the files from the Parent and store them in your local save directory. At this point the files are in sync and alterations to one will affect the other and both can be considered “*Parents*” for other devices you want to add. Repeat these steps for as many devices you want. |
|||
|
|||
## Linux |
|||
|
|||
### Pre-Requisites |
|||
|
|||
- Eden already installed, configured, and functioning. |
|||
|
|||
### Step 1: Downloading and Installing Syncthing |
|||
|
|||
<aside> |
|||
|
|||
***WARNING***: You should manually back up your save files before proceeding with this guide. If you incorrectly perform the steps, you risk losing them! |
|||
|
|||
</aside> |
|||
|
|||
<aside> |
|||
|
|||
***NOTE***: I am using Linux Mint for my guides, but the steps should translate pretty easily to your distro. I ***hope*** that if you are running Linux you know the basic operations. Steam Deck users should follow the guide specific to that platform. |
|||
|
|||
</aside> |
|||
|
|||
1. Download [*Syncthing Tray*](https://flathub.org/en/apps/io.github.martchus.syncthingtray) from the Flatpak store. |
|||
2. Launch *Syncthing Tray* to run it, select the **Start guided setup** on the splash screen that appears and press **Next**. |
|||
3. It will then look for an existing *Syncthing* instance to pull settings from, but will likely fail to do so if you are here. Regardless, select the **Yes, continue configuration** option. |
|||
4. Select ***Start installed Syncthing application via Syncthing Tray***, this means it will use a built in Syncthing executable rather than relying on an externally provided one. Press **Next** to continue. |
|||
5. You will now be presented with a confirmation window with your selections, confirm they are what you want and hit **Apply** to continue. |
|||
6. You will now be prompted with a confirmation window that has a QR code and the devices identifier - you will need one of these to add other devices to the sync system. |
|||
7. *Syncthing/Syncthing Tray* are now installed. Press Finish to close the pop up. |
|||
<aside> |
|||
|
|||
***NOTE***: By default due to flatpak sandboxing limitations, Syncthing Tray will not run automatically on login. You can get around this by following the [*instructions here*](https://github.com/flathub/io.github.martchus.syncthingtray). |
|||
|
|||
</aside> |
|||
|
|||
### Step 2: Configuring this Machine as a Parent |
|||
|
|||
Use this when you want to set this machine as the initial source of truth (push files out to all the other devices). Afterwards they will all be equal partners, not a parent/child relationship, this just helps with initial setup. |
|||
|
|||
1. Right-Click the *Syncthing* Tray icon in your taskbar and select **Open Syncthing.** |
|||
1. If you don’t have a taskbar in your distro, you can also reach it directly by opening a web browser to: *http://127.0.0.1:8384/.* |
|||
2. You will now have a browser window open up to a web GUI to configure *Syncthing*. You will get a pop up about allowing anonymous usage and setting a password, make your selections to close them. |
|||
3. We’ll start by adding the folder with our save files that we want to sync by Pressing **+ Add Folder**. |
|||
4. A pop-up window will appear, fill in the Folder label field with whatever you want to call it, like Switch Saves. |
|||
5. Enter the Full folder path to where your save files are stored on this machine. |
|||
|
|||
<aside> |
|||
|
|||
***TIP***: The easiest way to do this would be to open Eden, right-click a game that has a save, hit ***Open Save Data Location,*** and then go up 1 directory. It should contain folders with the TitleID of your games. |
|||
|
|||
It should look similar to this: ..*\nand\user\save\0000000000000000\EC573727F509799675F6E5112C581D7E* |
|||
|
|||
</aside> |
|||
|
|||
6. Ignore the other tabs for now and hit **Save**. |
|||
7. The folder is now ready to be shared with other devices. |
|||
|
|||
### Step 3: Configuring this Machine as a Child |
|||
|
|||
Use this when you want to set this machine up as a child (pull files from the other devices). Afterwards they will all be equal partners, not a parent/child relationship, this just helps with initial setup. |
|||
|
|||
1. Install Syncthing Tray on the client device following the section above. Copy the child’s ID and store it so it is accessible to the Parent. |
|||
2. ***ON THE PARENT***: Right-Click the *Syncthing* Tray icon in your taskbar and select **Open Syncthing** if it is not open already**.** |
|||
3. You will now have a browser window open up to a web GUI to configure *Syncthing*. You will get a pop up about allowing anonymous usage and setting a password, make your selections to close them. |
|||
4. Navigate down to **+ Add Remote Device**, we are going to add our Child device, so I hope you have its ID handy. If not, go back and get it. |
|||
5. Add the ID and Name the device, the device may appear as a **nearby device**, in which case you can just click it to pre-populate the Device ID. |
|||
6. Click the **Sharing** Tab, and check the box next to the folder you set up on the Parent (Switch Saves in my case). Hit **Save.** |
|||
7. We are done with the parent, now **SWITCH OVER TO THE CHILD.** |
|||
8. ***ON THE CHILD***: Right-Click the *Syncthing* Tray icon in your taskbar and select **Open Syncthing** if it is not open already. |
|||
9. You should now see a connection request pop-up from the parent. Hit **+ Add Device** to add the device. |
|||
10. Hit **Save** to finish adding the device. |
|||
11. That pop-up will close and you will get notification that the device wants to share a folder now. Hit **Add.** |
|||
12. Enter the path to the save folder in Eden and hit **Save.** |
|||
|
|||
<aside> |
|||
|
|||
***TIP***: The easiest way to do this would be to open Eden, right-click a game that has a save, hit ***Open Save Data Location,*** and then go up 1 directory. It should contain folders with the TitleID of your games. |
|||
|
|||
It should look similar to this: ..*\nand\user\save\0000000000000000\EC573727F509799675F6E5112C581D7E* |
|||
|
|||
</aside> |
|||
|
|||
13. *Syncthing* will now pull all the files from the Parent and store them in your local save directory. At this point the files are in sync and alterations to one will affect the other and both can be considered “*Parents*” for other devices you want to add. Repeat these steps for as many devices you want. |
|||
@ -1,66 +0,0 @@ |
|||
# Backing Up/Syncing Eden Game Saves |
|||
|
|||
Use this guide for when you want to configure automated backup/syncing of your Eden save files using [*Syncthing*](https://syncthing.net/). |
|||
|
|||
**Click [Here](https://evilperson1337.notion.site/Backing-Up-Syncing-Eden-Game-Saves-2b357c2edaf68000b40cfab2c2c3dc0a) for a version of this guide with images & visual elements.** |
|||
|
|||
--- |
|||
|
|||
### Pre-Requisites |
|||
|
|||
- Eden already installed, configured, and functioning. |
|||
- Devices to run Syncthing on. |
|||
- Ability to allow a program to communicate through the firewall of your device. |
|||
|
|||
--- |
|||
|
|||
## Platform Specific Setup Guides |
|||
|
|||
- [*Windows*](./SyncthingGuide_Windows.md) |
|||
- *MacOS (Coming Soon)* |
|||
- *Steam Deck (Coming Soon)* |
|||
- *Android (Coming Soon)* |
|||
- [*Linux*](./SyncthingGuide_Linux.md) |
|||
|
|||
--- |
|||
|
|||
## A Few Notes Before You Proceed |
|||
|
|||
<aside> |
|||
|
|||
***WARNING***: You should manually back up your save files before proceeding with this guide. If you incorrectly perform the steps, you risk losing them! |
|||
|
|||
</aside> |
|||
|
|||
- While this is a de-centralized model without the concepts of a Server/Client, Parent/Child, etc. - For the purposes of these guides, we will borrow from this models terminology to avoid sync conflicts and potential data loss. After the initial setup, all the devices in the sync network are equals and can push & pull files from any other device. |
|||
- In order for this to work, you should get all of the save files in Eden in the save folder on the Parent. |
|||
- If you need help doing that, see the ***Importing Saves into Eden*** guide for the platform you elect to act as the Parent, and delete the save files on the "Child" devices. |
|||
|
|||
### Terminology |
|||
|
|||
- **Sync Network**: All the devices configured in *Syncthing* to push/pull files. |
|||
- **Parent**: This will be the device that you elect to push files to the other devices. There can only be one here initially in order to avoid sync conflicts. |
|||
- **Child**: All the other devices added to the Sync Network. These devices will pull files from the Parent. |
|||
|
|||
--- |
|||
|
|||
## Overview |
|||
|
|||
Rather than giving a breakdown of all the platforms and configurations, those will be in the platform’s specific guides - this will serve as a general overview of Syncthing. |
|||
|
|||
--- |
|||
|
|||
### What is Syncthing Anyway? |
|||
|
|||
Syncthing is a continuous file synchronization program (in the layman’s - make sure 2 or more systems with the same files are always up to date). This is perfect for game saves where we would want to play on 1 device, save our game, and then continue playing it on another device. This technology is what Epic/Steam/etc. use to allow you to do this on games run through their respective services. Syncthing is an open source implementation of this technology that you control, rather than relying on a 3rd party. This has a few key benefits, most notably - better security, privacy, and speed (when on your LAN). |
|||
|
|||
--- |
|||
|
|||
### What are some common issues? |
|||
|
|||
Syncthing is fairly robust and doesn’t have many issues luckily, but there are some things you should watch out for (almost all of them a user issue). |
|||
|
|||
- Sync conflicts |
|||
- If for whatever reason you update the same file on 2 different machines, the system does not know which updated file is considered the one to sync across. This results in a ***sync conflict*** where it may not sync the files as you would expect. Worst case scenario, this can result in your save progress being lost if you are not careful. When one of these occurs, it will create a copy of the file and store it with a specific name, like this example, *Paper Mario.sync-conflict-20251102-072925-TZBBN6S.srm.* To resolve this, you must remove the other files and remove the *.sync-conflict-<TIMESTAMP>-<Syncthing Device ID>* from the file name of the file you want to keep. |
|||
- Accidental Deletions |
|||
- If you delete a file from one of the devices, it will also remove the file on the other devices when they perform a sync so be careful when doing this. |
|||
@ -1,96 +0,0 @@ |
|||
# Backing Up/Syncing Eden Game Saves |
|||
|
|||
Use this guide for when you want to configure automated backup/syncing of your Eden save files using [*Syncthing*](https://syncthing.net/) on Linux. |
|||
|
|||
**Click [Here](https://evilperson1337.notion.site/Backing-Up-Syncing-Eden-Game-Saves-2b057c2edaf680fc8a28eba5a05fd7a3) for a version of this guide with images & visual elements.** |
|||
|
|||
--- |
|||
|
|||
### Pre-Requisites |
|||
|
|||
- Read the [*Syncthing General Guide*](./SyncthingGuide_General.md). |
|||
- Eden already installed, configured, and functioning. |
|||
|
|||
--- |
|||
|
|||
## Steps |
|||
|
|||
<aside> |
|||
|
|||
***WARNING***: You should manually back up your save files before proceeding with this guide. If you incorrectly perform the steps, you risk losing them! |
|||
|
|||
</aside> |
|||
|
|||
<aside> |
|||
|
|||
***NOTE***: I am using Linux Mint for my guides, but the steps should translate pretty easily to your distro. I ***hope*** that if you are running Linux you know the basic operations. Steam Deck users should follow the guide specific to that platform. |
|||
|
|||
</aside> |
|||
|
|||
### Downloading and Installing Syncthing |
|||
|
|||
1. Download [*Syncthing Tray*](https://flathub.org/en/apps/io.github.martchus.syncthingtray) from the Flatpak store. |
|||
2. Launch *Syncthing Tray* to run it, select the **Start guided setup** on the splash screen that appears and press **Next**. |
|||
3. It will then look for an existing *Syncthing* instance to pull settings from, but will likely fail to do so if you are here. Regardless, select the **Yes, continue configuration** option. |
|||
4. Select ***Start installed Syncthing application via Syncthing Tray***, this means it will use a built in Syncthing executable rather than relying on an externally provided one. Press **Next** to continue. |
|||
5. You will now be presented with a confirmation window with your selections, confirm they are what you want and hit **Apply** to continue. |
|||
6. You will now be prompted with a confirmation window that has a QR code and the devices identifier - you will need one of these to add other devices to the sync system. |
|||
7. *Syncthing/Syncthing Tray* are now installed. Press Finish to close the pop up. |
|||
<aside> |
|||
|
|||
***NOTE***: By default due to flatpak sandboxing limitations, Syncthing Tray will not run automatically on login. You can get around this by following the [*instructions here*](https://github.com/flathub/io.github.martchus.syncthingtray). |
|||
|
|||
</aside> |
|||
|
|||
--- |
|||
|
|||
### Configuring this Machine as a Parent |
|||
|
|||
Use this when you want to set this machine as the initial source of truth (push files out to all the other devices). Afterwards they will all be equal partners, not a parent/child relationship, this just helps with initial setup. |
|||
|
|||
1. Right-Click the *Syncthing* Tray icon in your taskbar and select **Open Syncthing.** |
|||
1. If you don’t have a taskbar in your distro, you can also reach it directly by opening a web browser to: *http://127.0.0.1:8384/.* |
|||
2. You will now have a browser window open up to a web GUI to configure *Syncthing*. You will get a pop up about allowing anonymous usage and setting a password, make your selections to close them. |
|||
3. We’ll start by adding the folder with our save files that we want to sync by Pressing **+ Add Folder**. |
|||
4. A pop-up window will appear, fill in the Folder label field with whatever you want to call it, like Switch Saves. |
|||
5. Enter the Full folder path to where your save files are stored on this machine. |
|||
|
|||
<aside> |
|||
|
|||
***TIP***: The easiest way to do this would be to open Eden, right-click a game that has a save, hit ***Open Save Data Location,*** and then go up 1 directory. It should contain folders with the TitleID of your games. |
|||
|
|||
It should look similar to this: ..*\nand\user\save\0000000000000000\EC573727F509799675F6E5112C581D7E* |
|||
|
|||
</aside> |
|||
|
|||
6. Ignore the other tabs for now and hit **Save**. |
|||
7. The folder is now ready to be shared with other devices. |
|||
|
|||
--- |
|||
|
|||
### Configuring this Machine as a Child |
|||
|
|||
Use this when you want to set this machine up as a child (pull files from the other devices). Afterwards they will all be equal partners, not a parent/child relationship, this just helps with initial setup. |
|||
|
|||
1. Install Syncthing Tray on the client device following the section above. Copy the child’s ID and store it so it is accessible to the Parent. |
|||
2. ***ON THE PARENT***: Right-Click the *Syncthing* Tray icon in your taskbar and select **Open Syncthing** if it is not open already**.** |
|||
3. You will now have a browser window open up to a web GUI to configure *Syncthing*. You will get a pop up about allowing anonymous usage and setting a password, make your selections to close them. |
|||
4. Navigate down to **+ Add Remote Device**, we are going to add our Child device, so I hope you have its ID handy. If not, go back and get it. |
|||
5. Add the ID and Name the device, the device may appear as a **nearby device**, in which case you can just click it to pre-populate the Device ID. |
|||
6. Click the **Sharing** Tab, and check the box next to the folder you set up on the Parent (Switch Saves in my case). Hit **Save.** |
|||
7. We are done with the parent, now **SWITCH OVER TO THE CHILD.** |
|||
8. ***ON THE CHILD***: Right-Click the *Syncthing* Tray icon in your taskbar and select **Open Syncthing** if it is not open already. |
|||
9. You should now see a connection request pop-up from the parent. Hit **+ Add Device** to add the device. |
|||
10. Hit **Save** to finish adding the device. |
|||
11. That pop-up will close and you will get notification that the device wants to share a folder now. Hit **Add.** |
|||
12. Enter the path to the save folder in Eden and hit **Save.** |
|||
|
|||
<aside> |
|||
|
|||
***TIP***: The easiest way to do this would be to open Eden, right-click a game that has a save, hit ***Open Save Data Location,*** and then go up 1 directory. It should contain folders with the TitleID of your games. |
|||
|
|||
It should look similar to this: ..*\nand\user\save\0000000000000000\EC573727F509799675F6E5112C581D7E* |
|||
|
|||
</aside> |
|||
|
|||
13. *Syncthing* will now pull all the files from the Parent and store them in your local save directory. At this point the files are in sync and alterations to one will affect the other and both can be considered “*Parents*” for other devices you want to add. Repeat these steps for as many devices you want. |
|||
@ -1,95 +0,0 @@ |
|||
# Backing Up/Syncing Eden Game Saves |
|||
|
|||
Use this guide for when you want to configure automated backup/syncing of your Eden save files using [*Syncthing](https://syncthing.net/)* on Windows. |
|||
|
|||
**Click [Here](https://evilperson1337.notion.site/Backing-Up-Syncing-Eden-Game-Saves-2b057c2edaf680f5aa9cd1c4f97121ce) for a version of this guide with images & visual elements.** |
|||
|
|||
--- |
|||
|
|||
### Pre-Requisites |
|||
|
|||
- Read the [*Syncthing General Guide*](./SyncthingGuide_General.md). |
|||
- Eden already installed, configured, and functioning. |
|||
- Ability to allow a program to communicate through the firewall in Windows. |
|||
- Ability to extract archive (.zip/.7z/.rar) files. |
|||
|
|||
--- |
|||
|
|||
## Steps |
|||
|
|||
<aside> |
|||
|
|||
***WARNING***: You should manually back up your save files before proceeding with this guide. If you incorrectly perform the steps, you risk losing them! |
|||
|
|||
</aside> |
|||
|
|||
### Downloading and Installing *Syncthing* |
|||
|
|||
1. Download [*Syncthing Tray*](https://martchus.github.io/syncthingtray/#downloads-section). |
|||
1. While it is available as a command line interface, for most people I would recommend *Syncthing Tray* on Windows. For most people here, you would download the **64-bit (Intel/AMD)** version. |
|||
2. Open the downloaded archive and extract the **syncthingtray.exe** to wherever you want to store the executable. |
|||
3. Double-Click the application to run it, select the **Start guided setup** on the splash screen that appears and press **Next**. |
|||
|
|||
<aside> |
|||
|
|||
***NOTE***: You may get a Windows Defender Smart Screen pop up, this is a known thing, just accept and run anyway. |
|||
|
|||
</aside> |
|||
4. It will then look for an existing Syncthing instance to pull settings from, but will likely fail to do so if you are here. Regardless, select the **Yes, continue configuration** option. |
|||
5. Select ***Start Syncthing application that is built into Syncthing Tray***, this means it will use a built in Syncthing executable rather than relying on an externally provided one. Press **Next** to continue. |
|||
6. Check the box to start Syncthing Tray on login - as the name implies, this means the program will run automatically whenever you log onto the computer. Press Next to continue. |
|||
7. You will now be presented with a confirmation window with your selections, confirm they are what you want and hit **Apply** to continue. |
|||
8. You will now be prompted with a confirmation window and a message to allow it through the firewall. Allow the access through the firewall to close that pop up. The confirmation screen has a QR code and the devices identifier - you will need one of these to add other devices to the sync system. |
|||
9. *Syncthing/Syncthing Tray* are now installed. |
|||
|
|||
--- |
|||
|
|||
### Configuring this Machine as a Parent |
|||
|
|||
Use this when you want to set this machine as the initial source of truth (push files out to all the other devices). Afterwards they will all be equal partners, not a parent/child relationship, this just helps with initial setup. |
|||
|
|||
1. Right-Click the *Syncthing* Tray icon in your taskbar and select **Open Syncthing.** |
|||
2. You will now have a browser window open up to a web GUI to configure *Syncthing*. You will get a pop up about allowing anonymous usage and setting a password, make your selections to close them. |
|||
3. We’ll start by adding the folder with our save files that we want to sync by Pressing **+ Add Folder**. |
|||
4. A pop-up window will appear, fill in the Folder label field with whatever you want to call it, like Switch Saves. |
|||
5. Enter the Full folder path to where your save files are stored on this machine. |
|||
|
|||
<aside> |
|||
|
|||
***TIP***: The easiest way to do this would be to open Eden, right-click a game that has a save, hit ***Open Save Data Location,*** and then go up 1 directory. It should contain folders with the TitleID of your games. |
|||
|
|||
It should look similar to this: ..*\nand\user\save\0000000000000000\EC573727F509799675F6E5112C581D7E* |
|||
|
|||
</aside> |
|||
|
|||
6. Ignore the other tabs for now and hit **Save**. |
|||
7. The folder is now ready to be shared with other devices. |
|||
|
|||
--- |
|||
|
|||
### Configuring this Machine as a Child |
|||
|
|||
Use this when you want to set this machine up as a child (pull files from the other devices). Afterwards they will all be equal partners, not a parent/child relationship, this just helps with initial setup. |
|||
|
|||
1. Install Syncthing Tray on the client device following the section above. Copy the child’s ID and store it so it is accessible to the Parent. |
|||
2. ***ON THE PARENT***: Right-Click the *Syncthing* Tray icon in your taskbar and select **Open Syncthing** if it is not open already**.** |
|||
3. You will now have a browser window open up to a web GUI to configure *Syncthing*. You will get a pop up about allowing anonymous usage and setting a password, make your selections to close them. |
|||
4. Navigate down to **+ Add Remote Device**, we are going to add our Child device, so I hope you have its ID handy. If not, go back and get it. |
|||
5. Add the ID and Name the device, the device may appear as a **nearby device**, in which case you can just click it to pre-populate the Device ID. |
|||
6. Click the **Sharing** Tab, and check the box next to the folder you set up on the Parent (Switch Saves in my case). Hit **Save.** |
|||
7. We are done with the parent, now **SWITCH OVER TO THE CHILD.** |
|||
8. ***ON THE CHILD***: Right-Click the *Syncthing* Tray icon in your taskbar and select **Open Syncthing** if it is not open already**.** |
|||
9. You should now see a connection request from the parent. Hit **+ Add Device** to add the device. |
|||
10. Hit **Save** to finish adding the device. |
|||
11. That pop-up will close and you will get notification that the device wants to share a folder now. Hit **Add.** |
|||
12. Enter the path to the save folder in Eden and hit **Save.** |
|||
|
|||
<aside> |
|||
|
|||
***TIP***: The easiest way to do this would be to open Eden, right-click a game that has a save, hit ***Open Save Data Location,*** and then go up 1 directory. It should contain folders with the TitleID of your games. |
|||
|
|||
It should look similar to this: ..*\nand\user\save\0000000000000000\EC573727F509799675F6E5112C581D7E* |
|||
|
|||
</aside> |
|||
|
|||
13. *Syncthing* will now pull all the files from the Parent and store them in your local save directory. At this point the files are in sync and alterations to one will affect the other and both can be considered “*Parents*” for other devices you want to add. Repeat these steps for as many devices you want. |
|||
@ -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. |
|||
|
|||
<aside> |
|||
|
|||
***TIP***: The easiest way I have found to find the Build ID is by Right-Clicking the game **IN RYUJINX** and hitting **Manage Cheats**. Your Build ID will be displayed at the top. |
|||
|
|||
Another option would be to launch the game in Eden and close it - then go into the log and look for a line like this - the first 16 characters if your Build ID. **Make sure that it is the MAIN line**. |
|||
`[ 27.098382] Loader <Info> core/file_sys/patch_manager.cpp:HasNSOPatch:304: Querying NSO patch existence for build_id=AEE6DCCC06D9C05B42061E2019123A61, name=main` |
|||
|
|||
</aside> |
|||
|
|||
## 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. `<mod_location>/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. |
|||
Write
Preview
Loading…
Cancel
Save
Reference in new issue