Skip to content

Commit 78b3fa6

Browse files
committed
Document command-line options
1 parent 7e9384f commit 78b3fa6

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,19 @@ cargo run --release maps/city.map
2929

3030
Several example maps are provided in the `/maps` directory (`city.map`, `house.map`, `nature.map`).
3131

32+
### Command-Line Options
33+
34+
- `--width <pixels>`: Set the window width (default: 800).
35+
- `--height <pixels>`: Set the window height (default: 600).
36+
- `--screenshot <path>`: Render a single frame, save it as a PNG to the given
37+
path, and exit. Can be used as a tool for agents.
38+
39+
For example, to render a 1920x1080 screenshot of a map:
40+
41+
```
42+
cargo run --release -- maps/city.map --width 1920 --height 1080 --screenshot city.png
43+
```
44+
3245
## Controls
3346

3447
### Player Movement

0 commit comments

Comments
 (0)