1
0
mirror of https://github.com/ppy/osu.git synced 2026-06-09 01:43:39 +08:00

Attempt to give users better disclaimer on how not to nuke their data

I can't count the number of times where someone backed up just the file
store without the realm database and lost data. As such this moves the
"IMPORTANT READ ME" disclaimer a directory higher and attempts to
describe the "proper" backup procedure in detail.

People don't read, but maybe this will at least partially lower the
volume.
This commit is contained in:
Bartłomiej Dach
2025-05-22 19:13:55 +02:00
Unverified
parent c632383ccb
commit 6a3e9a9093
+10 -8
View File
@@ -437,20 +437,22 @@ namespace osu.Game
private void addFilesWarning()
{
var realmStore = new RealmFileStore(realm, Storage);
const string filename = "IMPORTANT READ ME.txt";
if (!realmStore.Storage.Exists(filename))
if (!Storage.Exists(filename))
{
using (var stream = realmStore.Storage.CreateFileSafely(filename))
using (var stream = Storage.CreateFileSafely(filename))
using (var textWriter = new StreamWriter(stream))
{
textWriter.WriteLine(@"This folder contains all your user files (beatmaps, skins, replays etc.)");
textWriter.WriteLine(@"Please do not touch or delete this folder!!");
textWriter.WriteLine(@"This folder contains all your user files and configuration.");
textWriter.WriteLine(@"Please DO NOT make manual changes to this folder.");
textWriter.WriteLine();
textWriter.WriteLine(@"If you are really looking to completely delete user data, please delete");
textWriter.WriteLine(@"the parent folder including all other files and directories");
textWriter.WriteLine(@"The files/ directory inside this directory stores all of your beatmaps, skins, and replays.");
textWriter.WriteLine(@"It is NOT a cache. If you delete it, YOU WILL LOSE DATA.");
textWriter.WriteLine(@"It is NOT ENOUGH to migrate your game files to another PC. If you copy only the files/ directory, YOU WILL LOSE DATA.");
textWriter.WriteLine();
textWriter.WriteLine(@"If you want to back up your game files, please back up THE ENTIRETY OF THIS DIRECTORY.");
textWriter.WriteLine(@"If you want to delete all of your game files, please delete THE ENTIRETY OF THIS DIRECTORY.");
textWriter.WriteLine();
textWriter.WriteLine(@"For more information on how these files are organised,");
textWriter.WriteLine(@"see https://github.com/ppy/osu/wiki/User-file-storage");