Go to file

yugecin eb96c49e6d don't include sqlite sources in packaged jar		2017-04-30 18:24:56 +02:00
res	default back button	2017-02-02 01:06:56 +01:00
src	fix crash when running for the first time	2017-04-29 14:52:53 +02:00
.gitignore	add ant build.xml (+ivy)	2017-04-30 01:53:32 +02:00
build.xml	don't include sqlite sources in packaged jar	2017-04-30 18:24:56 +02:00
CREDITS.md	New theme song.	2016-12-22 18:36:31 -05:00
ivy.xml	add ant build.xml (+ivy)	2017-04-30 01:53:32 +02:00
LICENSE	Initial commit.	2014-06-29 22:17:04 -04:00
pom.xml	don't include sqlite sources in packaged jar	2017-04-30 18:24:56 +02:00
README-OPSU.md	sync opsu's readme with upstream	2016-12-10 01:29:59 +01:00
README.md	fix toc	2017-04-30 01:58:18 +02:00
version	version bump (rel 0.4.2)	2016-12-13 15:48:50 +01:00

README.md

opsu!dance

Table of contents

What - Why - Downloads - Running - Building a JAR - Credits - License

What

Fork of opsu!, which is a clone of the osu! rythm game.

As of 2017 some major changes were made in this fork which changed the inner workings of opsu. This was done in an attempt to get more control over the base system and allowed a.o. changing resolution and skin at runtime without the need to restart the whole system. This fork was pretty even to opsu! before this change, but now there are way more differences.

Why

I made a cursordancing bot in C# for osu!, and by adding it into this clone, it allows me to do even more stuff with it. This way I can also provide this client to other players so they can play with it too, as I will not give my bot to people because I don't want to endorse cheating in any way.

My goal is to to add cool cursordancing things to this fork, but also make it possible to play the normal way. In the meantime I'm also adding various improvements to opsu! while I make a mess here, like the option menu, default back button, slider stuff, ...

Downloads

You can find prebuilt jars on the releases page.

Running

If you don't need to edit the source, just download a jar from the releases page.

Using an IDE is recommended because it is usually faster than the other options and provides debugging.

Using your favorite IDE

You should know how to do this. It's recommended to use a working directory like out to not pollute the project directory with config/db files.

Using apache maven

mvn compile

Using apache ant

Resolve dependencies first, use either:

ant ivyresolve to download dependencies using apache ivy
ant mvnresolve to download dependencies using apache mvn

Then do ant run

Building a JAR

Using ant is recommended. Ant is used since release 0.5.0

Using apache maven

mvn package -Djar, find it in the target folder.

Using apache ant

ant jar, find it in the bin folder

Credits

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

opsu!dance (everything in the src package yugecin.opsudance) was made by me (@yugecin). Lots of edits were made in the opsu! sources, too.

License

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