karaoke --dev

The source code of the karaoke ruleset, running on osu!lazer.

Status

Some features are still under heavy development, but existing features should work fine.

Please note that this project doesn't have much of a demo currently available, and most of the lyrics are written in Japanese, so we recommend looking around this project to find new features instead of actually using it, unless you understand / speak Japanese.

Also, another reason for looking around is that this project is not stable. I hope users don't start using it until most of the bugs are fixed, and the editor has been implemented.

If you run into any problems, you can shoot us an email ([email protected]) or send me a message on Discord. I will typically reply faster on Discord.

And feel free to report any bugs if found.

How to run this project

See this tutorial to get the ruleset from the existing build.

Or you can compile it yourself: release build then copy Packed/osu.Game.Rulesets.Karaoke.dll into your ruleset folder

License

This repo is covered under the GPL V3 license. If you plan on using this repo for commercial purposes, please contact us at ([email protected]) to get permission first.

Using this repo to create, use or using the beatmap format to distribution any PIRATED, unauthorized karaoke songs/beatmaps is absolutely forbidden. This repo is trying to make song author(or people has copyright) ability to distribution their songs with karaoke format without any restriction, not for copycat to make thing with copyright issue.

Thanks to

• osu! and it's framework for karaoke!

• RhythmKaTTE, RhythmicaLyrics and Aegisub, an open-source software used to create lyrics with time tags. Parts of the lyrics editor in this ruleset were inspired by them.

• ニコカラメーカー, a software to convert .lrc files into karaoke video with beautiful text effects.

• Jetbrain, for contributing a free rider license used to developing.

• Appveyor, CodeFactor and Github action for providing free CI/CD service.

• Figma, for quick creation of assets like logos or icon.

• Miro. Used for flow-charts and deciding how to structure some parts.