zapsaber/README.md

43 lines
912 B
Markdown
Raw Normal View History

2022-11-25 06:27:56 +00:00
# ZapSaber
2022-11-24 02:19:11 +00:00
2022-11-24 20:35:08 +00:00
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,
2022-11-24 23:07:25 +00:00
"comboABreak": ["vibrate", 1.0, 20],
"comboBBreak": ["shock", 1.0, 5],
"fail": ["shock", 2.0, 10]
2022-11-24 20:35:08 +00:00
}
```
The values for combo breaks and fail is an array.
2022-11-24 23:07:25 +00:00
1. `vibrate`, `shock`, and `beep` (if action is `beep`, intensity is ignored)
2. Duration
3. Intensity
2022-11-24 23:12:46 +00:00
## Running
2022-11-25 06:15:41 +00:00
You'll need Python 3.9+ and Poetry:
2022-11-24 23:12:46 +00:00
pip install poetry
Install dependencies:
poetry update
2022-11-25 06:27:56 +00:00
Ensure you have the DataPuller mod from Mod Assistant installed, then start up Beat Saber and run ZapSaber!
2022-11-24 23:12:46 +00:00
poetry run python zapsaber.py