osu!droid is a free-to-play circle clicking rhythm game for Android devices. It was a game hatched many years ago by the osu! community. This project is now being developed by a small group of fans and also with the help of foreign friends.

osu!droid is still work-in-progress. Some features are going to be implemented in the future but it's still playable and fun!

Clone the repository:

git clone https://github.com/osudroid/osu-droid.git

Open the folder in Android Studio.

To update the source code to the latest commit, run the following command inside the osu-droid directory:

git pull

Coding Languages:

You can code for the project in Java or Kotlin.

In Android Studio you can Build a debug release to test your changes. The output directory of your .apk is inside build/output of osu-droid's directory.

Or if you prefer the command line and you are on Linux, run chmod +x gradlew and ./gradlew assembleDebug inside the directory to build the debug .apk files but make sure that you are using Java 8.

We welcome any sort of contributions, as long as they're helpful. Those who aren't able to contribute code may instead suggest small changes like grammar fixes, new features or report client issues via Feature request or GitHub issues.

osu-droid is licensed under the Apache License 2.0. Please see the licence file for more information.