update & improve readme
This commit is contained in:
yugecin
parent
19ca81d3a7
commit
22a28d8978
77
README.md
77
README.md
|
|
@ -1,24 +1,69 @@
|
||||||
# opsu!dance
|
# opsu!dance
|
||||||
[example video](https://www.youtube.com/watch?v=tqZqn7nx8N0)
|
|
||||||
[another one](https://www.youtube.com/watch?v=T2AiGn2xOQo)
|
**Table of contents**
|
||||||
|
|
||||||
Originally started as a fork of [opsu!](https://github.com/itdelatrisu/opsu) with cursordance stuff. 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.
|
* [What](#What) - [Why](#Why) - [Downloads](#Downloads) - [Running](#Running) - [Building a JAR](#Building-a-JAR) - [Credits](#Credits) - [License](#License)
|
||||||
|
|
||||||
|
What
|
||||||
|
----
|
||||||
|
Fork of [opsu!](https://github.com/itdelatrisu/opsu), which is a clone of the [osu!](https://osu.ppy.sh/) rythm game.
|
||||||
|
|
||||||
|
* [example video: Cursor Dance | MOMOIRO CLOVER Z - SANTA SAN](https://youtu.be/tqZqn7nx8N0)
|
||||||
|
* [example video: osu! 50 top replays | Getty vs. DJ DiA - Fox4-Raize- [Extreme]](https://youtu.be/T2AiGn2xOQo)
|
||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
||||||
My goal is to to add cool cursordancing things to this fork, but also make it possible to play the normal way.
|
Why
|
||||||
|
---
|
||||||
### Downloads
|
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.
|
||||||
Click on the releases link (scroll up) to go to the downloadpage with prebuilt jars.
|
|
||||||
|
|
||||||
### Building
|
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, ...
|
||||||
You can find general (run/build) instructions in the original [opsu! README](README-OPSU.md).
|
|
||||||
Please note that I am only using maven, gradle scripts are not being updated.
|
|
||||||
|
|
||||||
### Credits
|
Downloads
|
||||||
opsu! was made by Jeffrey Han ([@itdelatrisu](https://github.com/itdelatrisu)). All game concepts and designs are based on work by osu! developer Dean Herbert. Other opsu! credits can be found [here](CREDITS.md).
|
---------
|
||||||
opsu!dance (everything in the src package yugecin.opsudance) was made by me ([@yugecin](https://github.com/yugecin)). Edits were made in the opsu! sources, too.
|
You can find prebuilt jars on [the releases page](https://github.com/yugecin/opsu-dance/releases).
|
||||||
|
|
||||||
### License
|
Running
|
||||||
|
-------
|
||||||
|
|
||||||
|
If you don't need to edit the source, just download a jar from [the releases page](https://github.com/yugecin/opsu-dance/releases).
|
||||||
|
|
||||||
|
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](https://github.com/itdelatrisu)). All game concepts and designs are based on work by osu! developer Dean Herbert. Other opsu! credits can be found [here](CREDITS.md).
|
||||||
|
|
||||||
|
opsu!dance (everything in the src package yugecin.opsudance) was made by me ([@yugecin](https://github.com/yugecin)). Lots of edits were made in the opsu! sources, too.
|
||||||
|
|
||||||
|
License
|
||||||
|
-------
|
||||||
**This software is licensed under GNU GPL version 3.**
|
**This software is licensed under GNU GPL version 3.**
|
||||||
You can find the full text of the license [here](LICENSE).
|
You can find the full text of the license in [the LICENSE file](LICENSE).
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue
Block a user