Go to file

Jeffrey Han 54b5469b02 Merge pull request #7 from Tillerino/modularMaven Switched to maven project. - Eclipse files have been removed from repository. jar and native dependencies have been removed from repository. - Use maven goals "compile exec:exec" to run the project. - Use maven goals "package shade:shade" to create a single jar file, which contains java, but not native dependencies. This jar file can then be used with jarsplice to create a fat jar. Natives will be extracted to /target/natives.		2014-09-11 17:03:17 -04:00
res	Added "Kochi Gothic" font.	2014-08-25 12:47:10 -04:00
src/itdelatrisu/opsu	Added "Kochi Gothic" font.	2014-08-25 12:47:10 -04:00
tools	Initial commit.	2014-06-29 22:17:04 -04:00
.gitignore	eclipse/ant -> maven	2014-09-11 11:22:32 +02:00
CREDITS.md	Added support for default playfield image and an override option.	2014-07-03 01:05:23 -04:00
LICENSE	Initial commit.	2014-06-29 22:17:04 -04:00
pom.xml	eclipse/ant -> maven	2014-09-11 11:22:32 +02:00
README.md	Resolved some reported issues.	2014-07-15 00:20:36 -04: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

Java Setup

The Java Runtime Environment (JRE) must be installed in order to run opsu!. The download page can be found 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

The LWJGL native libraries must be linked and distributed with this application. JarSplice is included in the tools directory to merge the files into a single executable fat jar for distribution.

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.