Make ctrl-up/down change speed modifier of mods #28071

Fabiano1337 · 2024-05-02T17:55:00Z

PageUp and PageDown now increase or decrease speed in song select.

Example
(Song Select screen and no mod is selected)

Page Down is pressed
HalfTime mod gets applied with 0.95x speed modifier
Page Down is pressed again
HalfTime mod speed modifier changes to 0.9x
same goes with PageUp and DoubleTime.

If Daycore or Nightcore are currently selected it increases those.
If the minimum rate gets surpassed Half-/Double-Time get applied

Video of it in action:
https://github.com/ppy/osu/assets/28962347/e95228d2-0e77-4ec8-9e60-17472bdc4545

Im open to any suggestions for changes and i hope this feature finds its way into osu!lazer

Osu lazer speedkeys

bdach · 2024-05-02T18:09:33Z

What is the reason for wanting this?
Why should DT/HT get preferential hotkey treatment for their settings over every other mod in the game?
Was this feature discussed anywhere at all before this PR?

Fabiano1337 · 2024-05-02T18:23:48Z

What is the reason for wanting this?
It is a quality of life feature that makes adjusting the speed of your map faster (useful for people who often push their limits and increase the speed every run of a map), with this implementation you can adjust speed the using only your keyboard.

Why should DT/HT get preferential hotkey treatment over every other mod in the game?
DT/HT are some of the most used mods in the game, HR/HD don't have any adjustability. HR and HD can be fully utilized with only a keyboard whereas DT/HT cannot. DC/NC are lesser used than DT/HT which is why i opted for DT/HT, this is up for debate tho.

Was this feature discussed anywhere at all before this PR?
No, i haven't seen this feature being discussed anywhere before, since isn't that big of a feature i thought it didn't need one. Do you want me to open a Discussion about this topic first ?

longnguyen2004 · 2024-05-02T18:33:30Z

(Not lazer dev, just my opinion) The hotkey for this cannot be PgUp/PgDown, since those are used to scroll the carousel, and I also don't like the semantic of PgUp/PgDown being changed like that, since those keys are almost always used to scroll, and not to adjust a setting. Maybe Ctrl+Up and Ctrl+Down?

bdach · 2024-05-03T05:10:20Z

No, i haven't seen this feature being discussed anywhere before, since isn't that big of a feature i thought it didn't need one. Do you want me to open a Discussion about this topic first ?

I generally prefer all unsolicited feature requests to go through discussions first in order to reduce wasted contributor effort and to gauge interest in the feature. At this time I have no idea as to whether anyone but yourself wants this feature to exist.

UX-wise I have a whole mess of doubts.

As stated above this should not use page up/down by default.
If you manually select daycore and then page-up enough to progress into track speed-up I'd probably expect nightcore to be activated. Right now double time activates.
If you manually change "adjust pitch" on DT/HT and then page-up/down enough to progress into HT/DT then mod setting is lost. It should probably be preserved.
It's not very clear what's happening if you press the binding but don't look at the footer. This gets especially weird if you e.g. speed up DT from 1.45x to 1.5x because the speed indicator on the right of the right of the mod icon in the footer disappears. I'd say there should be a toast or something showing what's changing.

Not to mention something like wind up/down that also have speed adjustments but don't get any special hotkeys.

bdach

Missing unit tests

bdach · 2024-05-03T05:11:45Z

osu.Game/Screens/Select/SongSelect.cs

+                case GlobalAction.IncreaseSpeed:
+                    increaseSpeed();
+                    return true;
+
+                case GlobalAction.DecreaseSpeed:
+                    decreaseSpeed();
+                    return true;


increaseSpeed() and decreaseSpeed() should probably be one method that accept a delta or something.

Done in 3fdbd73

bdach · 2024-05-03T05:13:56Z

osu.Game/Screens/Select/SongSelect.cs

+            var rateAdjustStates = ModSelect.AllAvailableMods.Where(pair => pair.Mod is ModRateAdjust);
+            var stateDoubleTime = ModSelect.AllAvailableMods.First(pair => pair.Mod is ModDoubleTime);
+            bool rateModActive = ModSelect.AllAvailableMods.Count(pair => pair.Mod is ModRateAdjust && pair.Active.Value) > 0;


These should not be doing mod queries or mutations via ModSelect. Use selectedMods and OsuGameBase.AvailableMods instead.

Done in 3fdbd73

bdach · 2024-05-03T05:14:54Z

osu.Game/Screens/Select/SongSelect.cs

+            }
+
+            // Find current active rateAdjust mod and modify speed, enable DoubleTime if necessary
+            foreach (var state in rateAdjustStates)


This should be asserting that there is only one rate adjust mod present rather than doing some weird loop.

Done in 3fdbd73

Fabiano1337 · 2024-05-03T12:54:11Z

I created a Discussion about this feature.
#28085

bdach · 2024-05-14T06:51:39Z

I guess the discussion seems to have gathered some support, but I'd still expect the review above to be addressed for this before this can be considered further.

Fabiano1337 · 2024-05-14T07:02:01Z

Sure,
since i still have school and stuff going on it could take me maybe a week or two.
Im currently trying to enable the mods without using ModSelect, i can't just add new mods to selectedMods since thats a readOnlyList right ?

bdach · 2024-05-14T07:12:42Z

i can't just add new mods to selectedMods since thats a readOnlyList right ?

You can replace the entire list.

Nightcore now switches into Daycore, keep Adjustpitch after change

Fabiano1337 · 2024-05-18T16:49:18Z

Do we add support for holding the button (for example every 500ms speed increases) or do we keep it like it is now that you have to press the key again ?
You mentioned a toast showing that something is changing, do you have any idea on what that could look like ?

bdach · 2024-05-20T11:21:11Z

Do we add support for holding the button (for example every 500ms speed increases) or do we keep it like it is now that you have to press the key again ?

This would already be supported if not for this early return:

osu/osu.Game/Screens/Select/SongSelect.cs

Lines 1138 to 1139 in 3fdbd73

    
           if (e.Repeat) 
        
               return false;

You mentioned a toast showing that something is changing, do you have any idea on what that could look like ?

Use the existing one. See usages elsewhere on how to display it.

…Toast to nofity user what just happend

Fabiano1337 · 2024-05-21T14:53:47Z

Seems like the toast implementation 148afd1 makes the test fail, locally they still run fine on my side

Edit : Tests fail because the SpeedChange value of RateAdjustMods are not exactly 0.95

Before I gave up on attempting to fix the method.

peppy · 2024-05-22T04:01:49Z

osu.Game/Screens/Select/SongSelect.cs

@@ -809,6 +823,125 @@ public override bool OnBackButton()
            return false;
        }

+        public void ChangeSpeed(double delta)
+        {
+            ModNightcore modNc = (ModNightcore)((MultiMod)game.AvailableMods.Value[ModType.DifficultyIncrease].First(mod => mod is MultiMod multiMod && multiMod.Mods.Count(modType => modType is ModNightcore) > 0)).Mods.First(mod => mod is ModNightcore);


This method needs a rewrite.

Could you tell me what needs to change for the rewrite so i don't do the same mistake again? (more readable, more compact, ...)

peppy · 2024-05-22T04:06:11Z

osu.Game/Overlays/OSD/SpeedChangeToast.cs

+{
+    public partial class SpeedChangeToast : Toast
+    {
+        public SpeedChangeToast(OsuConfigManager config, double delta)


This probably should actually show the speed?

The very base class is the wrong place for it because `FreeModSelectOverlay` inherits from it, and that one has different assumptions and rules than "user" selection. In particular, in non-user selection, more than one rate adjust mod may be active, which breaks the mod speed hotkey's basic assumptions.

bdach · 2024-05-24T11:24:11Z

I've basically rewritten this.

Implementation simplified & shipped off to separate component to not pollute SongSelect with it and reduce coupling between ModSelectOverlay and SongSelect
Now does nothing on free mod select screen (I haven't tested but I'm pretty sure the previous implementation would do funky stuff)
Now works on user mod select in multi when choosing free mods
Now has consistent input handling (song select would handle repeats but not mod select overlay)
Fixed broken localisations (you can't concatenate localisable strings via +).

@peppy requesting check as to whether you're willing to accept this feature or not, and if yes, on how the code looks now.
@Fabiano1337 please check my commits for the type of code (wrt simplicity and attention to detail) we expect to see from contributors. If you have follow-up questions please ask.

peppy · 2024-05-24T14:19:52Z

I'm pretty happy with how this feature works (very cool) and now the code is sane. Let's 🚢 it.

Fabian van Oeffelt and others added 7 commits May 2, 2024 18:42

Initial implementation

f534c4a

F1 also does not work with minus in song select, same behaviour

5c21a03

Comment, make code more readable, functions are now private

7527ddb

Merge branch 'master' into osu-lazer-speedkeys

fa0b631

Merge pull request #1 from Fabiano1337/osu-lazer-speedkeys

e737635

Osu lazer speedkeys

Fix Formatting

588badf

Fix Code Inspection

4b5ea6b

pull-request-size bot added the size/L label May 2, 2024

bdach requested changes May 3, 2024

View reviewed changes

Joehuu added the area:song-select label May 3, 2024

Fabian van Oeffelt added 4 commits May 18, 2024 18:37

Change Inputkeys to Ctrl+Up/Ctrl+Down

a12a20e

Speedchange now also works in Modselect

80064c4

Add Unit Tests

99f30d9

change to single Function,

3fdbd73

Nightcore now switches into Daycore, keep Adjustpitch after change

Fabian van Oeffelt added 2 commits May 21, 2024 14:47

Change Speedchange behaviour to keep changing while holding key, Add …

148afd1

…Toast to nofity user what just happend

Toast now only shows when speed is actually changed

3403789

peppy self-requested a review May 22, 2024 03:49

peppy added 2 commits May 22, 2024 11:59

Basic cleanup

99d99ce

Before I gave up on attempting to fix the method.

Fix enum not being at end (and adjust naming)

02a388c

Merge branch 'master' into lazer-speedkeys

1fdebe9

peppy reviewed May 22, 2024

View reviewed changes

peppy and others added 4 commits May 22, 2024 12:06

Use null conditional rather than implicit not-null

f979200

Add speed value to Toast

57da422

Fix test not running due to floating point number inaccuacy

abc67eb

Improve readability

0df6345

bdach self-requested a review May 24, 2024 09:51

Rewrite test

9045ec2

bdach changed the title ~~Make PGUp / PGDown change speed modifier of mods~~ Make ctrl-up/down change speed modifier of mods May 24, 2024

bdach added 6 commits May 24, 2024 13:03

Rewrite implementation

63406b6

Fix toast strings

345fb60

Fix speed controls in mod select overlay not handling repeat

8cac87e

Actually use return value

b1b2079

Merge branch 'master' into lazer-speedkeys

c800bb5

bdach approved these changes May 24, 2024

View reviewed changes

bdach requested a review from peppy May 24, 2024 11:25

peppy approved these changes May 24, 2024

View reviewed changes

peppy merged commit 2134ff7 into ppy:master May 24, 2024
13 of 17 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make ctrl-up/down change speed modifier of mods #28071

Make ctrl-up/down change speed modifier of mods #28071

Fabiano1337 commented May 2, 2024

bdach commented May 2, 2024 •

edited

Loading

Fabiano1337 commented May 2, 2024

longnguyen2004 commented May 2, 2024

bdach commented May 3, 2024 •

edited

Loading

bdach left a comment

bdach May 3, 2024

Fabiano1337 May 18, 2024

bdach May 3, 2024

Fabiano1337 May 18, 2024

bdach May 3, 2024

Fabiano1337 May 18, 2024

Fabiano1337 commented May 3, 2024

bdach commented May 14, 2024

Fabiano1337 commented May 14, 2024 •

edited

Loading

bdach commented May 14, 2024

Fabiano1337 commented May 18, 2024

bdach commented May 20, 2024

Fabiano1337 commented May 21, 2024 •

edited

Loading

peppy May 22, 2024

Fabiano1337 May 22, 2024

peppy May 22, 2024

bdach commented May 24, 2024 •

edited

Loading

peppy commented May 24, 2024

Make ctrl-up/down change speed modifier of mods #28071

Make ctrl-up/down change speed modifier of mods #28071

Conversation

Fabiano1337 commented May 2, 2024

bdach commented May 2, 2024 • edited Loading

Fabiano1337 commented May 2, 2024

longnguyen2004 commented May 2, 2024

bdach commented May 3, 2024 • edited Loading

bdach left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Fabiano1337 commented May 3, 2024

bdach commented May 14, 2024

Fabiano1337 commented May 14, 2024 • edited Loading

bdach commented May 14, 2024

Fabiano1337 commented May 18, 2024

bdach commented May 20, 2024

Fabiano1337 commented May 21, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bdach commented May 24, 2024 • edited Loading

peppy commented May 24, 2024

bdach commented May 2, 2024 •

edited

Loading

bdach commented May 3, 2024 •

edited

Loading

Fabiano1337 commented May 14, 2024 •

edited

Loading

Fabiano1337 commented May 21, 2024 •

edited

Loading

bdach commented May 24, 2024 •

edited

Loading