zapsaber/README.md

43 lines
813 B
Markdown
Executable File

# zapsaber
Bzzzt!
Improving Beat Saber scores through estim since 2022!
## Configuration
Configuration is done through a JSON file named `config.json` in the same directory as `zapsaber.py`. It must look something like this:
```json
{
"username": "<your username>",
"apiKey": "<your API key>",
"code": "<your shocker's code>",
"comboA": 100,
"comboB": 300,
"comboABreak": ["vibrate", 1.0, 20],
"comboBBreak": ["shock", 1.0, 5],
"fail": ["shock", 2.0, 10]
}
```
The values for combo breaks and fail is an array.
1. `vibrate`, `shock`, and `beep` (if action is `beep`, intensity is ignored)
2. Duration
3. Intensity
## Running
You'll need Python 3.9+ and Poetry:
pip install poetry
Install dependencies:
poetry update
And run!
poetry run python zapsaber.py