Go to file

Jeffrey Han 90295eefb8 GameOption overhaul - moved more scattered bits into the enum. - Added overridden methods read() and write() for reading from and writing to the options file within the GameOption enum, so that only 1 section needs to be changed when adding new options (instead of 3). - Added 'displayName' field to the GameOption enum, instead of repeating it in the parseOptions() and saveOptions() methods. - Added internal options (directories, port, theme song) into the GameOption enum for consistency. - Removed GameOption.NULL. Signed-off-by: Jeffrey Han <itdelatrisu@gmail.com>		2015-06-12 15:04:20 -05:00
res	New optional slider style	2015-06-08 15:52:06 +02:00
src	GameOption overhaul - moved more scattered bits into the enum.	2015-06-12 15:04:20 -05:00
tools	Removed tools/jarsplice-0.40.jar.	2015-05-17 15:38:58 -04:00
.gitignore	Added hit animations, updated lighting & added InteliJ to gitignore	2015-04-06 23:08:49 +01:00
CREDITS.md	Implemented follow points.	2015-03-18 22:20:37 -04:00
LICENSE	Initial commit.	2014-06-29 22:17:04 -04:00
pom.xml	Updating to 0.9.0.	2015-05-17 16:51:30 -04:00
README.md	Added gh-pages link in README.	2015-03-04 22:36:48 -05:00

README.md

opsu!

opsu! is an unofficial open-source client for osu!, a rhythm game based on popular commercial games such as Ouendan and Elite Beat Agents. It is written in Java using Slick2D and LWJGL, wrappers around the OpenGL and OpenAL libraries.

opsu! runs on Windows, OS X, and Linux platforms. A libGDX port additionally supports Android devices.

Getting Started

Precompiled binaries for opsu! can be found on the releases page, with the latest builds at the top. APK releases can be found here.

Java Setup

The Java Runtime Environment (JRE) must be installed in order to run opsu!. The download page is located here.

Beatmaps

opsu! requires beatmaps to run, which are available for download on the osu! website and mirror sites such as osu!Mirror or Bloodcat. Beatmaps can also be downloaded directly through opsu! in the downloads menu.

If osu! is already installed, this application will attempt to load songs directly from the osu! program folder. Otherwise, place songs in the generated Songs folder or set the BeatmapDirectory value in the generated configuration file to the path of the root song directory.

Note that beatmaps are typically delivered as OSZ files. These can be extracted with any ZIP tool, and opsu! will automatically extract them into the songs folder if placed in the SongPacks directory.

First Run

The Music Offset value will likely need to be adjusted when playing for the first time, or whenever hit objects are out of sync with the music. This and other game options can be accessed by clicking the "Other Options" button in the song menu.

Building

opsu! is distributed as a Maven project.

To run the project, execute the Maven goal compile exec:exec.
To create a single executable JAR file, execute the Maven goal install -Djar. This will link the LWJGL native libraries using a modified version of JarSplice, which is included in the tools directory in both its original and modified forms. The resulting file will be located in target/opsu-${version}-runnable.jar.

Credits

This software was created by Jeffrey Han (@itdelatrisu). All game concepts and designs are based on work by osu! developer Dean Herbert. Other credits can be found here.

License

This software is licensed under GNU GPL version 3. You can find the full text of the license here.