Skip to content

Commit d14d9b2

Browse files
committed
docs: fix english grammar
1 parent 8a0c53f commit d14d9b2

File tree

5 files changed

+22
-35
lines changed

5 files changed

+22
-35
lines changed

docs/contributing.md

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Before contributing, ensure you have:
3636
uv sync --all-extras
3737
```
3838

39-
3. **Stars Balatro with Mods**
39+
3. **Start Balatro with Mods**
4040

4141
```bash
4242
./balatro.sh -p 12346
@@ -93,7 +93,7 @@ Before contributing, ensure you have:
9393
- **Important**: Enable "Allow edits from maintainers" when creating your PR
9494
- Link to related issues
9595
- Provide clear description of changes
96-
- Include test for new functionality
96+
- Include tests for new functionality
9797
9898
### Commit Messages
9999
@@ -247,9 +247,9 @@ pytest -n 4 --port 12346 --port 12347 --port 12348 --port 12349 tests/lua/
247247
**Troubleshooting Test Failures**:
248248
249249
- **Connection timeouts**: Ensure TCP port 12346 is available
250-
- **Game state errors**: Verify game is responsive and hasn't crashed
251-
- **Invalid responses**: Check mod loaded correctly in `balatro.log`
252-
- **Balatro crashes**: Stop testing immediately, investigate crash logs, restart game before retrying
250+
- **Game state errors**: Verify the game is responsive and hasn't crashed
251+
- **Invalid responses**: Check the mod loaded correctly in `balatro.log`
252+
- **Balatro crashes**: Stop testing immediately, investigate crash logs, restart the game before retrying
253253

254254
### Documentation
255255

@@ -275,18 +275,8 @@ mkdocs build
275275

276276
- **Focus Area**: Primary development is on `src/lua/api.lua`
277277
- **Communication**: TCP protocol on port 12346
278-
- **Protocol**: Bot sends "HELLO" → Game responds with JSON state → Bot sends actions
279278
- **Debugging**: Use DebugPlus mod for enhanced debugging capabilities
280279

281-
### Architecture Context
282-
283-
The project consists of:
284-
285-
- **Lua API** (`src/lua/api.lua`): Game-side mod handling socket communication
286-
- **Python Framework** (`src/balatrobot/`): Bot development framework (being refactored)
287-
- **TCP Communication**: Real-time bidirectional communication
288-
- **Testing Suite**: Comprehensive API and integration tests
289-
290280
### Configuration System
291281

292282
The BalatroBot mod includes a sophisticated configuration system that optimizes Balatro for bot automation:

docs/developing-bots.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# Developing Bots
22

3-
BalatroBot allows you to create automated players (bots) that can play Balatro by implementing decision-making logic in Python. Your bot communicates with the game through a TCP socket connection actions to perform and receiving back the game state.
3+
BalatroBot allows you to create automated players (bots) that can play Balatro by implementing decision-making logic in Python. Your bot communicates with the game through a TCP socket connection, sending actions to perform and receiving back the game state.
44

55
## Bot Architecture
66

77
A bot is a finite state machine that implements a sequence of actions to play the game.
8-
The bot can be in one state at a time and have access to a set of functions that can move the bot to other states.
8+
The bot can be in one state at a time and has access to a set of functions that can move the bot to other states.
99

1010
| **State** | **Description** | **Functions** |
1111
| ---------------- | -------------------------------------------- | ---------------------------------------- |
@@ -16,7 +16,7 @@ The bot can be in one state at a time and have access to a set of functions that
1616
| `SHOP` | Buy items and move to the next round | `shop` |
1717
| `GAME_OVER` | Game has ended ||
1818

19-
Developing a bot boils down to provide the action name and its parameters for each of the
19+
Developing a bot boils down to providing the action name and its parameters for each state.
2020

2121
### State Diagram
2222

@@ -25,9 +25,9 @@ The following diagram illustrates the possible states of the game and how the fu
2525
- Start (◉) and End (⦾) states
2626
- States are written in uppercase (e.g., `MENU`, `BLIND_SELECT`, ...)
2727
- Functions are written in lowercase (e.g., `start_run`, `skip_or_select_blind`, ...)
28-
- Functions parameters are written in italics (e.g., `action = play_hand`). Not all parameters are reported in the diagram.
28+
- Function parameters are written in italics (e.g., `action = play_hand`). Not all parameters are reported in the diagram.
2929
- Comments are reported in parentheses (e.g., `(win round)`, `(lose round)`).
30-
- Abstract groups are written with Capital letters (e.g., `Run`, `Round`, ...)
30+
- Abstract groups are written with capital letters (e.g., `Run`, `Round`, ...)
3131

3232
<div style="text-align: center">
3333

docs/index.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,34 +17,31 @@ BalatroBot is a Python framework designed to help developers create automated bo
1717

1818
---
1919

20-
Complete setup guide covering prerequisites, Steamodded mod installation,
21-
Python environment setup.
20+
Setup guide covering prerequisites, Steamodded mod installation, and Python environment setup.
2221

2322
[:octicons-arrow-right-24: Installation](installation.md)
2423

2524
- :material-robot:{ .lg .middle } __Developing Bots__
2625

2726
---
2827

29-
Learn to develop bots, complete code examples,
30-
class structure, game state handling.
28+
Learn to develop bots with complete code examples, class structure, and game state handling.
3129

3230
[:octicons-arrow-right-24: Developing Bots](developing-bots.md)
3331

3432
- :material-api:{ .lg .middle } __Protocol API__
3533

3634
---
3735

38-
Technical reference for TCP socket communication, message formats,
39-
game states, action types.
36+
Technical reference for TCP socket communication, message formats, game states, and action types.
4037

4138
[:octicons-arrow-right-24: Protocol API](protocol-api.md)
4239

4340
- :octicons-sparkle-fill-16:{ .lg .middle } __Documentation for LLM__
4441

4542
---
4643

47-
Documentation in [llms.txt](https://llmstxt.org/) formats. Just paste the following link (or it's content) into the LLM chat.
44+
Documentation in [llms.txt](https://llmstxt.org/) format. Just paste the following link (or its content) into the LLM chat.
4845

4946
[:octicons-arrow-right-24: llms-full.txt](llms-full.txt)
5047

docs/installation.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ Before installing BalatroBot, ensure you have:
88

99
- **[balatro](https://store.steampowered.com/app/2379780/Balatro/)**: Steam version (>= 1.0.1)
1010
- **[git](https://git-scm.com/downloads)**: for cloning the repository
11-
- **[uv](https://docs.astral.sh/uv/)**: for managing Python installations, environments and dependencies
11+
- **[uv](https://docs.astral.sh/uv/)**: for managing Python installations, environments, and dependencies
1212
- **[lovely](https://github.com/ethangreen-dev/lovely-injector)**: for injecting Lua code into Balatro (>= 0.8.0)
13-
- **[steamodded](https://github.com/Steamodded/smods)**: for loading and injecting mods (>=1.0.0)
13+
- **[steamodded](https://github.com/Steamodded/smods)**: for loading and injecting mods (>= 1.0.0)
1414

1515
## Step 1: Install BalatroBot
1616

@@ -134,10 +134,10 @@ BalatroBot is installed like any other Steamodded mod.
134134
rm -rf balatrobot
135135
```
136136

137-
## Step 2: Setup Python Environment
137+
## Step 2: Set Up Python Environment
138138

139-
Uv takes care of managing Python installations, virtual environments creation and dependencies installation.
140-
To setup the Python environment for running BalatroBot bots simply run:
139+
Uv takes care of managing Python installations, virtual environment creation, and dependency installation.
140+
To set up the Python environment for running BalatroBot bots, simply run:
141141

142142
=== "Windows"
143143

@@ -247,8 +247,8 @@ The bot is working correctly if:
247247

248248
1. Game starts automatically
249249
2. Cards are played/discarded automatically
250-
3. Win the first round
251-
4. Game progresses through rounds
250+
3. Win the first blind
251+
4. Game progresses through blinds
252252

253253
## Troubleshooting
254254

docs/logging-systems.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ BalatroBot implements three distinct logging systems to support different aspect
44

55
1. [**JSONL Run Logging**](#jsonl-run-logging) - Records complete game runs for replay and analysis
66
2. [**Python SDK Logging**](#python-sdk-logging) - Future logging capabilities for the Python framework
7-
3. [**Mod Logging**](#mod-logging) - Traditional streamodded logging for mod development and debugging
7+
3. [**Mod Logging**](#mod-logging) - Traditional Steamodded logging for mod development and debugging
88

99
## JSONL Run Logging
1010

0 commit comments

Comments
 (0)