Skip to content

Ruleset installation guide

Agatem edited this page May 27, 2024 · 12 revisions

The ruleset should work on every platform that osu!(lazer) supports, with few exceptions.

Installing rulesets is very straightforward and simple.

Step 1: Navigate to osu data directory

Windows, macOS, and Linux

From the osu! settings menu, there should be a button named "Open osu! folder". Alternatively, on Windows you could navigate to the data folder directly via Windows Explorer, by default this location is %AppData%/osu!/rulesets.

Android

Note: sentakki doesn't support the DLL installation method, you can instead get a prebuilt APK with sentakki in the #android-builds channel in the hishikki Dev Server.

In Android, there isn't the "Open osu! folder" button. You can access the Android/data/sh.ppy.osulazer/files/rulesets folder using a computer.

iOS

See iOS installation guide.

Step 2: Installing the ruleset

Copy the ruleset file into the rulesets directory. Make sure that duplicate copies of the ruleset are overwritten.

All rulesets should be in this folder.

[OPTIONAL] Step 3: Installing different ruleset languages

Download the language zips of your choice. The folder(s) for languages are named by their two-letter locale code within the zips. These folders can be placed alongside the ruleset in the rulesets folder.

Locales for different rulesets can be extracted and updated in the same destination without conflicts, since they use their own localisation files within the locale folders.

Step 4: Have fun!

After completing the above steps, you may need to restart lazer if it is already open. Once lazer is started, you should see the ruleset alongside the standard rulesets.

Notes

Rulesets do NOT update automatically alongside lazer.

Most of the time, rulesets should continue to function with newer versions of lazer, but there will be times when a change in lazer may render the ruleset unplayable. In such cases, ruleset developers often release a new version of the ruleset to resolve such issues.