Add more to the README

This commit is contained in:
Salt 2025-01-30 14:00:52 -06:00
parent aa78f60ed7
commit 82b4c101c1

@ -2,6 +2,12 @@
A python script to automatically drum commands for Patapon games
## Overview
Autopon is a python script that automatically issues commands to your troops by specifying a sequence of inputs. It uses high-resolution perf timers to ensure it stays on-beat. It avoids a common footgun of other macro solutions in that I've already done the headache work of figuring out that Patapon is slightly slower than the 120BPM everybody says it is.
This script's purpose is primarily to aid in grinding, mostly for Patapon 3 class skills but potentially (or eventually) other things as well, like material/hunting missions, experience grinding, etc.
## Requirements
1. `ydotool` must be installed, in `$PATH`, and its socket configured appropriately. If necessary, specify the envvar `YDOTOOL_SOCKET` per ydotool(1)
@ -99,3 +105,17 @@ The default value is such that you're unlikely to need to tune it, but if you ne
| 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. |
## TODO
Features I'd like to add:
* Specifying a separate set of setup commands, so you could gain fever, charge-defend, and then defend forever to continue a hero mode or something
* Set up pre-defined sequences for common tasks, like running P3's defense minigame
* Creating a table of Djinn minigame answers for Patapon 1/2 and letting the user drop them in easily after a Djinn command
* Automatic return-to-hideout, re-run functionality for Patapon 3
* Figure out how the fuck I'm supposed to do Patapon 3's Djinn and its faster BPM on-the-fly (the answer is probably "don't")