Go to file

Jeffrey Han e93fe25834 Code style cleanup from #12 . - Moved all curve-related classes into a new package. - Added some fields and methods to Curve abstract class. - Removed the old (no longer used) Bezier subclass. - Changed Error throwing to ErrorHandler.error() calls. - Formatted code. Also fixed a crash when reaching the ranking screen with the "Auto" mod active. Signed-off-by: Jeffrey Han <itdelatrisu@gmail.com>		2015-01-29 20:36:23 -05:00
res	Display time since achieving recent scores.	2015-01-29 03:05:09 -05:00
src/itdelatrisu/opsu	Code style cleanup from #12 .	2015-01-29 20:36:23 -05:00
tools	Automated the fat jar creation process.	2015-01-12 21:05:58 -05:00
.gitignore	Save game scores to an SQLite database. [Incomplete!]	2015-01-28 03:47:24 -05:00
CREDITS.md	Implemented skinnable theme songs.	2014-12-20 18:17:04 -05:00
LICENSE	Initial commit.	2014-06-29 22:17:04 -04:00
pom.xml	Save game scores to an SQLite database. [Incomplete!]	2015-01-28 03:47:24 -05:00
README.md	Automated the fat jar creation process.	2015-01-12 21:05:58 -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.

opsu! is written in Java using Slick2D and LWJGL, wrappers around the OpenGL and OpenAL libraries.

Getting Started

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

Java Setup

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

Beatmaps

opsu! also requires beatmaps to run, which are available for download on the osu! website and mirror sites such as osu!Mirror or Bloodcat.

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 wrench icon 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.