Skip to content

Commit 27a8585

Browse files
committed
docs: explain --no-screenshot --use-default-paths flags
1 parent 0d47320 commit 27a8585

3 files changed

Lines changed: 45 additions & 3 deletions

File tree

CLAUDE.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ source .envrc
2121

2222
```
2323
usage: balatrollm [-h] [-m MODEL] [-l] [-s STRATEGY] [-u BASE_URL] [-k API_KEY] [-c CONFIG]
24-
[-d RUNS_DIR] [-r RUNS] [-p PORT]
24+
[-d RUNS_DIR] [-r RUNS] [-p PORT] [--no-screenshot] [--use-default-paths]
2525
{benchmark} ...
2626
2727
LLM-powered Balatro bot
@@ -45,6 +45,8 @@ options:
4545
Base directory for storing run data (default: current directory)
4646
-r, --runs RUNS Number of times to run the bot with the same configuration (default: 1)
4747
-p, --port PORT Port for BalatroBot client connection (can specify multiple, default: 12346)
48+
--no-screenshot Disable taking screenshots during gameplay (use when running Balatro in headless mode)
49+
--use-default-paths Use BalatroBot's default storage paths for screenshots and game logs (use when balatrobot and balatrollm are running on different systems)
4850
```
4951

5052
### Development

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,11 @@ The CLI uses sensible defaults for all other configuration:
7878

7979
# 2. Run the bot with default settings
8080
balatrollm
81+
82+
# 3. Run with optimizations for different environments
83+
balatrollm --no-screenshot # Headless mode (no screenshots)
84+
balatrollm --use-default-paths # Distributed systems
85+
balatrollm --no-screenshot --use-default-paths # Both optimizations
8186
```
8287

8388
#### `balatrollm` - Command Line Interface
@@ -88,7 +93,7 @@ balatrollm --help
8893

8994
```
9095
usage: balatrollm [-h] [-m MODEL] [-l] [-s STRATEGY] [-u BASE_URL] [-k API_KEY] [-c CONFIG]
91-
[-d RUNS_DIR] [-r RUNS] [-p PORT]
96+
[-d RUNS_DIR] [-r RUNS] [-p PORT] [--no-screenshot] [--use-default-paths]
9297
{benchmark} ...
9398
9499
LLM-powered Balatro bot
@@ -112,6 +117,8 @@ options:
112117
Base directory for storing run data (default: current directory)
113118
-r, --runs RUNS Number of times to run the bot with the same configuration (default: 1)
114119
-p, --port PORT Port for BalatroBot client connection (can specify multiple, default: 12346)
120+
--no-screenshot Disable taking screenshots during gameplay (use for headless mode)
121+
--use-default-paths Use BalatroBot's default storage paths (use for distributed systems)
115122
```
116123

117124
#### `Makefile` - Development Workflow

docs/usage.md

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,21 @@ balatrollm --runs-dir ./my-experiments
9696
balatrollm --config ./runs/v0.10.0/default/openrouter/gpt-oss-20b/20240922_red_deck_12345/config.json
9797
```
9898

99+
### Storage and Output Options
100+
101+
Control screenshot and file output behavior:
102+
103+
```bash
104+
# Disable screenshots (ideal for headless mode)
105+
balatrollm --no-screenshot
106+
107+
# Use BalatroBot's default paths (ideal for distributed systems)
108+
balatrollm --use-default-paths
109+
110+
# Combine both for optimized distributed/headless setups
111+
balatrollm --no-screenshot --use-default-paths
112+
```
113+
99114
## Parallel Execution
100115

101116
### Multiple Instances
@@ -110,6 +125,21 @@ Run multiple bot instances simultaneously:
110125
balatrollm --port 12346 --port 12347 --port 12348 --runs 15
111126
```
112127

128+
### Distributed Systems
129+
130+
Run balatrollm and BalatroBot on different systems:
131+
132+
```bash
133+
# Docker containers and remote deployments
134+
balatrollm --use-default-paths
135+
136+
# Containerized environments (no GUI, optimized storage)
137+
balatrollm --no-screenshot --use-default-paths
138+
139+
# High-volume distributed testing
140+
balatrollm --use-default-paths --runs 100 --model x-ai/grok-code-fast-1
141+
```
142+
113143
### Performance Optimization
114144

115145
For faster execution:
@@ -121,9 +151,12 @@ For faster execution:
121151
# Choose faster models
122152
balatrollm --model x-ai/grok-code-fast-1
123153

154+
# Optimize for automated/headless environments
155+
balatrollm --no-screenshot --model x-ai/grok-code-fast-1
156+
124157
# Combine multiple optimizations
125158
./balatro.sh --headless --fast -p 12346 -p 12347
126-
balatrollm --model x-ai/grok-code-fast-1 --port 12346 --port 12347 --runs 20
159+
balatrollm --model x-ai/grok-code-fast-1 --no-screenshot --port 12346 --port 12347 --runs 20
127160
```
128161

129162
## Configuration Files

0 commit comments

Comments
 (0)