From 6a3e9a90939ebfa2aad8d110454dbc335f9bfef3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bart=C5=82omiej=20Dach?= Date: Thu, 22 May 2025 19:13:55 +0200 Subject: [PATCH] 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. --- osu.Game/OsuGameBase.cs | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/osu.Game/OsuGameBase.cs b/osu.Game/OsuGameBase.cs index 4cc9ab7936..1b2240aed2 100644 --- a/osu.Game/OsuGameBase.cs +++ b/osu.Game/OsuGameBase.cs @@ -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");