34c7942f4b
This introduces more accurate timing formulas associated with the "Hidden" mod (previously, in #115, these values were hardcoded). The values seem somewhat close to the values in osu!, but were not extensively tested. Also set an upper bound on the fade in time for hit objects proportional to the approach time, or else the timing values in the "Hidden" mod would be too inconsistent. Signed-off-by: Jeffrey Han <itdelatrisu@gmail.com> |
||
|---|---|---|
| gradle/wrapper | ||
| res | ||
| src | ||
| .gitignore | ||
| build.gradle | ||
| CREDITS.md | ||
| gradlew | ||
| gradlew.bat | ||
| LICENSE | ||
| pom.xml | ||
| README.md | ||
| settings.gradle | ||
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 both a Maven and Gradle project.
Maven
Maven builds are built to the target directory.
- To run the project, execute the Maven goal
compile. - To create a single executable jar, execute the Maven goal
package -Djar. This will compile a jar totarget/opsu-${version}.jarwith the libraries, resources and natives packed inside the jar.
Gradle
Gradle builds are built to the build directory.
- To run the project, execute the Gradle task
run. - To create a single executable jar, execute the Gradle task
jar. This will compile a jar tobuild/libs/opsu-${version}.jarwith the libraries, resources and natives packed inside the 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.