44 lines
1.9 KiB
Markdown
44 lines
1.9 KiB
Markdown
|
# opsu!
|
||
|
|
opsu! is an **unofficial** open-source client for [osu!](https://osu.ppy.sh/),
|
||
|
|
a rhythm game based on popular commercial games such as *Ouendan* and
|
||
|
|
*Elite Beat Agents*.
|
||
|
|
|
||
|
|
opsu! is written in Java using [Slick2D](http://slick.ninjacave.com/) and
|
||
|
|
[LWJGL](http://lwjgl.org/), 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](https://www.java.com/en/download/).
|
||
|
|
|
||
|
|
### Beatmaps
|
||
|
|
opsu! also requires beatmaps to run, which are available for download on the
|
||
|
|
[osu! website](https://osu.ppy.sh/p/beatmaplist) and mirror sites such as
|
||
|
|
[osu!Mirror](https://osu.yas-online.net/) or [Bloodcat](http://bloodcat.com/osu/).
|
||
|
|
|
||
|
|
If osu! is already installed, this application will attempt to load songs
|
||
|
|
directly from the osu! program folder. Otherwise, run this application from
|
||
|
|
one directory above the root song directory, or place songs in the generated
|
||
|
|
`songs` folder. This path can be changed at any time by editing the
|
||
|
|
`BeatmapDirectory` value in the generated configuration file.
|
||
|
|
|
||
|
|
### 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](http://ninjacave.com/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](https://github.com/itdelatrisu/)). All game concepts and
|
||
|
|
designs are based on work by osu! developer Dean Herbert. Other credits can
|
||
|
|
be found [here](CREDITS.md).
|
||
|
|
|
||
|
|
## License
|
||
|
|
**This software is licensed under GNU GPL version 3.**
|
||
|
|
You can find the full text of the license [here](LICENSE).
|