-
-
Notifications
You must be signed in to change notification settings - Fork 2.4k
Add support for displaying "system title" on main menu #26172
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 2 commits
d9299a8
a3f720b
ac44913
ef39759
93a8afe
c70e7d3
289e0f0
481a251
972234b
0ea62d0
6684987
be3fc45
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
// 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. | ||
|
||
using System.Linq; | ||
using NUnit.Framework; | ||
using osu.Framework.Testing; | ||
using osu.Game.Online.API.Requests.Responses; | ||
using osu.Game.Screens.Menu; | ||
|
||
namespace osu.Game.Tests.Visual.Menus | ||
{ | ||
public partial class TestSceneMainMenu : OsuGameTestScene | ||
{ | ||
[Test] | ||
public void TestSystemTitle() | ||
{ | ||
AddStep("set system title", () => Game.ChildrenOfType<SystemTitle>().Single().Current.Value = new APISystemTitle | ||
{ | ||
Image = @"https://assets.ppy.sh/main-menu/project-loved-2@2x.png", | ||
Url = @"https://osu.ppy.sh/home/news/2023-12-21-project-loved-december-2023", | ||
}); | ||
AddStep("set another title", () => Game.ChildrenOfType<SystemTitle>().Single().Current.Value = new APISystemTitle | ||
{ | ||
Image = @"https://assets.ppy.sh/main-menu/wf2023-vote@2x.png", | ||
Url = @"https://osu.ppy.sh/community/contests/189", | ||
}); | ||
AddStep("unset system title", () => Game.ChildrenOfType<SystemTitle>().Single().Current.Value = null); | ||
} | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
// 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. | ||
|
||
using osu.Game.Online.API.Requests.Responses; | ||
|
||
namespace osu.Game.Online.API.Requests | ||
{ | ||
public class GetSystemTitleRequest : OsuJsonWebRequest<APISystemTitle> | ||
{ | ||
public GetSystemTitleRequest() | ||
: base(@"https://assets.ppy.sh/lazer-status.json") | ||
{ | ||
} | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
// 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. | ||
|
||
using Newtonsoft.Json; | ||
|
||
namespace osu.Game.Online.API.Requests.Responses | ||
{ | ||
public record APISystemTitle | ||
bdach marked this conversation as resolved.
Show resolved
Hide resolved
|
||
{ | ||
[JsonProperty(@"image")] | ||
public string Image { get; set; } = string.Empty; | ||
|
||
[JsonProperty(@"url")] | ||
public string Url { get; set; } = string.Empty; | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -995,7 +995,10 @@ protected override void LoadComplete() | |
}, topMostOverlayContent.Add); | ||
|
||
if (!args?.Any(a => a == @"--no-version-overlay") ?? true) | ||
loadComponentSingleFile(versionManager = new VersionManager { Depth = int.MinValue }, ScreenContainer.Add); | ||
{ | ||
dependencies.Cache(versionManager = new VersionManager { Depth = int.MinValue }); | ||
loadComponentSingleFile(versionManager, ScreenContainer.Add); | ||
Comment on lines
+999
to
+1000
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This excursion is to prevent the version display on the bottom and the system title stepping on each other. |
||
} | ||
|
||
loadComponentSingleFile(osuLogo, _ => | ||
{ | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,124 @@ | ||
// 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. | ||
|
||
using System; | ||
using System.Threading; | ||
using System.Threading.Tasks; | ||
using osu.Framework.Allocation; | ||
using osu.Framework.Bindables; | ||
using osu.Framework.Graphics; | ||
using osu.Framework.Graphics.Containers; | ||
using osu.Framework.Graphics.Sprites; | ||
using osu.Framework.Graphics.Textures; | ||
using osu.Framework.Input.Events; | ||
using osu.Framework.Platform; | ||
using osu.Game.Online.API.Requests; | ||
using osu.Game.Online.API.Requests.Responses; | ||
|
||
namespace osu.Game.Screens.Menu | ||
{ | ||
public partial class SystemTitle : CompositeDrawable | ||
{ | ||
internal Bindable<APISystemTitle?> Current { get; } = new Bindable<APISystemTitle?>(); | ||
|
||
private Container content = null!; | ||
private CancellationTokenSource? cancellationTokenSource; | ||
private SystemTitleImage? currentImage; | ||
|
||
[BackgroundDependencyLoader] | ||
private void load(GameHost? gameHost) | ||
{ | ||
Anchor = Anchor.BottomCentre; | ||
Origin = Anchor.BottomCentre; | ||
AutoSizeAxes = Axes.Both; | ||
|
||
InternalChild = content = new ClickableContainer | ||
{ | ||
AutoSizeAxes = Axes.Both, | ||
Action = () => | ||
{ | ||
if (!string.IsNullOrEmpty(Current.Value?.Url)) | ||
gameHost?.OpenUrlExternally(Current.Value.Url); | ||
} | ||
}; | ||
} | ||
|
||
protected override bool OnHover(HoverEvent e) | ||
{ | ||
content.ScaleTo(1.1f, 500, Easing.OutBounce); | ||
return base.OnHover(e); | ||
} | ||
|
||
protected override void OnHoverLost(HoverLostEvent e) | ||
{ | ||
content.ScaleTo(1f, 500, Easing.OutBounce); | ||
base.OnHoverLost(e); | ||
} | ||
|
||
protected override void LoadComplete() | ||
{ | ||
base.LoadComplete(); | ||
|
||
Current.BindValueChanged(_ => loadNewImage(), true); | ||
|
||
checkForUpdates(); | ||
Scheduler.AddDelayed(checkForUpdates, TimeSpan.FromMinutes(15).TotalMilliseconds, true); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Not sure if this polling is necessary. Probably can be removed if just a once-off call at startup is deemed acceptable. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Refreshing is best. It will already only attempt a refresh when returning to the main menu, which should be pretty fine. I'd almost say to just check each time we return, but I guess a bit of delay is worth having. |
||
} | ||
|
||
private void checkForUpdates() | ||
{ | ||
var request = new GetSystemTitleRequest(); | ||
Task.Run(() => request.Perform()) | ||
.ContinueWith(r => | ||
{ | ||
if (r.IsCompletedSuccessfully) | ||
Schedule(() => Current.Value = request.ResponseObject); | ||
|
||
// if the request failed, "observe" the exception. | ||
// it isn't very important why this failed, as it's only for display. | ||
// the inner error will be logged by framework mechanisms anyway. | ||
if (r.IsFaulted) | ||
_ = r.Exception; | ||
}); | ||
} | ||
|
||
private void loadNewImage() | ||
{ | ||
cancellationTokenSource?.Cancel(); | ||
cancellationTokenSource = null; | ||
currentImage?.FadeOut(500, Easing.OutQuint).Expire(); | ||
|
||
if (string.IsNullOrEmpty(Current.Value?.Image)) | ||
return; | ||
|
||
LoadComponentAsync(new SystemTitleImage(Current.Value), loaded => | ||
{ | ||
if (loaded.SystemTitle != Current.Value) | ||
loaded.Dispose(); | ||
|
||
loaded.FadeInFromZero(500, Easing.OutQuint); | ||
content.Add(currentImage = loaded); | ||
}, (cancellationTokenSource ??= new CancellationTokenSource()).Token); | ||
} | ||
|
||
[LongRunningLoad] | ||
private partial class SystemTitleImage : Sprite | ||
{ | ||
public readonly APISystemTitle SystemTitle; | ||
|
||
public SystemTitleImage(APISystemTitle systemTitle) | ||
{ | ||
SystemTitle = systemTitle; | ||
} | ||
|
||
[BackgroundDependencyLoader] | ||
private void load(LargeTextureStore textureStore) | ||
{ | ||
var texture = textureStore.Get(SystemTitle.Image); | ||
if (SystemTitle.Image.Contains(@"@2x")) | ||
texture.ScaleAdjust *= 2; | ||
Texture = texture; | ||
} | ||
} | ||
} | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Astute readers will inevitably point out that this (a) doesn't exist yet, (b) is not an API call.
I agreed upon doing this in this way with @peppy beforehand. Can be tested via e.g.
python3 -m http.server
or something (and changing URL, and probably also allowing insecure requests).