Skip to content
zanthousPublic

About

an osu! lazer ruleset played on controller

Topics

Resources

Stars

38 stars

Watchers

0 watching

Forks

Repository files navigation

Zankai Games discord: https://discord.gg/9PdMuVHbRE

Use the auto-updater mod to keep Sticks up to date easily: https://github.com/zanthous/zankai-osu-updater/releases

This readme is autogenerated. Refer to the release Youtube video for an overview of this mod: https://www.youtube.com/watch?v=2Z1Irkq7Uuw

To install, put the Sticks dll in the rulesets folder. To find osu!'s rulesets folder easily, you can use the in-game Open osu! folder button

image

License

Sticks is source-available for noncommercial use. Gameplay media and event monetization is permitted. Zankai LLC retains commercial rights, and ppy Pty Ltd has a separate grant for official osu! products and services. See LICENSE.md and THIRD_PARTY_NOTICES.md.

Sticks for osu!lazer

Sticks is a standalone external ruleset prototype for dual-analogue controllers.

  • The left stick is blue and the right stick is red.
  • Notes and sliders travel from the center toward the circular judgment line.
  • Flick notes require entering the recharge zone, then crossing outward at the target angle near the hit time.
  • Click notes are unfilled coloured halos approaching the ring. Press L1/L2/L3 for left or R1/R2/R3 for right; Strum restricts clicks to L3/R3. Stick angle and position do not matter. Clicks can be placed alongside sliders and use timing-only 300/100/50 scoring.
  • Sliders require hitting the head and continuously following the displayed angular path with the assigned stick. After missing a head or leaving the path, returning to the path can hit subsequent ticks without another flick.
  • Sliders can stay at one angle: hit the head and keep the stick held there until they finish. Older maps with holds load as stationary sliders.
  • Flick and slider heads grade timing and angle equally. Non-perfect hits show a colored dot just outside the ring at the note's angle: green for 200, lime for 175, yellow for 100, and orange for 75. Each dot starts fading immediately and disappears after 600 ms; left-stick dots sit slightly farther out so stacked doubles remain distinct. Perfect 300 hits show no dot. Failing either required component is a miss, with audio feedback.
  • Each complete head has 300 accuracy weight (150 timing + 150 aim), tracking ticks and reversals have 30, and slider tails have 150. Timing carries the head's full 300-point combo contribution with one combo increment; aim adds no extra combo. These weights are normalized to a 1,000,000 maximum before mod multipliers. Previously saved scores retain their stored values; replay recalculation uses the current weights.
  • Stationary sliders use independent head, beat tick, and tail checkpoints. Leaving the target loses only checkpoints crossed while away, and tracking/audio resume on return.
  • Standard circles convert to flicks. Standard sliders and other duration objects convert to generated circular slider patterns.
  • Source hold notes and spinners convert to stationary sliders.

Gameplay and the editor both use centre-out visuals. Playfield dim in Settings → Rulesets → Sticks darkens the area inside the hit circle (70% by default, adjustable from 0–100%). Hide centered cursors hides sticks near the center and keeps them visible when held outward; it is off by default.

Sticks automatically enables Device: Joystick/Gamepad as soon as you switch to Sticks, including when starting osu! with Sticks already selected. Gameplay, the editor, and the controller speed test also enable it when opened.

Sticks reads each stick exactly as the controller reports it. osu!'s Deadzone threshold is switched off while gameplay, the editor, or the controller speed test is open, and your value is put back afterwards. A flick triggers at the real Flick activation distance, and the stick recharges once it returns 24% of its travel below that (71% by default), the same in every direction. The innermost 10% reads as centred so a resting stick stays still.

Approach Rate can be set in Settings → Rulesets → Sticks, or use lazer's standard decrease/increase scroll-speed bindings (F3/F4 by default) during gameplay. F3/F4 changes AR by 0.5, while Shift+F3/F4 changes it by 0.1. The default is AR 7.5 / 825 ms. Map AR does not affect this setting. Difficulty Adjust's speed setting, Double Time, and Half Time preserve the same approach duration in real time.

The ruleset provides Easy, Hard Rock, No Fail, Sudden Death, Perfect, Half Time, Double Time, Autoplay, Relax, Difficulty Adjust, and Strum. Strum replaces outward flick activation with trigger or shoulder-button presses while the corresponding stick is aimed outward. Circle Size controls the primary angular grading band using the current anchor curve: 45° at CS 0, 35° at CS 3, 27.5° at CS 4, 22.5° at CS 5, 20° at CS 5.4, and 15° at CS 10. Near misses within half of this angle get partial credit. Difficulty Adjust can override the primary angle, playback speed, reversal conversion, and whether 80% physical stick travel reaches the playfield edge; the secondary angle remains half of the primary angle.

Star difficulty separately models same-stick neutral-reset speed, angular reading complexity, continuous slider control, and two-stick coordination. Per-object strain is aggregated with diminishing standard-style weighting, so sustained patterns matter without scaling linearly with map length. OD contributes through timing windows and a mild accuracy factor, and player AR is intentionally excluded.

CS scales the calibrated rating using the grading bands actually applied to the objects, including Difficulty Adjust overrides. With the usual secondary band at half the primary width, precision demand is p = 27.5 / primary width. Tighter windows (CS above 4) use the factor 1 + 0.606 * (p - 1)^1.28; wider windows use sqrt(p). CS 4 is neutral. The angular adjustment has no separate cap and scales proportionally to the map's base rating.

Star difficulty is NOT currently well calibrated and needs significant work to be improved. For this to happen, a pool of user created maps will likely be needed.

The converter treats the two sticks as separate resources: simultaneous notes split across them, notes during a slider prefer the free stick, and ordinary notes form short hand phrases rather than naïvely alternating every object. Source sliders retain their relative speed changes through circular movement, capped at 720°/s. Sliders above 360°/s gain proportionally wider targets, reaching double width at 720°/s.

The default converter creates coordinated two-stick patterns, independent accompaniment, interleaved sustains, paired sliders and occasional exact stacked doubles. Source phrases can give each hand a distinct role while preserving manual attacks and protected jump patterns. Moving voices retain source timing, including speed changes, pauses and reversals. Parity uses this complete conversion as its base. The former Counterpoint (CP), Duet (DU) and Parity + Duet (PD) mods remain hidden for saved-mod compatibility; they are not separate conversion choices.

Introduced simultaneous play is reduced on beginner maps using the original osu!standard star rating: none up to 1.6★, 30% of the normal allowance at 2★, and the full allowance at 3★. Higher-rated conversions are unaffected.

The Conversion category contains Difficulty Adjust, Parity, Encore, and Solo:

  • Parity (PA) expands each stick's original turns using a flexible 135° preference. It operates on the complete default conversion, preserving timing, stick assignments and slider shapes. Local rhythm and movement adjust its strength; slider endpoints count, and two beats of rest start a new phrase.
  • Encore (EN) adds click notes during conversion. Clicks use spaced notes, favouring nearby accents without requiring special hitsounds. Easier maps leave more time between clicks and surrounding note starts. It can be combined with Parity or Difficulty Adjust.
  • Solo (SO) converts without simultaneous two-stick play. Sequential notes can still use either stick.

These conversion mods preserve authored Sticks maps. Simultaneous opposite-stick directional heads align to their circular midpoint when their visible arcs overlap by at least half of the narrower arc. These doubles render at exactly the same angle, and intentional exact stacks survive Parity. Exactly stacked heads have a diamond collar around their shared aiming tick until either head is judged. The local mapreference/ folder is excluded from Git; its maps informed the reference analysis and experiment notes.

Authored notes can have individual sizes. Select a flick, a slider's head, or a slider point to edit its Size (×). Slider width and judgement tolerance interpolate linearly between points. Difficulty accounts for the size where movement occurs. Existing sliders keep their uniform size, and conversion does not generate variable sizes. Clicks and Slices keep their fixed shapes.

Slice notes are temporarily disabled in Encore conversion and the editor's placement tools. Existing authored Slices remain supported: move the matching cursor through their small coloured circles without recharging or flicking. Directional variants require clockwise or counterclockwise movement, indicated by an arrowhead.

Ambidextrous (AM), under Difficulty reduction, allows either controller side to hit either colour, including click buttons. A slider follows whichever stick acquired it. Simultaneous notes still need separate inputs. This mod is unranked.

Skins

Sticks supports custom playfield artwork, cursors and cursor trails, note-centre and reversal markers, double-note collars, click halos, judgement dots and stick colours. Missing assets use the built-in visuals. Gameplay and editor previews use the same skin. See the asset guide and importable example skin.

Build and install

The default local build requires the .NET 10 SDK and uses the newest published osu! NuGet packages. Published releases provide separately named DLLs for the supported stable lazer and Tachyon versions; install the DLL matching the osu! version you use.

dotnet restore .\osu.Game.Rulesets.Sticks.sln
dotnet test .\osu.Game.Rulesets.Sticks.sln -c Release

Copy the resulting DLL into the rulesets directory inside lazer's data folder, then restart lazer:

osu.Game.Rulesets.Sticks\bin\Release\net10.0\osu.Game.Rulesets.Sticks.dll

Use Settings → Open osu! folder if you do not know where lazer's data folder is.

Releases

Pushing a tag beginning with v runs the full test suite and creates or updates the matching normal GitHub Release. Numeric versions such as v1.0.7 are reserved for ruleset updates. The daily compatibility workflow checks the newest official stable lazer and Tachyon tags before building; when either changes, it tests only the changed channel and publishes the next lettered normal release, such as v1.0.6a or v1.0.6b.

Automatic compatibility releases contain a separately named DLL for each supported osu! channel. Download the DLL whose filename matches your lazer or Tachyon release. When only one upstream channel changes, the other channel's already-tested DLL is carried forward without rebuilding.

git tag v0.1.0
git push origin v0.1.0

In-client editor

Sticks has a circular editor inside osu!lazer. To start from an imported song:

  1. Select an osu!standard difficulty for the song.
  2. Open Settings → Rulesets → Sticks.
  3. Choose Create blank Sticks difficulty to keep the song, metadata, and timing but map from scratch, or Create editable converted Sticks difficulty to use the converter as a starting point.
  4. The new database-backed Sticks difficulty opens directly in lazer's editor.

Use the left editor toolbox (or number keys) to select Flick, Slider, or Click:

  • Notes use the same centre-out visuals and shared ring as gameplay. When placing a note, click just outside the ring for the left stick or just inside it for the right stick. Farther outside selects both sticks: a purple preview places an exact pair with one undo step. This also works for click halos and sliders. Outside the placement area, no preview is drawn.
  • Flick: click near the ring to place the note.
  • Click: select the Click tool and place a halo. The placement angle does not affect gameplay.
  • Slider: click near the ring to start, trace an arc for movement or stay at the same angle for a stationary slider, then scroll to the end time. Left-click (or release a held left button) finishes; right-click places the point and starts the next span. Mouse distance never changes duration. Ctrl+Z cancels an unfinished point before undoing earlier edits.
  • Selected slider: drag its endpoint on the timeline to change duration.
  • Selected slider: click a point handle to inspect that point, or anywhere else on the slider to inspect its head. The selection outline follows the point being edited. Drag a point handle to move that point. Timing stays fixed, and moving a point keeps later endpoints in place. Hold Shift to snap to 15° increments.
  • Selected slider: click the + beside its tail to add a point. The editor jumps to the tail time; trace the next span and scroll to its end time. Left-click finishes, or right-click places the point and continues. Each new span keeps the earlier timing intact and needs a later end time. Escape cancels only the pending point, keeping finished segments.
  • Drag visible notes or slider ribbons to change their angle. Grouped selections preserve their angular pattern and stick assignments.
  • The inspector follows the selected slider head or point; use the Head / Point selector to reach points outside the current view. The head exposes angle, start time, size, and the first segment's turn, duration and speed. Each point exposes its size and the turn, duration and speed of the segment following it. The final point has only size because no segment follows it. Select matching sliders to edit their corresponding points together. Stick changes apply to the whole note immediately; Both creates matching notes for both sticks when there is room. Choose Left or Right on a selected pair to keep only that stick. Numeric fields commit on Enter or when you leave the field. Each edit is validated and undoable. Escape cancels the current field's draft.
  • Set a slider segment's Speed (°/s) to adjust its turn angle while keeping its duration. Positive values turn clockwise, negative values turn counterclockwise, and zero makes it stationary.

Normal editor save, Ctrl+S, undo/redo, dirty-state warnings, timing, setup, timeline, test-play, copy, and paste remain available. Same-time placement replaces matching objects on the selected stick; purple placement replaces both sides together.

Authored gameplay data is versioned inside ordinary mode-0 carrier objects. The Sticks converter reconstructs angles, sides, durations, slider arcs, and repeats exactly when the difficulty is reopened or shared; unmarked standard maps continue to use procedural conversion. This provides editor persistence without patching osu!lazer.

The ruleset settings can restore an Sticks difficulty after lazer's external-edit flow changes its displayed mode, or export the selected difficulty as an .osz with its song and resources.

Completed plays retain their Sticks replay automatically. Failed plays retain a replay only when explicitly saved. Replay storage can be disabled for future plays under Settings → Rulesets → Sticks without disabling score saving.

Repository layout

  • osu.Game.Rulesets.Sticks/: ruleset implementation.
  • osu.Game.Rulesets.Sticks.Tests/: unit and format-compatibility tests.

About

an osu! lazer ruleset played on controller

Topics

Resources

Stars

38 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages