Skip to content

Commit 4c74244

Browse files
committed
docs: add log_path parameter to start_run
1 parent e9b986c commit 4c74244

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

docs/protocol-api.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -124,13 +124,13 @@ The BalatroBot API provides core functions that correspond to the main game acti
124124

125125
The following table details the parameters required for each function. Note that `get_game_state` and `go_to_menu` require no parameters:
126126

127-
| Name | Parameters |
128-
| ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
129-
| `start_run` | `deck` (string): Deck name<br>`stake` (number): Difficulty level 1-8<br>`seed` (string, optional): Seed for run generation<br>`challenge` (string, optional): Challenge name |
130-
| `skip_or_select_blind` | `action` (string): Either "select" or "skip" |
131-
| `play_hand_or_discard` | `action` (string): Either "play_hand" or "discard"<br>`cards` (array): Card indices (0-indexed, 1-5 cards) |
132-
| `rearrange_hand` | `cards` (array): Card indices (0-indexed, exactly `hand_size` elements) |
133-
| `shop` | `action` (string): Shop action to perform ("next_round") |
127+
| Name | Parameters |
128+
| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
129+
| `start_run` | `deck` (string): Deck name<br>`stake` (number): Difficulty level 1-8<br>`seed` (string, optional): Seed for run generation<br>`challenge` (string, optional): Challenge name<br>`log_path` (string, optional): Full file path for run log (must include .jsonl extension) |
130+
| `skip_or_select_blind` | `action` (string): Either "select" or "skip" |
131+
| `play_hand_or_discard` | `action` (string): Either "play_hand" or "discard"<br>`cards` (array): Card indices (0-indexed, 1-5 cards) |
132+
| `rearrange_hand` | `cards` (array): Card indices (0-indexed, exactly `hand_size` elements) |
133+
| `shop` | `action` (string): Shop action to perform ("next_round") |
134134

135135
### Errors
136136

0 commit comments

Comments
 (0)