Skip to content

Commit fffb731

Browse files
authored
Update README.md
1 parent 6561a48 commit fffb731

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,43 @@
11
# Dance Contest+
22
A mod to increase the functionality of Dance Contest
3+
4+
Grab the latest release from the releases section on the right and you should just be able to run the SWF using your flash player or your web browser.
5+
6+
If you want to use this on [CPSC](https://github.com/Thestickman391/CPSC), extract to \play\v2\games\dancing.
7+
8+
If you're a CPPS owner and you don't want to use my herokuapp setup then you are free to clone the repo, put `retrieve_osu!_from_url.php`,`convert_osu!_to_DC.php` and `cleanup.php` somewhere on your webserver and edit and recompile the FLA to point to your webserver instead (this is left as an exercise for the reader). **It is recommended you setup a cron job to clear /tmp/ every so often as songs will only be cleared if the user exits dance contest through pressing the quit button** (this is left as an exercise for the reader).
9+
10+
## Current Features
11+
- Importing osu!mania songs
12+
13+
## Planned Features
14+
- Importing songs to the actual song list, permanently
15+
- Using the actual osu! api to grab songs
16+
- Auto/Bot mode
17+
- Hyperspeed
18+
- Actually syncing the penguins dancing to the beat of the song
19+
- Not shitty code
20+
21+
## FAQ
22+
### Why doesn't my song work?
23+
The website I am using to grab raw OSZ files from osu! only seems to track songs with leaderboards and a few select others. Supposedly you can grab raw downloads using the osu! API but I tried tinkering around with that a few times and couldn't seem to get anywhere with it.
24+
### Why are you using an external website to download osu! songs
25+
I am lazy
26+
### Why are you using an external website to convert osu! songs (https://dance-contest-plus.herokuapp.com)
27+
I wanted people to be able to use this without setting up a local webserver. PHP requires a local webserver to run at all and I thought this made it more accessible. If you *really* want everything to be local you are free to clone the repo, put `retrieve_osu!_from_url.php`,`convert_osu!_to_DC.php` and `cleanup.php` somewhere on your webserver and edit and recompile the FLA to point to `localhost` (this is left as an exercise for the reader).
28+
### Why are you downloading the songs at all? Can't you just read them remotely?
29+
Maybe, but definitely not with AS2
30+
### Why are you using external PHP files to download/convert the songs at all? Can't you do that all inside the game?
31+
In AS3 you can in fact download and extract and read zip and text files and all that. Not in AS2 though, which is what Dance Contest is written in.
32+
### Can't you run it through an AS3 swf to get access to these features?
33+
I tried that and it had significant performance issues.
34+
### Can't you convert AS2 to AS3?
35+
There's no automatic conversion for that so I'd have to do it manually. See question 2
36+
### Some colours/animation/text positions are messed up compared to the original Dance Contest?
37+
The decompiled FLA I had access to came with these issues and fixing them manually would take quite a long time (see question 2). If you have a correctly decompiled FLA of Dance Contest I would be more than happy to use it however.
38+
### I encountered a crash/bug!
39+
That's not a question
40+
### I encountered a crash/bug?
41+
Much better
42+
### Why is your code so shit?
43+
See question 2

0 commit comments

Comments
 (0)