2019-01-24 16:43:03 +08:00
// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
// See the LICENCE file in the repository root for full licence text.
2018-04-13 17:19:50 +08:00
2022-06-17 15:37:17 +08:00
#nullable disable
2018-04-13 17:19:50 +08:00
using System ;
using System.Collections.Generic ;
2022-09-22 11:52:24 +08:00
using System.IO ;
2018-04-13 17:19:50 +08:00
using System.Linq ;
using System.Reflection ;
2021-10-12 15:04:09 +08:00
using System.Threading ;
2022-05-10 15:02:32 +08:00
using System.Threading.Tasks ;
2018-04-13 17:19:50 +08:00
using osu.Framework.Allocation ;
using osu.Framework.Audio ;
2022-05-22 21:15:53 +08:00
using osu.Framework.Audio.Track ;
2019-02-21 18:04:31 +08:00
using osu.Framework.Bindables ;
2023-06-08 07:47:07 +08:00
using osu.Framework.Configuration ;
2019-06-20 11:48:45 +08:00
using osu.Framework.Development ;
2020-07-29 11:39:18 +08:00
using osu.Framework.Extensions ;
2018-04-13 17:19:50 +08:00
using osu.Framework.Graphics ;
using osu.Framework.Graphics.Containers ;
using osu.Framework.Graphics.Textures ;
2018-07-09 14:26:22 +08:00
using osu.Framework.Input ;
2022-01-15 06:16:07 +08:00
using osu.Framework.Input.Handlers ;
2022-10-21 06:52:19 +08:00
using osu.Framework.Input.Handlers.Joystick ;
2022-01-15 06:16:07 +08:00
using osu.Framework.Input.Handlers.Midi ;
2022-10-21 06:52:19 +08:00
using osu.Framework.Input.Handlers.Mouse ;
using osu.Framework.Input.Handlers.Tablet ;
using osu.Framework.Input.Handlers.Touch ;
2021-09-30 23:27:54 +08:00
using osu.Framework.IO.Stores ;
2023-06-08 07:47:07 +08:00
using osu.Framework.Localisation ;
2018-04-13 17:19:50 +08:00
using osu.Framework.Logging ;
2021-09-30 23:27:54 +08:00
using osu.Framework.Platform ;
2022-05-22 21:15:53 +08:00
using osu.Framework.Timing ;
2018-05-09 19:52:46 +08:00
using osu.Game.Audio ;
2021-09-30 23:27:54 +08:00
using osu.Game.Beatmaps ;
2022-05-22 21:15:53 +08:00
using osu.Game.Beatmaps.ControlPoints ;
2022-02-16 15:57:28 +08:00
using osu.Game.Beatmaps.Formats ;
2021-09-30 23:27:54 +08:00
using osu.Game.Configuration ;
2018-04-13 17:19:50 +08:00
using osu.Game.Database ;
2023-06-08 07:47:07 +08:00
using osu.Game.Extensions ;
2021-09-30 23:27:54 +08:00
using osu.Game.Graphics ;
using osu.Game.Graphics.Cursor ;
2018-04-13 17:19:50 +08:00
using osu.Game.Input ;
using osu.Game.Input.Bindings ;
using osu.Game.IO ;
2023-06-08 07:47:07 +08:00
using osu.Game.Localisation ;
2020-12-24 16:58:38 +08:00
using osu.Game.Online ;
2021-09-30 23:27:54 +08:00
using osu.Game.Online.API ;
2021-02-12 13:54:19 +08:00
using osu.Game.Online.Chat ;
2022-07-04 16:18:33 +08:00
using osu.Game.Online.Metadata ;
2020-12-25 12:38:11 +08:00
using osu.Game.Online.Multiplayer ;
2022-12-24 18:20:31 +08:00
using osu.Game.Online.Solo ;
2020-10-22 12:41:54 +08:00
using osu.Game.Online.Spectator ;
2020-08-06 18:01:23 +08:00
using osu.Game.Overlays ;
2022-01-15 06:16:07 +08:00
using osu.Game.Overlays.Settings ;
using osu.Game.Overlays.Settings.Sections ;
2022-10-21 06:52:19 +08:00
using osu.Game.Overlays.Settings.Sections.Input ;
2019-12-28 21:13:18 +08:00
using osu.Game.Resources ;
2018-04-13 17:19:50 +08:00
using osu.Game.Rulesets ;
2019-05-15 12:00:11 +08:00
using osu.Game.Rulesets.Mods ;
2018-11-28 15:12:57 +08:00
using osu.Game.Scoring ;
2018-04-13 17:19:50 +08:00
using osu.Game.Skinning ;
2021-04-09 07:34:35 +08:00
using osu.Game.Utils ;
2020-08-03 17:48:10 +08:00
using RuntimeInfo = osu . Framework . RuntimeInfo ;
2018-04-13 17:19:50 +08:00
namespace osu.Game
{
/// <summary>
/// The most basic <see cref="Game"/> that can be used to host osu! components and systems.
/// Unlike <see cref="OsuGame"/>, this class will not load any kind of UI, allowing it to be used
/// for provide dependencies to test cases without interfering with them.
/// </summary>
2022-10-12 22:50:31 +08:00
[Cached(typeof(OsuGameBase))]
2022-05-22 21:15:53 +08:00
public partial class OsuGameBase : Framework . Game , ICanAcceptFiles , IBeatSyncProvider
2018-04-13 17:19:50 +08:00
{
2023-04-26 03:05:40 +08:00
public static readonly string [ ] VIDEO_EXTENSIONS = { ".mp4" , ".mov" , ".avi" , ".flv" , ".mpg" , ".wmv" , ".m4v" } ;
2022-06-16 17:00:27 +08:00
2022-02-18 14:57:37 +08:00
public const string OSU_PROTOCOL = "osu://" ;
2021-05-28 01:27:06 +08:00
public const string CLIENT_STREAM_NAME = @"lazer" ;
2019-06-03 12:16:05 +08:00
2022-03-30 12:34:48 +08:00
/// <summary>
/// The filename of the main client database.
/// </summary>
public const string CLIENT_DATABASE_FILENAME = @"client.realm" ;
2020-03-22 01:16:28 +08:00
public const int SAMPLE_CONCURRENCY = 6 ;
2022-12-16 16:19:07 +08:00
public const double SFX_STEREO_STRENGTH = 0.75 ;
2021-09-05 12:25:10 +08:00
/// <summary>
/// Length of debounce (in milliseconds) for commonly occuring sample playbacks that could stack.
/// </summary>
public const int SAMPLE_DEBOUNCE_TIME = 20 ;
2021-05-28 01:37:14 +08:00
/// <summary>
/// The maximum volume at which audio tracks should playback. This can be set lower than 1 to create some head-room for sound effects.
/// </summary>
2021-11-09 16:27:07 +08:00
private const double global_track_volume_adjust = 0.8 ;
2021-05-28 01:37:14 +08:00
2022-03-14 12:54:54 +08:00
public virtual bool UseDevelopmentServer = > DebugUtils . IsDebugBuild ;
2020-12-24 16:58:38 +08:00
2023-01-17 17:44:42 +08:00
public virtual EndpointConfiguration CreateEndpoints ( ) = >
UseDevelopmentServer ? new DevelopmentEndpointConfiguration ( ) : new ExperimentalEndpointConfiguration ( ) ;
2020-12-24 16:58:38 +08:00
2021-05-28 01:37:14 +08:00
public virtual Version AssemblyVersion = > Assembly . GetEntryAssembly ( ) ? . GetName ( ) . Version ? ? new Version ( ) ;
/// <summary>
/// MD5 representation of the game executable.
/// </summary>
public string VersionHash { get ; private set ; }
public bool IsDeployedBuild = > AssemblyVersion . Major > 0 ;
2022-05-11 09:38:35 +08:00
internal const string BUILD_SUFFIX = "lazer" ;
2021-05-28 01:37:14 +08:00
public virtual string Version
{
get
{
if ( ! IsDeployedBuild )
return @"local " + ( DebugUtils . IsDebugBuild ? @"debug" : @"release" ) ;
var version = AssemblyVersion ;
2022-05-11 09:38:35 +08:00
return $@"{version.Major}.{version.Minor}.{version.Build}-{BUILD_SUFFIX}" ;
2021-05-28 01:37:14 +08:00
}
}
2022-02-04 17:58:29 +08:00
/// <summary>
/// The <see cref="Edges"/> that the game should be drawn over at a top level.
/// Defaults to <see cref="Edges.None"/>.
/// </summary>
2022-02-04 21:10:49 +08:00
protected virtual Edges SafeAreaOverrideEdges = > Edges . None ;
2022-02-04 17:58:29 +08:00
2021-05-28 01:27:06 +08:00
protected OsuConfigManager LocalConfig { get ; private set ; }
2018-04-13 17:19:50 +08:00
2021-04-19 10:30:55 +08:00
protected SessionStatics SessionStatics { get ; private set ; }
2022-09-16 21:17:24 +08:00
protected OsuColour Colours { get ; private set ; }
2021-05-28 01:27:06 +08:00
protected BeatmapManager BeatmapManager { get ; private set ; }
2018-04-13 17:19:50 +08:00
2021-11-25 16:23:46 +08:00
protected BeatmapModelDownloader BeatmapDownloader { get ; private set ; }
2021-05-28 01:27:06 +08:00
protected ScoreManager ScoreManager { get ; private set ; }
2018-11-28 15:47:10 +08:00
2021-11-25 16:21:05 +08:00
protected ScoreModelDownloader ScoreDownloader { get ; private set ; }
2021-05-28 01:27:06 +08:00
protected SkinManager SkinManager { get ; private set ; }
2018-04-13 17:19:50 +08:00
2022-02-16 15:57:28 +08:00
protected RealmRulesetStore RulesetStore { get ; private set ; }
2018-04-13 17:19:50 +08:00
2021-06-10 12:58:08 +08:00
protected RealmKeyBindingStore KeyBindingStore { get ; private set ; }
2018-04-13 17:19:50 +08:00
2022-07-26 13:11:52 +08:00
protected GlobalCursorDisplay GlobalCursorDisplay { get ; private set ; }
2018-12-06 11:17:08 +08:00
2021-05-28 01:27:06 +08:00
protected MusicController MusicController { get ; private set ; }
protected IAPIProvider API { get ; set ; }
2020-10-22 12:41:54 +08:00
2021-05-28 01:27:06 +08:00
protected Storage Storage { get ; set ; }
2023-06-08 07:47:07 +08:00
/// <summary>
/// The language in which the game is currently displayed in.
/// </summary>
public Bindable < Language > CurrentLanguage { get ; } = new Bindable < Language > ( ) ;
2021-05-28 01:27:06 +08:00
protected Bindable < WorkingBeatmap > Beatmap { get ; private set ; } // cached via load() method
2018-04-13 17:19:50 +08:00
2023-01-05 17:49:45 +08:00
/// <summary>
/// The current ruleset selection for the local user.
/// </summary>
2019-05-15 12:00:11 +08:00
[Cached]
[Cached(typeof(IBindable<RulesetInfo>))]
2023-01-05 17:49:45 +08:00
protected internal readonly Bindable < RulesetInfo > Ruleset = new Bindable < RulesetInfo > ( ) ;
2019-05-15 12:00:11 +08:00
2021-02-10 13:38:15 +08:00
/// <summary>
/// The current mod selection for the local user.
/// </summary>
/// <remarks>
/// If a mod select overlay is present, mod instances set to this value are not guaranteed to remain as the provided instance and will be overwritten by a copy.
/// In such a case, changes to settings of a mod will *not* propagate after a mod is added to this collection.
/// As such, all settings should be finalised before adding a mod to this collection.
/// </remarks>
2019-05-15 12:00:11 +08:00
[Cached]
2019-12-13 19:13:53 +08:00
[Cached(typeof(IBindable<IReadOnlyList<Mod>>))]
2019-12-13 20:45:38 +08:00
protected readonly Bindable < IReadOnlyList < Mod > > SelectedMods = new Bindable < IReadOnlyList < Mod > > ( Array . Empty < Mod > ( ) ) ;
2019-02-01 14:42:15 +08:00
2019-12-12 17:53:25 +08:00
/// <summary>
/// Mods available for the current <see cref="Ruleset"/>.
/// </summary>
2022-06-15 23:39:30 +08:00
public readonly Bindable < Dictionary < ModType , IReadOnlyList < Mod > > > AvailableMods = new Bindable < Dictionary < ModType , IReadOnlyList < Mod > > > ( new Dictionary < ModType , IReadOnlyList < Mod > > ( ) ) ;
2019-12-12 17:53:25 +08:00
2021-05-28 01:30:31 +08:00
private BeatmapDifficultyCache difficultyCache ;
2022-07-04 17:13:53 +08:00
private BeatmapUpdater beatmapUpdater ;
2021-05-28 01:30:31 +08:00
private UserLookupCache userCache ;
2021-11-30 18:27:43 +08:00
private BeatmapLookupCache beatmapCache ;
2021-05-28 01:30:31 +08:00
private RulesetConfigCache rulesetConfigCache ;
2023-01-15 20:51:18 +08:00
protected SpectatorClient SpectatorClient { get ; private set ; }
2021-05-28 01:30:31 +08:00
2022-09-15 19:54:06 +08:00
protected MultiplayerClient MultiplayerClient { get ; private set ; }
2021-05-28 01:30:31 +08:00
2022-07-04 16:18:33 +08:00
private MetadataClient metadataClient ;
2022-12-24 18:20:31 +08:00
private SoloStatisticsWatcher soloStatisticsWatcher ;
2022-07-04 16:18:33 +08:00
2022-01-24 18:59:58 +08:00
private RealmAccess realm ;
2021-01-07 13:07:36 +08:00
2022-10-28 12:52:45 +08:00
protected SafeAreaContainer SafeAreaContainer { get ; private set ; }
2022-08-26 16:44:33 +08:00
/// <summary>
/// For now, this is used as a source specifically for beat synced components.
/// Going forward, it could potentially be used as the single source-of-truth for beatmap timing.
/// </summary>
2023-09-21 17:49:44 +08:00
private readonly FramedBeatmapClock beatmapClock = new FramedBeatmapClock ( applyOffsets : true , requireDecoupling : false ) ;
2022-08-26 16:44:33 +08:00
2023-01-12 14:48:38 +08:00
protected override Container < Drawable > Content = > content ;
2021-05-28 01:30:31 +08:00
private Container content ;
2021-05-28 01:37:14 +08:00
private DependencyContainer dependencies ;
2018-04-13 17:19:50 +08:00
2021-11-09 16:27:07 +08:00
private readonly BindableNumber < double > globalTrackVolumeAdjust = new BindableNumber < double > ( global_track_volume_adjust ) ;
2018-04-13 17:19:50 +08:00
2023-06-08 07:47:07 +08:00
private Bindable < string > frameworkLocale = null ! ;
private IBindable < LocalisationParameters > localisationParameters = null ! ;
2022-05-10 15:02:32 +08:00
/// <summary>
2022-05-10 18:07:07 +08:00
/// Number of unhandled exceptions to allow before aborting execution.
2022-05-10 15:02:32 +08:00
/// </summary>
2022-05-10 18:07:07 +08:00
/// <remarks>
/// When an unhandled exception is encountered, an internal count will be decremented.
/// If the count hits zero, the game will crash.
/// Each second, the count is incremented until reaching the value specified.
/// </remarks>
2022-05-10 18:10:34 +08:00
protected virtual int UnhandledExceptionsBeforeCrash = > DebugUtils . IsDebugBuild ? 0 : 1 ;
2022-05-10 15:02:32 +08:00
2018-04-13 17:19:50 +08:00
public OsuGameBase ( )
{
2021-07-04 11:39:50 +08:00
Name = @"osu!" ;
2022-05-10 15:02:32 +08:00
2022-08-01 13:38:02 +08:00
#if DEBUG
Name + = " (development)" ;
#endif
2022-05-10 18:10:34 +08:00
allowableExceptions = UnhandledExceptionsBeforeCrash ;
2018-04-13 17:19:50 +08:00
}
[BackgroundDependencyLoader]
2023-06-08 07:47:07 +08:00
private void load ( ReadableKeyCombinationProvider keyCombinationProvider , FrameworkConfigManager frameworkConfig )
2018-04-13 17:19:50 +08:00
{
2020-08-03 17:48:10 +08:00
try
{
using ( var str = File . OpenRead ( typeof ( OsuGameBase ) . Assembly . Location ) )
VersionHash = str . ComputeMD5Hash ( ) ;
}
catch
{
// special case for android builds, which can't read DLLs from a packed apk.
// should eventually be handled in a better way.
VersionHash = $"{Version}-{RuntimeInfo.OS}" . ComputeMD5Hash ( ) ;
}
2020-07-29 11:39:18 +08:00
2019-12-28 21:13:18 +08:00
Resources . AddStore ( new DllResourceStore ( OsuResources . ResourceAssembly ) ) ;
2018-06-04 19:01:55 +08:00
2022-09-15 15:31:00 +08:00
dependencies . Cache ( realm = new RealmAccess ( Storage , CLIENT_DATABASE_FILENAME , Host . UpdateThread ) ) ;
2021-11-23 10:48:56 +08:00
2022-02-16 15:57:28 +08:00
dependencies . CacheAs < RulesetStore > ( RulesetStore = new RealmRulesetStore ( realm , Storage ) ) ;
2021-12-03 17:14:44 +08:00
dependencies . CacheAs < IRulesetStore > ( RulesetStore ) ;
2018-04-13 17:19:50 +08:00
2022-02-16 15:57:28 +08:00
Decoder . RegisterDependencies ( RulesetStore ) ;
2021-11-30 14:41:18 +08:00
2020-05-04 16:01:05 +08:00
dependencies . CacheAs ( Storage ) ;
2022-08-02 18:50:57 +08:00
var largeStore = new LargeTextureStore ( Host . Renderer , Host . CreateTextureLoaderStore ( new NamespacedResourceStore < byte [ ] > ( Resources , @"Textures" ) ) ) ;
2022-06-24 22:07:14 +08:00
largeStore . AddTextureSource ( Host . CreateTextureLoaderStore ( new OnlineStore ( ) ) ) ;
2018-09-09 01:41:47 +08:00
dependencies . Cache ( largeStore ) ;
2018-04-13 17:19:50 +08:00
2020-12-24 16:58:38 +08:00
dependencies . CacheAs ( LocalConfig ) ;
2022-11-08 17:24:57 +08:00
dependencies . CacheAs < IGameplaySettings > ( LocalConfig ) ;
2018-04-13 17:19:50 +08:00
2021-09-06 23:45:53 +08:00
InitialiseFonts ( ) ;
2018-04-13 17:19:50 +08:00
2022-09-22 11:52:24 +08:00
addFilesWarning ( ) ;
2020-03-22 01:16:28 +08:00
Audio . Samples . PlaybackConcurrency = SAMPLE_CONCURRENCY ;
2022-01-24 18:59:58 +08:00
dependencies . Cache ( SkinManager = new SkinManager ( Storage , realm , Host , Resources , Audio , Scheduler ) ) ;
2018-09-01 16:39:54 +08:00
dependencies . CacheAs < ISkinSource > ( SkinManager ) ;
2022-06-03 15:29:55 +08:00
EndpointConfiguration endpoints = CreateEndpoints ( ) ;
2020-12-24 16:58:38 +08:00
2021-02-12 13:54:19 +08:00
MessageFormatter . WebsiteRootUrl = endpoints . WebsiteRootUrl ;
2023-06-08 07:47:07 +08:00
frameworkLocale = frameworkConfig . GetBindable < string > ( FrameworkSetting . Locale ) ;
frameworkLocale . BindValueChanged ( _ = > updateLanguage ( ) ) ;
localisationParameters = Localisation . CurrentParameters . GetBoundCopy ( ) ;
localisationParameters . BindValueChanged ( _ = > updateLanguage ( ) , true ) ;
CurrentLanguage . BindValueChanged ( val = > frameworkLocale . Value = val . NewValue . ToCultureCode ( ) ) ;
2023-06-08 07:50:14 +08:00
dependencies . CacheAs ( API ? ? = new APIAccess ( this , LocalConfig , endpoints , VersionHash ) ) ;
2018-09-01 16:39:54 +08:00
2019-05-31 13:51:12 +08:00
var defaultBeatmap = new DummyWorkingBeatmap ( Audio , Textures ) ;
2018-12-25 17:34:45 +08:00
2022-06-20 16:52:42 +08:00
dependencies . Cache ( difficultyCache = new BeatmapDifficultyCache ( ) ) ;
2019-05-09 14:15:28 +08:00
// ordering is important here to ensure foreign keys rules are not broken in ModelStore.Cleanup()
2022-08-22 20:31:30 +08:00
dependencies . Cache ( ScoreManager = new ScoreManager ( RulesetStore , ( ) = > BeatmapManager , Storage , realm , API , LocalConfig ) ) ;
2022-07-04 17:13:53 +08:00
2022-07-28 15:19:05 +08:00
dependencies . Cache ( BeatmapManager = new BeatmapManager ( Storage , realm , API , Audio , Resources , Host , defaultBeatmap , difficultyCache , performOnlineLookups : true ) ) ;
2019-05-09 14:15:28 +08:00
2021-11-25 16:42:41 +08:00
dependencies . Cache ( BeatmapDownloader = new BeatmapModelDownloader ( BeatmapManager , API ) ) ;
dependencies . Cache ( ScoreDownloader = new ScoreModelDownloader ( ScoreManager , API ) ) ;
2021-11-25 16:21:05 +08:00
2022-06-20 16:52:42 +08:00
// Add after all the above cache operations as it depends on them.
2023-01-12 14:48:38 +08:00
base . Content . Add ( difficultyCache ) ;
2020-07-21 22:13:04 +08:00
2022-07-04 17:13:53 +08:00
// TODO: OsuGame or OsuGameBase?
2022-07-21 02:18:57 +08:00
dependencies . CacheAs ( beatmapUpdater = new BeatmapUpdater ( BeatmapManager , difficultyCache , API , Storage ) ) ;
2023-01-15 20:51:18 +08:00
dependencies . CacheAs ( SpectatorClient = new OnlineSpectatorClient ( endpoints ) ) ;
2022-09-15 19:54:06 +08:00
dependencies . CacheAs ( MultiplayerClient = new OnlineMultiplayerClient ( endpoints ) ) ;
2022-07-14 14:18:12 +08:00
dependencies . CacheAs ( metadataClient = new OnlineMetadataClient ( endpoints ) ) ;
2022-12-24 18:20:31 +08:00
dependencies . CacheAs ( soloStatisticsWatcher = new SoloStatisticsWatcher ( ) ) ;
2022-07-04 17:13:53 +08:00
2023-01-12 14:48:38 +08:00
base . Content . Add ( new BeatmapOnlineChangeIngest ( beatmapUpdater , realm , metadataClient ) ) ;
2022-06-20 17:40:05 +08:00
2023-04-12 03:42:55 +08:00
BeatmapManager . ProcessBeatmap = ( beatmapSet , scope ) = > beatmapUpdater . Process ( beatmapSet , scope ) ;
2022-07-04 17:13:53 +08:00
2021-05-28 01:30:31 +08:00
dependencies . Cache ( userCache = new UserLookupCache ( ) ) ;
2023-01-12 14:48:38 +08:00
base . Content . Add ( userCache ) ;
2020-11-06 15:38:57 +08:00
2021-11-30 18:27:43 +08:00
dependencies . Cache ( beatmapCache = new BeatmapLookupCache ( ) ) ;
2023-01-12 14:48:38 +08:00
base . Content . Add ( beatmapCache ) ;
2021-11-30 18:27:43 +08:00
2020-11-06 12:15:33 +08:00
var scorePerformanceManager = new ScorePerformanceCache ( ) ;
2020-11-02 13:49:25 +08:00
dependencies . Cache ( scorePerformanceManager ) ;
2023-01-12 14:48:38 +08:00
base . Content . Add ( scorePerformanceManager ) ;
2020-09-27 18:44:29 +08:00
2022-01-24 18:59:58 +08:00
dependencies . CacheAs < IRulesetConfigCache > ( rulesetConfigCache = new RulesetConfigCache ( realm , RulesetStore ) ) ;
2021-04-11 14:00:37 +08:00
2021-04-12 22:52:12 +08:00
var powerStatus = CreateBatteryInfo ( ) ;
2021-04-11 14:00:37 +08:00
if ( powerStatus ! = null )
dependencies . CacheAs ( powerStatus ) ;
2021-04-19 10:30:55 +08:00
dependencies . Cache ( SessionStatics = new SessionStatics ( ) ) ;
2022-09-16 21:17:24 +08:00
dependencies . Cache ( Colours = new OsuColour ( ) ) ;
2018-09-01 16:39:54 +08:00
2020-10-02 15:08:11 +08:00
RegisterImportHandler ( BeatmapManager ) ;
RegisterImportHandler ( ScoreManager ) ;
RegisterImportHandler ( SkinManager ) ;
2018-09-01 16:39:54 +08:00
2021-02-11 14:02:34 +08:00
// drop track volume game-wide to leave some head-room for UI effects / samples.
// this means that for the time being, gameplay sample playback is louder relative to the audio track, compared to stable.
// we may want to revisit this if users notice or complain about the difference (consider this a bit of a trial).
Audio . Tracks . AddAdjustment ( AdjustableProperty . Volume , globalTrackVolumeAdjust ) ;
2018-04-13 17:19:50 +08:00
2019-11-12 17:45:42 +08:00
Beatmap = new NonNullableBindable < WorkingBeatmap > ( defaultBeatmap ) ;
2020-03-04 18:07:34 +08:00
2019-11-12 17:45:42 +08:00
dependencies . CacheAs < IBindable < WorkingBeatmap > > ( Beatmap ) ;
dependencies . CacheAs ( Beatmap ) ;
2018-04-13 17:19:50 +08:00
2020-10-22 13:54:27 +08:00
// add api components to hierarchy.
2020-05-28 18:05:35 +08:00
if ( API is APIAccess apiAccess )
2023-01-12 14:48:38 +08:00
base . Content . Add ( apiAccess ) ;
2022-07-04 16:18:33 +08:00
2023-01-15 20:51:18 +08:00
base . Content . Add ( SpectatorClient ) ;
2023-01-12 14:48:38 +08:00
base . Content . Add ( MultiplayerClient ) ;
base . Content . Add ( metadataClient ) ;
base . Content . Add ( soloStatisticsWatcher ) ;
2020-10-22 13:54:27 +08:00
2023-01-12 14:48:38 +08:00
base . Content . Add ( rulesetConfigCache ) ;
2023-01-12 03:02:06 +08:00
PreviewTrackManager previewTrackManager ;
dependencies . Cache ( previewTrackManager = new PreviewTrackManager ( BeatmapManager . BeatmapTrackStore ) ) ;
2023-01-12 14:48:38 +08:00
base . Content . Add ( previewTrackManager ) ;
2023-01-12 03:02:06 +08:00
2023-01-12 14:48:38 +08:00
base . Content . Add ( MusicController = new MusicController ( ) ) ;
2023-01-12 03:02:06 +08:00
dependencies . CacheAs ( MusicController ) ;
MusicController . TrackChanged + = onTrackChanged ;
2023-01-12 14:48:38 +08:00
base . Content . Add ( beatmapClock ) ;
2018-04-22 03:10:06 +08:00
2021-04-08 14:17:53 +08:00
GlobalActionContainer globalBindings ;
2023-01-12 14:48:38 +08:00
base . Content . Add ( SafeAreaContainer = new SafeAreaContainer
2018-04-22 03:10:06 +08:00
{
2022-02-04 17:58:29 +08:00
SafeAreaOverrideEdges = SafeAreaOverrideEdges ,
2022-02-04 15:07:05 +08:00
RelativeSizeAxes = Axes . Both ,
2023-08-06 23:40:55 +08:00
Child = CreateScalingContainer ( ) . WithChild ( globalBindings = new GlobalActionContainer ( this )
2022-02-04 15:07:05 +08:00
{
2023-08-06 23:40:55 +08:00
Children = new Drawable [ ]
2023-01-12 14:48:38 +08:00
{
2023-08-06 23:40:55 +08:00
( GlobalCursorDisplay = new GlobalCursorDisplay
{
RelativeSizeAxes = Axes . Both
} ) . WithChild ( content = new OsuTooltipContainer ( GlobalCursorDisplay . MenuCursor )
{
RelativeSizeAxes = Axes . Both
} ) ,
}
2022-02-04 15:07:05 +08:00
} )
} ) ;
2018-04-22 03:10:06 +08:00
2023-10-30 21:08:56 +08:00
base . Content . Add ( new TouchInputInterceptor ( ) ) ;
2022-01-24 18:59:58 +08:00
KeyBindingStore = new RealmKeyBindingStore ( realm , keyCombinationProvider ) ;
2021-09-07 14:19:23 +08:00
KeyBindingStore . Register ( globalBindings , RulesetStore . AvailableRulesets ) ;
2021-01-12 13:59:48 +08:00
2021-04-08 14:17:53 +08:00
dependencies . Cache ( globalBindings ) ;
2018-05-09 19:52:46 +08:00
2019-12-12 17:53:25 +08:00
Ruleset . BindValueChanged ( onRulesetChanged ) ;
2022-01-18 11:20:52 +08:00
Beatmap . BindValueChanged ( onBeatmapChanged ) ;
2019-12-12 17:53:25 +08:00
}
2023-06-08 07:47:07 +08:00
private void updateLanguage ( ) = > CurrentLanguage . Value = LanguageExtensions . GetLanguageFor ( frameworkLocale . Value , localisationParameters . Value ) ;
2022-09-22 11:52:24 +08:00
private void addFilesWarning ( )
{
var realmStore = new RealmFileStore ( realm , Storage ) ;
const string filename = "IMPORTANT READ ME.txt" ;
if ( ! realmStore . Storage . Exists ( filename ) )
{
using ( var stream = realmStore . 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 ( ) ;
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 ( ) ;
textWriter . WriteLine ( @"For more information on how these files are organised," ) ;
textWriter . WriteLine ( @"see https://github.com/ppy/osu/wiki/User-file-storage" ) ;
}
}
}
2023-09-21 17:45:34 +08:00
private void onTrackChanged ( WorkingBeatmap beatmap , TrackChangeDirection direction ) = > beatmapClock . ChangeSource ( beatmap . Track ) ;
2022-08-26 16:44:33 +08:00
2021-09-06 23:45:53 +08:00
protected virtual void InitialiseFonts ( )
{
AddFont ( Resources , @"Fonts/osuFont" ) ;
AddFont ( Resources , @"Fonts/Torus/Torus-Regular" ) ;
AddFont ( Resources , @"Fonts/Torus/Torus-Light" ) ;
AddFont ( Resources , @"Fonts/Torus/Torus-SemiBold" ) ;
AddFont ( Resources , @"Fonts/Torus/Torus-Bold" ) ;
2021-10-04 05:36:39 +08:00
AddFont ( Resources , @"Fonts/Torus-Alternate/Torus-Alternate-Regular" ) ;
AddFont ( Resources , @"Fonts/Torus-Alternate/Torus-Alternate-Light" ) ;
AddFont ( Resources , @"Fonts/Torus-Alternate/Torus-Alternate-SemiBold" ) ;
AddFont ( Resources , @"Fonts/Torus-Alternate/Torus-Alternate-Bold" ) ;
2021-09-06 23:45:53 +08:00
AddFont ( Resources , @"Fonts/Inter/Inter-Regular" ) ;
AddFont ( Resources , @"Fonts/Inter/Inter-RegularItalic" ) ;
AddFont ( Resources , @"Fonts/Inter/Inter-Light" ) ;
AddFont ( Resources , @"Fonts/Inter/Inter-LightItalic" ) ;
AddFont ( Resources , @"Fonts/Inter/Inter-SemiBold" ) ;
AddFont ( Resources , @"Fonts/Inter/Inter-SemiBoldItalic" ) ;
AddFont ( Resources , @"Fonts/Inter/Inter-Bold" ) ;
AddFont ( Resources , @"Fonts/Inter/Inter-BoldItalic" ) ;
AddFont ( Resources , @"Fonts/Noto/Noto-Basic" ) ;
AddFont ( Resources , @"Fonts/Noto/Noto-Hangul" ) ;
AddFont ( Resources , @"Fonts/Noto/Noto-CJK-Basic" ) ;
AddFont ( Resources , @"Fonts/Noto/Noto-CJK-Compatibility" ) ;
AddFont ( Resources , @"Fonts/Noto/Noto-Thai" ) ;
AddFont ( Resources , @"Fonts/Venera/Venera-Light" ) ;
AddFont ( Resources , @"Fonts/Venera/Venera-Bold" ) ;
AddFont ( Resources , @"Fonts/Venera/Venera-Black" ) ;
2023-11-24 11:45:55 +08:00
Fonts . AddStore ( new HexaconsIcons . HexaconsStore ( Textures ) ) ;
2021-09-06 23:45:53 +08:00
}
2021-05-31 12:39:18 +08:00
protected override IReadOnlyDependencyContainer CreateChildDependencies ( IReadOnlyDependencyContainer parent ) = >
dependencies = new DependencyContainer ( base . CreateChildDependencies ( parent ) ) ;
public override void SetHost ( GameHost host )
{
base . SetHost ( host ) ;
// may be non-null for certain tests
Storage ? ? = host . Storage ;
LocalConfig ? ? = UseDevelopmentServer
? new DevelopmentOsuConfigManager ( Storage )
: new OsuConfigManager ( Storage ) ;
2022-05-10 15:02:32 +08:00
host . ExceptionThrown + = onExceptionThrown ;
2021-05-31 12:39:18 +08:00
}
/// <summary>
/// Use to programatically exit the game as if the user was triggering via alt-f4.
2022-06-19 00:14:48 +08:00
/// By default, will keep persisting until an exit occurs (exit may be blocked multiple times).
2022-06-19 19:42:45 +08:00
/// May be interrupted (see <see cref="OsuGame"/>'s override).
2021-05-31 12:39:18 +08:00
/// </summary>
2022-06-19 11:34:14 +08:00
public virtual void AttemptExit ( )
2021-05-31 12:39:18 +08:00
{
if ( ! OnExiting ( ) )
Exit ( ) ;
else
2022-06-19 11:34:14 +08:00
Scheduler . AddDelayed ( AttemptExit , 2000 ) ;
2021-05-31 12:39:18 +08:00
}
2023-06-21 17:29:34 +08:00
/// <summary>
/// If supported by the platform, the game will automatically restart after the next exit.
/// </summary>
/// <returns>Whether a restart operation was queued.</returns>
public virtual bool RestartAppWhenExited ( ) = > false ;
2022-02-10 17:48:37 +08:00
public bool Migrate ( string path )
2021-05-31 12:39:18 +08:00
{
2021-06-29 19:16:57 +08:00
Logger . Log ( $@"Migrating osu! data from ""{Storage.GetFullPath(string.Empty)}"" to ""{path}""..." ) ;
2021-10-12 15:04:09 +08:00
IDisposable realmBlocker = null ;
try
2021-06-10 12:58:08 +08:00
{
2021-10-12 15:04:09 +08:00
ManualResetEventSlim readyToRun = new ManualResetEventSlim ( ) ;
Scheduler . Add ( ( ) = >
{
2022-07-02 11:35:29 +08:00
realmBlocker = realm . BlockAllOperations ( "migration" ) ;
2021-10-12 15:04:09 +08:00
readyToRun . Set ( ) ;
} , false ) ;
2022-06-23 13:33:20 +08:00
if ( ! readyToRun . Wait ( 30000 ) )
throw new TimeoutException ( "Attempting to block for migration took too long." ) ;
2021-10-12 15:04:09 +08:00
2022-02-10 17:48:37 +08:00
bool? cleanupSucceded = ( Storage as OsuStorage ) ? . Migrate ( Host . GetStorage ( path ) ) ;
Logger . Log ( @"Migration complete!" ) ;
return cleanupSucceded ! = false ;
2021-06-10 12:58:08 +08:00
}
2021-10-12 15:04:09 +08:00
finally
{
realmBlocker ? . Dispose ( ) ;
}
2021-05-31 12:39:18 +08:00
}
protected override UserInputManager CreateUserInputManager ( ) = > new OsuUserInputManager ( ) ;
protected virtual BatteryInfo CreateBatteryInfo ( ) = > null ;
protected virtual Container CreateScalingContainer ( ) = > new DrawSizePreservingFillContainer ( ) ;
protected override Storage CreateStorage ( GameHost host , Storage defaultStorage ) = > new OsuStorage ( host , defaultStorage ) ;
2022-01-15 06:16:07 +08:00
/// <summary>
/// Creates an input settings subsection for an <see cref="InputHandler"/>.
/// </summary>
/// <remarks>Should be overriden per-platform to provide settings for platform-specific handlers.</remarks>
public virtual SettingsSubsection CreateSettingsSubsectionFor ( InputHandler handler )
{
2022-10-28 16:26:53 +08:00
// One would think that this could be moved to the `OsuGameDesktop` class, but doing so means that
// OsuGameTestScenes will not show any input options (as they are based on OsuGame not OsuGameDesktop).
//
// This in turn makes it hard for ruleset creators to adjust input settings while testing their ruleset
// within the test browser interface.
2022-10-21 06:52:19 +08:00
if ( RuntimeInfo . IsDesktop )
{
switch ( handler )
{
case ITabletHandler th :
return new TabletSettings ( th ) ;
case MouseHandler mh :
return new MouseSettings ( mh ) ;
case JoystickHandler jh :
return new JoystickSettings ( jh ) ;
}
}
2022-01-15 06:16:07 +08:00
switch ( handler )
{
2023-11-09 22:12:24 +08:00
case TouchHandler th :
return new TouchSettings ( th ) ;
2022-06-24 20:25:23 +08:00
case MidiHandler :
2022-01-15 06:16:07 +08:00
return new InputSection . HandlerSection ( handler ) ;
// return null for handlers that shouldn't have settings.
default :
return null ;
}
}
2022-06-27 14:58:51 +08:00
private void onBeatmapChanged ( ValueChangedEvent < WorkingBeatmap > beatmap )
2022-01-18 11:20:52 +08:00
{
2022-01-18 15:11:03 +08:00
if ( IsLoaded & & ! ThreadSafety . IsUpdateThread )
2022-01-18 11:20:52 +08:00
throw new InvalidOperationException ( "Global beatmap bindable must be changed from update thread." ) ;
2022-06-27 14:58:51 +08:00
Logger . Log ( $"Game-wide working beatmap updated to {beatmap.NewValue}" ) ;
2022-01-18 11:20:52 +08:00
}
2019-12-12 17:53:25 +08:00
private void onRulesetChanged ( ValueChangedEvent < RulesetInfo > r )
{
2022-01-18 15:11:03 +08:00
if ( IsLoaded & & ! ThreadSafety . IsUpdateThread )
2022-01-18 11:20:52 +08:00
throw new InvalidOperationException ( "Global ruleset bindable must be changed from update thread." ) ;
2022-01-10 12:59:33 +08:00
Ruleset instance = null ;
2021-11-24 11:16:08 +08:00
2022-01-10 12:59:33 +08:00
try
{
if ( r . NewValue ? . Available = = true )
{
instance = r . NewValue . CreateInstance ( ) ;
}
}
catch ( Exception e )
{
Logger . Error ( e , "Ruleset load failed and has been rolled back" ) ;
}
if ( instance = = null )
2019-12-15 01:36:49 +08:00
{
2021-07-26 15:34:38 +08:00
// reject the change if the ruleset is not available.
2022-06-15 23:22:39 +08:00
revertRulesetChange ( ) ;
2021-07-26 15:34:38 +08:00
return ;
2019-12-15 01:36:49 +08:00
}
2019-12-12 17:53:25 +08:00
2021-07-26 15:34:38 +08:00
var dict = new Dictionary < ModType , IReadOnlyList < Mod > > ( ) ;
2022-06-15 23:22:39 +08:00
try
2021-11-24 11:16:08 +08:00
{
2022-12-27 03:36:39 +08:00
foreach ( ModType type in Enum . GetValues < ModType > ( ) )
2022-06-15 23:22:39 +08:00
{
dict [ type ] = instance . GetModsFor ( type )
2022-06-15 23:26:54 +08:00
// Rulesets should never return null mods, but let's be defensive just in case.
// ReSharper disable once ConditionIsAlwaysTrueOrFalse
2022-06-15 23:22:39 +08:00
. Where ( mod = > mod ! = null )
. ToList ( ) ;
}
}
catch ( Exception e )
2021-11-24 11:16:08 +08:00
{
2022-06-15 23:22:39 +08:00
Logger . Error ( e , $"Could not load mods for \" { instance . RulesetInfo . Name } \ " ruleset. Current ruleset has been rolled back." ) ;
revertRulesetChange ( ) ;
return ;
2021-11-24 11:16:08 +08:00
}
2021-07-26 15:34:38 +08:00
2023-05-04 00:31:35 +08:00
AvailableMods . Value = dict ;
2023-04-26 03:05:40 +08:00
2023-05-04 00:31:35 +08:00
if ( SelectedMods . Disabled )
return ;
2022-10-14 07:02:24 +08:00
2023-05-04 00:31:35 +08:00
var convertedMods = SelectedMods . Value . Select ( mod = >
2023-04-26 03:28:03 +08:00
{
2023-05-04 00:31:35 +08:00
var newMod = instance . CreateModFromAcronym ( mod . Acronym ) ;
2023-05-05 00:15:12 +08:00
newMod ? . CopyCommonSettingsFrom ( mod ) ;
2023-05-04 00:31:35 +08:00
return newMod ;
} ) . Where ( newMod = > newMod ! = null ) . ToList ( ) ;
2023-04-26 03:28:03 +08:00
2023-05-04 00:31:35 +08:00
if ( ! ModUtils . CheckValidForGameplay ( convertedMods , out var invalid ) )
invalid . ForEach ( newMod = > convertedMods . Remove ( newMod ) ) ;
2023-04-26 03:05:40 +08:00
2023-05-04 00:31:35 +08:00
SelectedMods . Value = convertedMods ;
2023-04-26 03:05:40 +08:00
2022-06-15 23:22:39 +08:00
void revertRulesetChange ( ) = > Ruleset . Value = r . OldValue ? . Available = = true ? r . OldValue : RulesetStore . AvailableRulesets . First ( ) ;
2018-04-13 17:19:50 +08:00
}
2022-05-10 15:02:32 +08:00
private int allowableExceptions ;
/// <summary>
/// Allows a maximum of one unhandled exception, per second of execution.
/// </summary>
private bool onExceptionThrown ( Exception _ )
{
bool continueExecution = Interlocked . Decrement ( ref allowableExceptions ) > = 0 ;
2022-05-10 18:07:00 +08:00
Logger . Log ( $"Unhandled exception has been {(continueExecution ? $" allowed with { allowableExceptions } more allowable exceptions " : " denied ")} ." ) ;
2022-05-10 15:02:32 +08:00
// restore the stock of allowable exceptions after a short delay.
Task . Delay ( 1000 ) . ContinueWith ( _ = > Interlocked . Increment ( ref allowableExceptions ) ) ;
return continueExecution ;
2018-04-13 17:19:50 +08:00
}
2019-10-15 15:14:06 +08:00
protected override void Dispose ( bool isDisposing )
{
base . Dispose ( isDisposing ) ;
2020-10-19 18:03:22 +08:00
2019-10-15 15:14:06 +08:00
RulesetStore ? . Dispose ( ) ;
2020-10-19 18:03:22 +08:00
LocalConfig ? . Dispose ( ) ;
2020-05-11 20:37:07 +08:00
2022-07-04 17:13:53 +08:00
beatmapUpdater ? . Dispose ( ) ;
2022-01-24 18:59:58 +08:00
realm ? . Dispose ( ) ;
2022-05-10 15:02:32 +08:00
if ( Host ! = null )
Host . ExceptionThrown - = onExceptionThrown ;
2019-10-15 15:14:06 +08:00
}
2022-05-22 21:15:53 +08:00
2022-07-06 13:50:30 +08:00
ControlPointInfo IBeatSyncProvider . ControlPoints = > Beatmap . Value . BeatmapLoaded ? Beatmap . Value . Beatmap . ControlPointInfo : null ;
2022-08-26 16:44:33 +08:00
IClock IBeatSyncProvider . Clock = > beatmapClock ;
2022-08-02 16:54:42 +08:00
ChannelAmplitudes IHasAmplitudes . CurrentAmplitudes = > Beatmap . Value . TrackLoaded ? Beatmap . Value . Track . CurrentAmplitudes : ChannelAmplitudes . Empty ;
2018-04-13 17:19:50 +08:00
}
}