README.md

August 8, 2025 ยท View on GitHub

Disclaimer

This program is far from finished and it's not exactly stable either but it works most of the time.
Use danser-go or McOsu, if you're looking for a client alternative.

Preview

Click here for more video preview(s)

https://github.com/xjunko/kurarin/assets/44401509/c834fcd4-43b3-4abc-bc6a-967446b2ed77

Releases

You can get the latest development build from the CI/CD here.

Running

./kurarin [...arguments]

Settings

The program will create a settings.json file on startup for the first time, and exit right after.
The next startup will be normal.

Features

Currently supports:

  • Gameplay
  • Auto (+ cursordance)
  • Rendering (Requires FFmpeg to be installed in $PATH)
  • Storyboard
  • Replay (.osr) support

Currently does not support:

  • Stupid/Aspire maps, the program will either OOM your system or straight up crash, beware.

Building

Requirements

  • V
  • GCC/Clang
  • OpenGL 3
  • GNU make

Linux

Tested with Arch but it should work anywhere else as long as it's linux.

On the root folder of the project, run:

make

That's it :D

Credits

Some of the code is derived or literally copy-pasted from these projects, so big credits to them.