salt/autopon
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Polish README

Browse Source
This commit is contained in:
Salt
2025-01-30 13:32:40 -06:00
parent cb97c0d821
commit 42590642ac
1 changed files with 13 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@@ -14,6 +14,8 @@ A python script to automatically drum commands for Patapon games
## Usage
### Invocation
See `./autopon.py -h` for a full list of usage options.
The short invocation is like so:
@@ -24,11 +26,15 @@ The short invocation is like so:
Autopon will then prompt you to hit Enter on a drumbeat, after which you have 1 measure to change focus to the game. You'll need to [tune the startup delay](#startup-delay) as well.
## Exiting
### Exiting
Tab over to your terminal on a rest measure and give it Ctrl+C
## Song Encoding
### Iterations/Repeating
By default, Autopon will repeat a sequence 10,000 times, which is enough for about 11 hours of nonstop usage. If you would like to increase or decrease this value, use the `--iterations` flag.
### Song Encoding
Songs are encoded as a sequence of characters where each character corresponds to an eighth note. The script will automatically provide a full measure of rest at the start of invocation and between every command, keeping up with the call-and-response syntax of Patapon's commands:
@@ -64,13 +70,17 @@ Several commands can be chained in sequence to, for example, automate charge-att
Song sequence: --------R-R-U-U---------R-R-L-R-
```
All default Patapon 1/2/3 songs are supported. Freestyling is currently prohibited, so using this program to summon Djinns in Patapon 1/2 or power one up in 3 is currently impossible.
## Tuning
Several components of this program are timing sensitive.
### Game BPM
As it turns out, Patapon (all of them) doesn't actually run at a round 120BPM. Instead, The actual observed BPM is 119.880BPM, and the program is hardcoded to only issue commands at this cadence. This value was picked by beating up the door at Castle of Justice for
As it turns out, Patapon (all of them) doesn't actually run at a round 120BPM. Instead, The actual observed BPM is 119.880BPM, and the program is hardcoded to only issue commands at this cadence. This value was refined through testing and ultimately picked by beating up the door at Castle of Justice for over 4 hours and measuring observed deviation, which was zero. There may still be an unknown figure, but 6 digits of precision is enough for most purposes.
**DO NOT** change the Game BPM if you are running the game at double-speed. To that end, use the `--bpm` argument to add a multiplier.
### Startup Delay