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

More README improvements

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

14
README.md
View File

@@ -28,11 +28,11 @@ Autopon will then prompt you to hit Enter on a drumbeat, after which you have 1
### Exiting ### Exiting
Tab over to your terminal on a rest measure and give it Ctrl+C Tab over to your terminal on a rest measure and give it Ctrl+C. Additionally, Autopon will exit if it hits 0 remaining iterations: see [Iterations/Repeating](#iterationsrepeating).
### Iterations/Repeating ### 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. By default, Autopon will repeat a sequence 10,000 times, which is enough for about 11 hours of nonstop usage for a single command. If you would like to increase or decrease this value, use the `--iterations` flag.
### Song Encoding ### Song Encoding
@@ -70,7 +70,7 @@ Several commands can be chained in sequence to, for example, automate charge-att
Song sequence: --------R-R-U-U---------R-R-L-R- 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. All default Patapon 1/2/3 command 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 ## Tuning
@@ -91,3 +91,11 @@ The startup delay can be tuned by passing the `--startup-delay` parameter. Adjus
### Key Delay ### Key Delay
The default value is such that you're unlikely to need to tune it, but if you need to, you can adjust how long a key is held by specifying `--key-delay`. Adjust this value if your game drops inputs -- Patapon is typically picky about anything under 50ms. The default value is such that you're unlikely to need to tune it, but if you need to, you can adjust how long a key is held by specifying `--key-delay`. Adjust this value if your game drops inputs -- Patapon is typically picky about anything under 50ms.
## Glossary
| Term | Definition |
| --------------- | ---------- |
| command [song] | A four-drum sequence that corresponds to a directive for the Patapon army. For a list of all command songs in the games, [see here](https://patapon.fandom.com/wiki/List_of_Command_Songs). |
| drum | One of four face buttons on the PlayStation controller. The act of hitting a drum is often called "striking" it. |
| sequence | A sequence of eighth-note characters that is specified by the user and later decoded by this program to determine what drums to hit. Is intended to represent, but is not necessarily, a command song. |