Skip to content

Commit 78e0127

Browse files
committed
docs: update docs index with repos assets
1 parent 4b770eb commit 78e0127

4 files changed

Lines changed: 173 additions & 19 deletions

File tree

docs/assets/balatrobench.svg

Lines changed: 38 additions & 0 deletions
Loading

docs/assets/balatrobot.svg

Lines changed: 31 additions & 0 deletions
Loading

docs/assets/balatrollm.svg

Lines changed: 49 additions & 0 deletions
Loading

docs/index.md

Lines changed: 55 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
1-
# BalatroLLM
2-
3-
<!-- TODO: This should be uncommented when the balatrollm repo is public -->
4-
5-
<!-- <figure> -->
6-
7-
<!-- <figcaption>BalatroLLM playing Balatro</figcaption> -->
8-
9-
<!-- <video controls playsinline> -->
1+
<div style="display: flex; justify-content: center;">
2+
<figure style="text-align: center; margin: 0;">
3+
<a href="https://coder.github.io/balatrollm/">
4+
<img src="assets/balatrollm.svg" alt="BalatroLLM" width="170">
5+
</a>
6+
<figcaption>
7+
<a href="https://coder.github.io/balatrollm/">BalatroLLM</a><br>
8+
<small>Play Balatro with LLMs</small>
9+
</figcaption>
10+
</figure>
11+
</div>
1012

11-
<!-- <source src="https://github.com/user-attachments/assets/777d0c4f-d66a-47dd-9eab-7efb20beaaf2" type="video/mp4"> -->
13+
---
1214

13-
<!-- Your browser does not support the video tag. -->
15+
BalatroLLM is a bot that uses Large Language Models (LLMs) to play [Balatro](https://www.playbalatro.com/), the popular roguelike poker deck-building game. The bot analyzes game states, makes strategic decisions, and executes actions through the [BalatroBot](https://github.com/coder/balatrobot) client.
1416

15-
<!-- </video> -->
17+
!!! warning "Breaking Changes"
1618

17-
<!-- </figure> -->
19+
**BalatroLLM 1.0.0 introduces breaking changes:**
1820

19-
---
20-
21-
BalatroLLM is a bot that uses Large Language Models (LLMs) to play [Balatro](https://www.playbalatro.com/), the popular roguelike poker deck-building game. The bot analyzes game states, makes strategic decisions, and executes actions through the [BalatroBot](https://github.com/coder/balatrobot) client.
21+
- **Requires BalatroBot 1.x**: This version is strictly compatible only with BalatroBot 1.x versions. Ensure your BalatroBot mod is updated.
2222

2323
<div class="grid cards" markdown>
2424

@@ -54,8 +54,44 @@ BalatroLLM is a bot that uses Large Language Models (LLMs) to play [Balatro](htt
5454

5555
[:octicons-arrow-right-24: Strategies](strategies.md)
5656

57-
</div>
57+
- :octicons-sparkle-fill-16:{ .lg .middle } __Documentation for LLM__
58+
59+
---
5860

59-
!!! tip "Docs for LLM"
61+
Docs in [llms.txt](https://llmstxt.org/) format. Paste the following link (or its content) into the LLM.
6062

61-
Documentation in [llms.txt](https://llmstxt.org/) format. Just paste [this link](llms-full.txt) (or its content) into the LLM chat.
63+
[:octicons-arrow-right-24: llms-full.txt](llms-full.txt)
64+
65+
</div>
66+
67+
## Related Projects
68+
69+
<div style="display: flex; justify-content: center; gap: 2rem; flex-wrap: wrap;">
70+
<figure style="text-align: center; margin: 0;">
71+
<a href="https://coder.github.io/balatrobot/">
72+
<img src="assets/balatrobot.svg" alt="BalatroBot" width="92">
73+
</a>
74+
<figcaption>
75+
<a href="https://coder.github.io/balatrobot/">BalatroBot</a><br>
76+
<small>API for developing Balatro bots</small>
77+
</figcaption>
78+
</figure>
79+
<figure style="text-align: center; margin: 0;">
80+
<a href="https://coder.github.io/balatrollm/">
81+
<img src="assets/balatrollm.svg" alt="BalatroLLM" width="92">
82+
</a>
83+
<figcaption>
84+
<a href="https://coder.github.io/balatrollm/">BalatroLLM</a><br>
85+
<small>Play Balatro with LLMs</small>
86+
</figcaption>
87+
</figure>
88+
<figure style="text-align: center; margin: 0;">
89+
<a href="https://coder.github.io/balatrobench/">
90+
<img src="assets/balatrobench.svg" alt="BalatroBench" width="92">
91+
</a>
92+
<figcaption>
93+
<a href="https://coder.github.io/balatrobench/">BalatroBench</a><br>
94+
<small>Benchmark LLMs playing Balatro</small>
95+
</figcaption>
96+
</figure>
97+
</div>

0 commit comments

Comments
 (0)