aboutsummaryrefslogtreecommitdiff
path: root/docs/user
diff options
context:
space:
mode:
authorlizzie <lizzie@eden-emu.dev>2025-10-22 00:57:42 +0200
committercrueter <crueter@eden-emu.dev>2025-10-22 00:57:42 +0200
commit6ff043c4fbd5dae5e0b1ec73a3bb4003e8cef20b (patch)
treecd64c8fff5e1e1381d054f4e3b083ae0b5faec84 /docs/user
parent86432f95520bac02fad724b58c0cb6c76ffadc93 (diff)
[core/filesystem] "easier" cheats folder structure like Ryujinx (#2795)
Less annoying way to make cheats Signed-off-by: lizzie <lizzie@eden-emu.dev> Reviewed-on: https://git.eden-emu.dev/eden-emu/eden/pulls/2795 Co-authored-by: lizzie <lizzie@eden-emu.dev> Co-committed-by: lizzie <lizzie@eden-emu.dev>
Diffstat (limited to 'docs/user')
-rw-r--r--docs/user/Storage.md39
1 files changed, 39 insertions, 0 deletions
diff --git a/docs/user/Storage.md b/docs/user/Storage.md
new file mode 100644
index 0000000000..1719bd967c
--- /dev/null
+++ b/docs/user/Storage.md
@@ -0,0 +1,39 @@
+# User Handbook - Data, savefiles and storage
+
+## Cheats
+
+Cheats can be placed in the two manners:
+
+**Method 1**:
+- Right click on "Open mod directory"
+- Create a file called `cheat_mycheat.txt` (the file must start with `cheat_` to be recognized as one)
+- Write the cheat into said text file
+- Done
+
+This method doesn't account for build IDs, so any cheats for previous builds will not be automatically filtered out.
+
+**Method 2**:
+- Right click on "Open mod directory"
+- Create a folder called `My cheat`
+- Inside said folder create another one: `cheats`
+- Then inside said folder create a file with the build ID in hexadecimal, lowercase, for example `1234FBCDE0000000.txt`
+- Write the cheat into said text file
+- Done
+
+To delete a cheat simply do the process backwards (delete the folder/file).
+
+## Savefiles
+
+The method to access save data is simple:
+- Right click on "Open save directory"
+
+## Maintaining a library
+
+### ZFS
+
+One of the best ways to keep a gallery of archives is using a ZFS pool compressed with zstd.
+```sh
+sudo zfs create zroot/switch`
+sudo zfs set compression=zstd zroot/switch
+```
+A new ZFS dataset will then be available on `/zroot/switch`. From which then can be added as a normal game directory. Remember to ensure proper permissions with `chmod 755 /zroot/switch/*`.