Skip to content

Commit 784b780

Browse files
committed
docs: update deps and style of the docs
1 parent 680fd45 commit 784b780

File tree

3 files changed

+47
-48
lines changed

3 files changed

+47
-48
lines changed

docs/contributing.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,11 @@ Guide for contributing to BalatroBot development.
1414

1515
## Prerequisites
1616

17-
- **Balatro** (v1.0.1+)
18-
- **Lovely Injector** (v0.8.0+) - [Installation](https://github.com/ethangreen-dev/lovely-injector)
19-
- **Steamodded** (v1.0.0-beta-1221a+) - [Installation](https://github.com/Steamopollys/Steamodded)
20-
- **DebugPlus** (v1.5.1+) (optional) - Required for test endpoints
17+
- **Balatro** (v1.0.1+) - Purchase from [Steam](https://store.steampowered.com/app/2379780/Balatro/)
18+
- **Lovely Injector** (v0.8.0+) - Follow the [installation guide](https://github.com/ethangreen-dev/lovely-injector#manual-installation)
19+
- **Steamodded** (v1.0.0-beta-1221a+) - Follow the [installation guide](https://github.com/Steamodded/smods/wiki)
20+
- **Uv** (v0.9.21+) - Follow the [installation guide](https://docs.astral.sh/uv)
21+
- **DebugPlus** (v1.5.1+) (optional) - Follow the [installation guide](https://github.com/WilsontheWolf/DebugPlus) - Required for test endpoints
2122

2223
## Development Environment Setup
2324

@@ -130,8 +131,13 @@ ln -s "$(pwd)" ~/.config/love/Mods/balatrobot/
130131
```powershell
131132
New-Item -ItemType SymbolicLink -Path "$env:APPDATA\Balatro\Mods\balatrobot" -Target (Get-Location)
132133
```
134+
### 3. Install Dependencies
133135

134-
### 3. Activate Virtual Environment
136+
```bash
137+
make install
138+
```
139+
140+
### 4. Activate Virtual Environment
135141

136142
Activate the virtual environment to use the `balatrobot` command:
137143

@@ -147,7 +153,7 @@ source .venv/bin/activate
147153
.venv\Scripts\Activate.ps1
148154
```
149155

150-
### 4. Launch Balatro
156+
### 5. Launch Balatro
151157

152158
Start with debug and fast mode for development:
153159

@@ -157,7 +163,7 @@ balatrobot --debug --fast
157163

158164
For detailed CLI options, see the [CLI Reference](cli.md).
159165

160-
### 5. Running Tests
166+
### 6. Running Tests
161167

162168
Tests use Python + pytest to communicate with the Lua API. You don't need to have balatrobot running—the tests automatically start the required Balatro instances.
163169

@@ -166,9 +172,6 @@ Tests use Python + pytest to communicate with the Lua API. You don't need to hav
166172
The Lua and CLI test suites **must be run separately**. Running them together (e.g., `pytest tests`) is not supported.
167173

168174
```bash
169-
# Install all dependencies
170-
make install
171-
172175
# Run all tests (runs CLI and Lua suites separately)
173176
make test
174177

docs/index.md

Lines changed: 30 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,40 @@
1-
<div style="display: flex; justify-content: center;">
1+
<style>
2+
.project-logos img {
3+
transition: transform 0.3s ease;
4+
}
5+
.project-logos img:hover {
6+
transform: scale(1.1);
7+
}
8+
</style>
9+
10+
<div class="project-logos" style="display: flex; justify-content: center; align-items: flex-end; gap: 2rem; flex-wrap: wrap;">
211
<figure style="text-align: center; margin: 0;">
312
<a href="https://coder.github.io/balatrobot/">
4-
<img src="assets/balatrobot.svg" alt="BalatroBot" width="170">
13+
<img src="assets/balatrobot.svg" alt="BalatroBot" width="120">
514
</a>
615
<figcaption>
716
<a href="https://coder.github.io/balatrobot/">BalatroBot</a><br>
817
<small>API for developing Balatro bots</small>
918
</figcaption>
1019
</figure>
20+
<figure style="text-align: center; margin: 0;">
21+
<a href="...">
22+
<img src="assets/balatrollm.svg" alt="BalatroLLM" width="80">
23+
</a>
24+
<figcaption>
25+
<a href="...">BalatroLLM</a><br>
26+
<small>Play Balatro with LLMs</small>
27+
</figcaption>
28+
</figure>
29+
<figure style="text-align: center; margin: 0;">
30+
<a href="...">
31+
<img src="assets/balatrobench.svg" alt="BalatroBench" width="80">
32+
</a>
33+
<figcaption>
34+
<a href="...">BalatroBench</a><br>
35+
<small>Benchmark LLMs playing Balatro</small>
36+
</figcaption>
37+
</figure>
1138
</div>
1239

1340
---
@@ -59,7 +86,7 @@ BalatroBot is a mod for Balatro that serves a JSON-RPC 2.0 HTTP API, exposing ga
5986

6087
[:octicons-arrow-right-24: API Reference](api.md)
6188

62-
- :material-code-tags:{ .lg .middle } __Contributing__
89+
- :octicons-people-24:{ .lg .middle } __Contributing__
6390

6491
---
6592

@@ -77,34 +104,3 @@ BalatroBot is a mod for Balatro that serves a JSON-RPC 2.0 HTTP API, exposing ga
77104

78105
</div>
79106

80-
## Related Projects
81-
82-
<div style="display: flex; justify-content: center; gap: 2rem; flex-wrap: wrap;">
83-
<figure style="text-align: center; margin: 0;">
84-
<a href="https://coder.github.io/balatrobot/">
85-
<img src="assets/balatrobot.svg" alt="BalatroBot" width="92">
86-
</a>
87-
<figcaption>
88-
<a href="https://coder.github.io/balatrobot/">BalatroBot</a><br>
89-
<small>API for developing Balatro bots</small>
90-
</figcaption>
91-
</figure>
92-
<figure style="text-align: center; margin: 0;">
93-
<a href="...">
94-
<img src="assets/balatrollm.svg" alt="BalatroLLM" width="92">
95-
</a>
96-
<figcaption>
97-
<a href="...">BalatroLLM</a><br>
98-
<small>Play Balatro with LLMs (coming soon)</small>
99-
</figcaption>
100-
</figure>
101-
<figure style="text-align: center; margin: 0;">
102-
<a href="...">
103-
<img src="assets/balatrobench.svg" alt="BalatroBench" width="92">
104-
</a>
105-
<figcaption>
106-
<a href="...">BalatroBench</a><br>
107-
<small>Benchmark LLMs playing Balatro (coming soon)</small>
108-
</figcaption>
109-
</figure>
110-
</div>

docs/installation.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ This guide covers installing the BalatroBot mod for Balatro.
44

55
## Prerequisites
66

7-
1. **Balatro** (v1.0.1+) - Purchase from [Steam](https://store.steampowered.com/app/2379780/Balatro/)
8-
2. **Lovely Injector** (v0.8.0+) - Follow the [installation guide](https://github.com/ethangreen-dev/lovely-injector#manual-installation)
9-
3. **Steamodded** (v1.0.0-beta-1221a+) - Follow the [installation guide](https://github.com/Steamodded/smods/wiki)
10-
4. **Uv** (v0.9.21+) - Follow the [installation guide](https://docs.astral.sh/uv)
7+
- **Balatro** (v1.0.1+) - Purchase from [Steam](https://store.steampowered.com/app/2379780/Balatro/)
8+
- **Lovely Injector** (v0.8.0+) - Follow the [installation guide](https://github.com/ethangreen-dev/lovely-injector#manual-installation)
9+
- **Steamodded** (v1.0.0-beta-1221a+) - Follow the [installation guide](https://github.com/Steamodded/smods/wiki)
10+
- **Uv** (v0.9.21+) - Follow the [installation guide](https://docs.astral.sh/uv)
1111

1212
## Mod Installation
1313

0 commit comments

Comments
 (0)