Wiki/wiki-rtd/docs/wiki_management/spread-files.md

89 lines
3.9 KiB
Markdown
Raw Normal View History

2024-01-21 11:12:42 +00:00
# Spreading Files over multiple drivers
2024-01-21 10:28:36 +00:00
<img src="../../wiki_icons/pixelitos/folder-blue-games.png" width="50">
2024-01-21 11:21:01 +00:00
## About Symbolic Links
2024-01-21 11:12:42 +00:00
Spreading files over other:
2024-01-21 10:28:54 +00:00
2024-01-21 11:12:42 +00:00
- Internal drives
- External drives
- NAS
- Other
2024-01-21 10:28:36 +00:00
2024-01-21 11:12:42 +00:00
Can be done with `Symbolic Links`.
2024-01-21 10:28:36 +00:00
2024-01-21 11:12:42 +00:00
For more technical details - read more about [Symbolic Links on Wikipedia](https://en.wikipedia.org/wiki/Symbolic_link)
2024-01-21 10:28:36 +00:00
2024-01-21 11:16:37 +00:00
If you are used to a Windows environment `Symbolic Links` are NOT the same as `Windows Shortcuts`.
2024-01-21 10:28:36 +00:00
2024-01-21 11:12:42 +00:00
A `Symbolic Link` act as the file was in the place you are linking to and the software will interpret it as such.
2024-01-21 10:28:36 +00:00
2024-01-21 11:12:42 +00:00
We later plan to add tools for this in the `RetroDECK Configurator` to make it even easier.
2024-01-21 10:28:36 +00:00
2024-01-21 11:19:51 +00:00
### 🛑 Symbolic Link: Warnings 🛑
2024-01-21 10:28:36 +00:00
2024-01-21 11:19:51 +00:00
- You should not have RetroDECK open while creating the `Symbolic Links` as the games are loaded on launch.
2024-01-21 11:23:11 +00:00
- When you have successfully added a `Symbolic Link` to RetroDECK and got it working, remember to never unplug / disconnect the drive while RetroDECK is running.
2024-01-21 11:19:51 +00:00
- If you are making changes to your `Symbolic Links` you must close down RetroDECK, make the changes and then relaunch it.
2024-01-21 10:28:36 +00:00
2024-01-21 11:12:42 +00:00
### Other recommendations
2024-01-21 10:28:36 +00:00
2024-01-21 11:29:42 +00:00
If you are on a Steam Deck, this needs to be done in `Desktop Mode`.
On the drive you want to add to RetroDECK. it is recommended to create a folder or folders games per system, so you don't need to create `Symbolic Link` for each game. But rather just make a link to the folder.
If you want to spread games for one system over a multiple of drivers with `Symbolic Links` you can do so, but naming the folders so you understand what drive they are coming from could be a good recommendation.
Each folder added will then be interpreted as a subfolder within RetroDECK's ES-DE interface under the system you have added the `Symbolic Link` to.
2024-01-21 10:28:36 +00:00
2024-01-21 11:12:42 +00:00
## Creating Symbolic Links: Example Wii Games
2024-01-21 10:28:36 +00:00
2024-01-21 11:12:42 +00:00
This example will be written from the standpoint of the KDE Desktop environment used by SteamOS and many others systems. If you are on Gnome/XFCE or any other desktop environment the procedure should be similar else consult your desktop environment website.
2024-01-21 10:28:36 +00:00
2024-01-21 11:12:42 +00:00
**Example problem:**
2024-01-21 10:28:36 +00:00
2024-01-21 11:12:42 +00:00
You have several backups of Wii games you want to add to `~/retrodeck/roms/wii/`.
2024-01-21 10:28:36 +00:00
2024-01-21 11:12:42 +00:00
Let's say that those backups are on an external called `2nddrive` drive in in a folder called `wii games`.
2024-01-21 10:28:36 +00:00
2024-01-21 11:12:42 +00:00
So the path when you go into the folder from the Desktop GUI could be (in this example):
2024-01-21 10:28:36 +00:00
2024-01-21 11:12:42 +00:00
`/var/mnt/2nddrive/wii games`
2024-01-21 10:28:36 +00:00
2024-01-21 11:12:42 +00:00
### Creating from the GUI
2024-01-21 10:28:36 +00:00
2024-01-21 11:12:42 +00:00
1. Go into your `~/retrodeck/roms/wii/` folder.
2. `Right Click` on an empty space and press `Create New` - `Link to file or folder`.
3. Press the open file browser button.
4. Press `Folder`.
5. Navigate to the `/var/mnt/2nddrive/wii games` folder (or where ever you store the games).
6. Highlight the `wii games` folder and press OK.
Now the Symbolic Link has been created and will show up in the ES-DE interface for RetroDECK.
When you navigate to wii game section the `wii games` folder should be accessible from the ES-DE menu as a subfolder with all the games.
### Other files
You can also link other files this way such as individual games instead of folders or save files etc...
2024-01-21 11:36:35 +00:00
## Advanced Usage: Replacing entire systems or functions with Symbolic Links
**Disclaimer: Not Recommended!**
2024-01-21 11:12:42 +00:00
Do not do this unless you really really know what you are doing and this might be a hit or miss depending on your system.
2024-01-21 11:36:35 +00:00
This is not something we recommend doing as upcoming updates to RetroDECK could cause link breakage.
But if you like to tinker and experiment feel free to try it on your own.
### The usecase
2024-01-21 11:12:42 +00:00
You could in theory delete a system folder lets say `~/retrodeck/roms/wii/` or even a `~/retrodeck/roms/saves/wii/` or `~/retrodeck/roms/states/wii/` or what ever folder or subfolder under `~/retrodeck/` and put is as a symbolic link to another place.
**Example Wii:**
Create a symbolic link from `~/retrodeck/roms/` to a folder on an external drive called `wii` and only have those games stored on an external drive permanently.
2024-01-21 10:28:36 +00:00