Getting Started

So you've decided to have a try? Let's go!

Important

Current versions of opsu! in this repository only support desktop platforms (Windows, Linux, etc.).

If you need opsu! on Android or iOS, please go to fluddokt's fork.

Preparation

Note

Most of Linux distributions have these things in their software repository. It's suggested to use them if possible, as they are easy to set up and maintain.

opsu! is written in Java and distributed in a single .jar file. First of all you need an appropriate version of JRE (Java Runtime Environment), either one of those below:

• Java Downloads on Oracle;
• Download from Java official website;

Also, if you want to build opsu! from source code, you need JDK (Java Development Kit) instead, which has built-in JREs.

• Red Hat Build of OpenJDK;
• The Microsoft Build of OpenJDK;
• Other versions as you wish 😜

After this please ensure the tools are available:

java -version
mvn -version

Tip

If you just want to use jar files directly, you can safely jump to the Running section.

Building

opsu! is distributed a Maven project. Surely you need to install it on your device.

Maven builds are built to the target directory under the project root.

• To create a single executable jar, execute the Maven goal package -Djar. This will compile a jar to target/opsu-${version}.jar with the libraries, resources and natives packed inside the jar.
• Setting the "XDG" property (-DXDG=true) will make the application use XDG folders under Unix-like operating systems.
• Setting the "exclude" property to "ffmpeg" (-Dexclude=ffmpeg) will exclude FFmpeg shared libraries from the jar.

Running

From source code

This is useful if you want to test your own changes to the source code. To run the project, execute the Maven goal compile.

mvn compile

After compiling, the opsu! main window will automatically show up.

With jars

You can use the java executable to launch opsu!. In a terminal do the following:

cd <path>
java -jar <executable>

In which <path> refers to the directory where opsu! jar file lies, and <executable> is the filename of the jar file.

Next Step

So does opsu! start successfully? Congratulations! Head for First Run for other things you should do to play beatmaps.

Still don't work? See if your problem is among the Frequently Asked Questions. If not, Feel free to create a discussion post!