Skip to content

Examples ​

The examples in this repository are small programs you can run against your own osu!lazer data. Their source files also contain the text shown in this guide.

Running an example ​

sh
cd examples/<name>
npm install
npm start

Available examples ​

  • Beatmaps - Create, inspect, import, and export beatmaps and their storyboards.
  • Collections - Import, export, and edit the beatmap collections stored in Realm.
  • Replays - Import .osr files into Realm or export stored scores as replay files.
  • Skins - Import .osk archives into Realm or pack installed skins back into archives.
  • Keybindings - Register the osu! defaults, inspect an action, and replace its assigned keys.

Released under the MIT License.