Skip to content

Commit

Permalink
Add tips for Flatpak users
Browse files Browse the repository at this point in the history
  • Loading branch information
OpenBagTwo committed May 4, 2024
1 parent 4cdfe3e commit a4e1062
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 10 deletions.
26 changes: 17 additions & 9 deletions docs/suggestions.md
Original file line number Diff line number Diff line change
Expand Up @@ -371,6 +371,11 @@ alternative to "cloud saves" for _all_ your games, as any and all files
and folders within your EnderChest folder can be synchronized across all
of the computers where you have EnderChest installed.

!!! danger
Only do this if you sync your EnderChests **religiously**—unlike with, say, Steam cloud saves,
there is nothing in EnderChest's sync routines that check to make sure the data being written
is newer than the data being _overwritten._

For example, let's say I want to share my
[2048](https://flathub.org/apps/org.gnome.TwentyFortyEight)
high scores across all of my machines. Those scores are stored at:
Expand All @@ -380,29 +385,32 @@ I could do is:
1. Create a folder inside EnderChest called "2048" (better: put that folder
inside my [Chest Monster](#chest-monster) or another folder called:
"_Non-Minecraft")
1. Move my game data from its current location into that folder:
1. Move my game data from its current location into that folder, _e.g._
```bash
mv ~/.var/app/org.gnome.TwentyFortyEight/data/gnome-2048/scores $MINECRAFT_ROOT/EnderChest/_Non-Minecraft/2048/.
```
1. Create the symlink:
1. Create the symlink, _e.g._
```bash
ln -s ~/.var/app/org.gnome.TwentyFortyEight/data/gnome-2048/scores $MINECRAFT_ROOT/EnderChest/_Non-Minecraft/2048/.
```

!!! info "PSA for Flatpak users"
When centralizing data for games installed via [Flatpak](https://flatpak.org/)
such as the above, make sure to give those games permission to read from and
write to your centralized game data folder.
Use of [Flatseal](https://flathub.org/apps/com.github.tchx84.Flatseal)
is highly recommended.


Then, on every other computer where I have the game installed, I can just delete
the game data folder and replace it with a symlink:
the game data folder and replace it with a symlink, _e.g._
```bash
rm -r ~/.var/app/org.gnome.TwentyFortyEight/data/gnome-2048/scores
ln -s ~/.var/app/org.gnome.TwentyFortyEight/data/gnome-2048/scores $MINECRAFT_ROOT/EnderChest/_Non-Minecraft/2048/.
```

and my save data will be automatically synchronized.

!!! danger
Only do this if you sync your EnderChests **religiously**—unlike with, say, Steam cloud saves,
there is nothing in EnderChest's sync routines that check to make sure the data being written
is newer than the data being _overwritten._

!!! danger "Note when uninstalling"
Note that these linked files ***will not*** be automatically copied to their original homes
if/when you ["break" your EnderChest](../usage/#uninstalling).
Expand Down Expand Up @@ -552,7 +560,7 @@ and then put:

!!! warning "PSA for Flatpak users"
Note that this **will not work** if your launcher runs in a sandboxed environment
(such as a [flatpak](https://flatpak.org/)), as there is no way to give the launcher
(such as a [Flatpak](https://flatpak.org/)), as there is no way to give the launcher
access to the necessary libraries and executables. Note that
[PrismLauncher](https://prismlauncher.org/download/linux/)
is also avaialable as an [AppImage](https://appimage.org/), which _will_ support
Expand Down
10 changes: 9 additions & 1 deletion docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ for example, tells you how to find the official launcher data. MultiMC-derived
programs like PrismLauncher will often have a
["Folder" button](https://prismlauncher.org/wiki/getting-started/migrating-multimc/)
that will take you to the location of each instance, which is especially helpful
for the flatpak distribution.
for the Flatpak distribution.

## Selecting a "Minecraft Root"

Expand Down Expand Up @@ -72,6 +72,14 @@ it easy to, for example, manually add a tag to an instance.
optifine
```

!!! info "PSA for Flatpak users"
If you're using a launcher installed via Flatpak,
make sure to give it permission to read from and
write to your EnderChest folder, if not your entire
[Minecraft root](#selecting-a-minecraft-root).
Use of [Flatseal](https://flathub.org/apps/com.github.tchx84.Flatseal)
is highly recommended.

### Registering Additional Instances

Once you have an EnderChest installed, you can register additional instances
Expand Down

0 comments on commit a4e1062

Please sign in to comment.