Skip to content

Commit 928712b

Browse files
committed
docs: remove order list and use bullets instead
The order list with code blocks interleaved raise formatting issues.
1 parent 8484ad1 commit 928712b

3 files changed

Lines changed: 24 additions & 15 deletions

File tree

README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -40,20 +40,20 @@ These components are processed together in a single LLM call, enabling the bot t
4040
4141
### 📦 Installation
4242

43-
1. Clone the repository
43+
- Clone the repository
4444

4545
```bash
4646
git clone https://github.com/coder/balatrollm.git
4747
cd balatrollm
4848
```
4949

50-
2. Create environment and install dependencies
50+
- Create environment and install dependencies
5151

5252
```bash
5353
uv sync --no-dev
5454
```
5555

56-
3. Activate environment
56+
- Activate environment
5757

5858
```bash
5959
source .venv/bin/activate
@@ -62,7 +62,6 @@ source .venv/bin/activate
6262
> [!TIP]
6363
> You can use [direnv](https://direnv.net/) to automatically activate the environment when you enter the project directory. The `.envrc.example` file contains an example configuration for direnv.
6464
65-
6665
### ⚙️ LLM Configuration
6766

6867
BalatroLLM performs single requests to an OpenAI-compatible chat/completions endpoint. You need to configure:
@@ -86,19 +85,19 @@ The default configuration uses [OpenRouter](https://openrouter.ai/), which provi
8685

8786
The typical workflow to run BalatroLLM is:
8887

89-
1. Start Balatro with the BalatroBot mod:
88+
- Start Balatro with the BalatroBot mod:
9089

9190
```bash
9291
bash balatro.sh
9392
```
9493

95-
2. Run the bot, typically with multiple runs using the same configuration:
94+
- Run the bot, typically with multiple runs using the same configuration:
9695

9796
```bash
9897
balatrollm --runs-per-seed 3 --seed ABCDEFG
9998
```
10099

101-
3. Generate benchmark reports from the runs:
100+
- Generate benchmark reports from the runs:
102101

103102
```bash
104103
balatrobench --models

docs/setup.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,28 +16,28 @@ This guide will help you install and configure BalatroLLM.
1616

1717
## Installation
1818

19-
1. Clone the repository
19+
- Clone the repository
2020

2121
```bash
2222
git clone --depth 1 https://github.com/coder/balatrollm.git
2323
cd balatrollm
2424
```
2525

26-
2. Create environment and install dependencies
26+
- Create environment and install dependencies
2727

2828
```bash
2929
uv sync --no-dev
3030
```
3131

3232
When running `uv sync`, `uv` automatically downloads the required Python version, creates a new environment at `.venv`, and installs the project dependencies.
3333

34-
3. Activate environment
34+
- Activate environment
3535

3636
```bash
3737
source .venv/bin/activate
3838
```
3939

40-
4. Test that the new commands are available
40+
- Test that the new commands are available
4141

4242
```bash
4343
balatrollm --help
@@ -48,7 +48,7 @@ balatrobench --help
4848

4949
You can use [direnv](https://direnv.net/) to automatically activate the environment when you enter the project directory. The `.envrc.example` file contains an example configuration for direnv.
5050

51-
## Provider Configuration
51+
## Provider Configuration
5252

5353
You need to configure your chosen provider. We recommend configuring the provider through environment variables using `.envrc` (see `.envrc.example`)
5454

docs/usage.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,19 @@ Learn how to run BalatroLLM, configure strategies, and customize gameplay parame
66

77
Assuming that you have followed the [setup guide](setup.md) and configured the provider, you can run BalatroLLM with the following steps:
88

9-
1. Start Balatro with the BalatroBot mod using the utility script:
9+
- Start Balatro with the BalatroBot mod using the utility script:
1010

1111
```bash
1212
bash balatro.sh
1313
```
1414

15-
2. Start BalatroLLM:
15+
- Start BalatroLLM:
1616

1717
```bash
1818
balatrollm --model openai/gpt-oss-20b
1919
```
2020

21-
3. Watch the gameplay!
21+
- Watch the gameplay!
2222

2323
## Advanced Usage
2424

@@ -27,11 +27,15 @@ balatrollm --model openai/gpt-oss-20b
2727
The `BALATROBOT_*` variables are used to configure Balatro and BalatroBot. It is recommended to set the variables that you don't change often in the `.envrc`.
2828

2929
- `BALATROBOT_HOST`: The host to run the server on. Defaults to `127.0.0.1`.
30+
3031
- `BALATROBOT_PORT`: The port to run the server on. Defaults to `12346`.
3132

3233
- `BALATROBOT_HEADLESS`: Avoid rendering the game on the screen. Set to `1` to enable.
34+
3335
- `BALATROBOT_FAST`: Faster animations and gameplay. Set to `1` to enable.
36+
3437
- `BALATROBOT_AUDIO`: Enable audio. Set to `1` to enable.
38+
3539
- `BALATROBOT_RENDER_ON_API`: Render the frame only on an API call.
3640

3741
These are the environment variables set by `balatro.sh` using its flags. For example, to run the game in fast mode, you can run: `bash balatro.sh --fast`.
@@ -43,13 +47,19 @@ Usually, you don't need to set these variables manually.
4347
The `BALATROLLM_*` variables are used as defaults for the BalatroLLM CLI. It is recommended to set the variables that you don't change often in the `.envrc`.
4448

4549
- `BALATROLLM_BASE_URL`: The base URL to use. (required)
50+
4651
- `BALATROLLM_API_KEY`: The API key to use. (usually required)
52+
4753
- `BALATROLLM_MODEL`: The model to use. (required)
4854

4955
- `BALATROLLM_STRATEGY`: The strategy to use. (default: `default`)
56+
5057
- `BALATROLLM_RUNS_PER_SEED`: The number of runs per seed. (default: `1`)
58+
5159
- `BALATROLLM_SEEDS`: The seeds to use. If empty, a random seed is used. You can also use a comma-separated list of seeds.
60+
5261
- `BALATROLLM_NO_SCREENSHOT`: Whether to take screenshots. Screenshots are not available in headless mode. (default: `0`, i.e. take screenshots)
62+
5363
- `BALATROLLM_USE_DEFAULT_PATHS`: Whether to use BalatroBot's default storage paths. It's not recommended to change this. (default: `0`)
5464

5565
Each of these variables has a corresponding BalatroLLM CLI flag. For example, `--model` is the BalatroLLM CLI flag for `BALATROLLM_MODEL`.

0 commit comments

Comments
 (0)