Custom Rulesets Directory

[peppy]

Until we have a more defined method of centrally tracking custom rulesets (see #11736), it would be appreciated if anyone working on a custom ruleset could link it (along with any details, shortcomings, etc.) in this issue. Github repository links are preferred (one comment per ruleset).

This will help us better manage breaking changes and reach out if we need further information.

Template:

**Name:** <name of project>
**URL:** <github url>
**Status:** <early development/wip/playable/etc>

Please feel free to edit your post with changelog-style updates when forward progress is made.

As an aside, a listing of dependent projects can be found here, which generally includes custom rulesets.

Please only post rulesets which are in a playable state.

[andy840119]

Name: karaoke!
URL: https://github.com/karaoke-dev/karaoke
Video: https://www.youtube.com/watch?v=Ui9mej5fhc0
Blog: https://blog.karaoke.dev/
Discord: https://discord.gg/TBTVaJW
Status: working back to the editor again.
.
Sample beatmap can download from here
.
Note :
Working on implementing full-editor for able to make karaoke beatmap from zero, so the gameplay feature might not have any update recently.
If the ruleset cause crash, please try to update to the latest version, or report in Discord channel

[andy840119]

2022.07 - start making the reference lyric mode for syncing the properties for those similar lyrics, see karaoke-dev/karaoke#1444

[andy840119]

2022.10 - Start implementing the new layout in the lyric editor, see karaoke-dev/karaoke#1594

[andy840119]

2022.12 - Start implement the classic stage editor, for able to let mapper edit the lyric position and start/end time. see karaoke-dev/karaoke#1765

[andy840119]

2024.04 - Damn why there's no new ruleset last year?

[jorolf]

Name: pippidon
URL: https://github.com/jorolf/pippidon
Status: finished(?)

This is a barebones implementation of a ruleset which I only update rarely

[naoei]

Name: tau // τ
URL: https://github.com/naoei/tau
Status: Finished

Not my original work, original idea was from Pizzapip.

[EVAST9919]

Name: bosu!
URL: https://github.com/EVAST9919/bosu
Status: usable (but buggy due to amout of HitObjects)

Idea from I wanna be the Boshy game.

[LumpBloom7]

Name: sentakki
URL: https://github.com/LumpBloom7/sentakki
Status: Playable, still maintained

sentakki is a recreation of maimaiDX within osu! that attempts to match the mechanics and spirit of the original game.

Gameplay_demo_20250219.mp4

[LumpBloom7]

2021.602.0: TOUCH notes (the blue one) are now much more enjoyable, and is now part of beatmap conversion.

2023.924.0: A revamped beatmap converter has been introduced, providing more playable maps, among many other things. Check out the release for more details

[swoolcock]

Name: Rush!
URL: https://github.com/swoolcock/rush
Status: Playable, WIP

Loosely based on Muse Dash.

Edit: Prerelease now available for download.

[Flutterish]

Name: Hitokori ( Fire and Ice )
URL: https://github.com/Flutterish/Hitokori
Status: Playable

Based on A dance of Fire and Ice

[GSculerlor]

Name: Cytosu
URL: https://github.com/GSculerlor/Cytosu
Status: Playable. Work-in-progress, planned a lot of updates in the future.
Demo: https://www.youtube.com/watch?v=m--VLS8FCfQ

Just like its name, this ruleset based on Cytus

[EVAST9919]

Name: Swing
URL: https://github.com/EVAST9919/lazer-swing
Status: WIP (but most features have been done)

[LumpBloom7]

Name: Hishigata
URL: https://github.com/LumpBloom7/hishigata
Status: Playable, with touch support on Android and iOS
Video: https://www.youtube.com/watch?v=IZp-g8tw7LU

[goodtrailer]

Name: soyokaze!
URL: https://github.com/goodtrailer/soyokaze
Status: Finished
Video: https://youtu.be/hWjG0W7EiAE

A ruleset mimicking Genshin Impact's Ballads of Breeze mini-game with some extra niceties like skinning, SR calculation, statistics, etc.

[NekomusuMae]

Can we place rules on when a entry can be added because at the moment, an entry can be added the moment it has a URL to link to. I'm not speaking on osu!gita, I'm talking about the multiple "rulesets" on this issue page that were published to GitHub, entered here, and then never updated even though their code is only test code. Feel free to call me out if I'm speaking out of line here but I feel we should apply a minimal level of progress before allowing an entry.

[peppy]

I've added an extra line to the opening post saying rulesets must be playable, and hidden any which aren't.

[EVAST9919]

Name: Touhosu
URL: https://github.com/EVAST9919/touhosu
Status: playable

[Flutterish]

Name: Solosu
URL: https://github.com/Flutterish/Solosu
Status: Playable

This ruleset is vaguely based on Solous and apparently Audiosurf
Video (not up to date as I completely removed tapping)

[EVAST9919]

Name: Sandbox
URL: https://github.com/EVAST9919/lazer-sandbox
Status: WIP, Playable

Not really a ruleset, but a set of minigames/other stuff. Currently contains:

• 2048 game
• FlappyDon (moved from framework templates)
• music visualizer (moved from m-vis, thus replacing it)

[bdach]

the ruleset APIs were NOT intended to add fullscreen overlays like this. you should fully expect this to be broken at some point once the ruleset API surface is locked down.

it was the long term plan to have such an overlay in place, but the pieces are not there yet. i'm not super sure jumping the gun like this is helpful. it will 99% increase support burden on our side.

[peppy]

Please don't do this.

[hwabis]

Name: Pump Trainer
URL: https://github.com/hwabis/pump-trainer
Status: playable

A clone of Pump It Up. The main appeal is that the beatmap converter generates realistic PIU charts that are playable with 2 feet.

[michioxd]

Name: space
URL: https://github.com/michioxd/osu-space
Status: playable, wip

Sound Space (Roblox) ported (or clone heh...) to osu! Editor implemented.
Demo: https://www.youtube.com/watch?v=Q-KHIsqJ-5E

[OneDEV135]

so it's basically rhythia

[harsiz]

Name: "vis" (SoundVis)
URL: https://github.com/harsiz/soundvis
Status: playable, wip

I guess it's based on Beatblock and Taiko..? Maybe

[QingQiz]

Name: bms
URL: https://github.com/QingQiz/BmsRuleset
Status: Playable

osu! BMS Ruleset

Play BMS-family charts natively in osu!lazer

osu! BMS Ruleset is a native osu!lazer ruleset plugin for playing .bms, .bme, .bml, and .pms charts.

It brings traditional BMS gameplay, keysound-based audio, background animations, gauges, scoring, difficulty tables, and detailed performance analysis into the osu! interface.

Native BMS gameplay in osu!lazer

Highlights

• Native BMS support
  Play BMS-family charts directly in osu!lazer with BPM and STOP changes, keysounds, BGA, long notes, mines, random branches, scroll changes, and other commonly used BMS features.

• Authentic judgements and scoring
  Uses beatoraja-compatible timing windows with PGREAT, GREAT, GOOD, BAD, POOR, and E-POOR judgements. Scores use the traditional EX-score system alongside osu!'s normalized score display.

• Six BMS gauges
  Choose between Assist Easy, Easy, Normal, Hard, EX Hard, and Hazard. Auto Gauge starts from the hardest gauge and moves down through the available tiers when necessary.

• osu!mania skin support
  Use your current osu!mania skin as the foundation of the playfield, provide dedicated BMS skin settings, or use the ruleset's built-in fallback skin.

• Clear lamps
  Beatmap panels display your best matching local clear status, from No Play and Failed through the standard clear types to Full Combo, Perfect, and Max.

• Difficulty tables
  Import LR2/beatoraja-compatible difficulty tables from URLs or JSON files. Matching charts receive difficulty markers and are automatically organized into collections.

• BMS gameplay options
  Includes Auto Scratch, Hide Scratch, Background Keysound, Mirror, lane randomization, note randomization, rotation randomization, LN/CN/HCN modes, Double Time, Half Time, and more.

Song Selection and Difficulty Tables

Clear lamps are displayed directly in song select and follow the selected gameplay modifiers.

LR2/beatoraja difficulty tables can be imported from a URL or local JSON file. Matching charts receive table markers in their difficulty names, and each table automatically creates a collection for browsing its charts.

Well-known tables such as Satellite, Stella, Insane BMS, Overjoy, Scramble, and Luminous are available as presets.

Detailed Result Analysis

The result screen provides BMS-focused analysis beyond the standard score summary:

• Gauge history for every available gauge type
• Note and judgement timelines
• Fast and late timing distribution
• Hit scatter and hit-offset graphs
• Per-key timing breakdowns
• Statistics for previously saved scores

Visual Skin Editing

Arrange, resize, and configure BMS gameplay components through osu!'s visual skin editor.

Editable components include the playfield, combo counter, judgement display, gauge, song progress, BGA, chart messages, and the panel comparing your current EX score and judgement counts against your personal best and target.

Importing Charts

1. Open osu!'s settings and find the BMS section.
2. Select Import BMS files.
3. Navigate to a folder containing BMS charts.
4. Import an individual chart, the current folder, or an entire directory recursively.
5. Wait for the imported charts to appear in song select.

Select individual charts, import the current folder, or scan a directory recursively.

For the complete feature matrix, technical documentation, known limitations, and source code, visit the project repository.

GitHub Repository | Download Releases