Skip to content

Commit 77df9d6

Browse files
committed
docs: add homepage to docs
1 parent f8a5b49 commit 77df9d6

File tree

2 files changed

+56
-0
lines changed

2 files changed

+56
-0
lines changed

docs/index.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
<figure markdown="span">
2+
![Image title](assets/balatrobot.svg){ width="256" }
3+
<figcaption>A framework for Balatro bot development</figcaption>
4+
</figure>
5+
6+
---
7+
8+
BalatroBot is a Python framework designed to help developers create automated bots for the card game Balatro. The framework provides a comprehensive API for interacting with the game, handling game state, making strategic decisions, and executing actions. Whether you're building a simple bot or a sophisticated AI player, BalatroBot offers the tools and structure needed to get started quickly.
9+
10+
<div class="grid cards" markdown>
11+
12+
- :material-download:{ .lg .middle } __Installation__
13+
14+
---
15+
16+
Complete setup guide covering prerequisites, Steamodded mod installation,
17+
Python environment setup.
18+
19+
[:octicons-arrow-right-24: Installation](installation.md)
20+
21+
- :material-robot:{ .lg .middle } __Bot Development__
22+
23+
---
24+
25+
Learn to build Balatro bots, complete code examples,
26+
class structure, game state handling.
27+
28+
[:octicons-arrow-right-24: Bot Development](bot-development.md)
29+
30+
- :material-api:{ .lg .middle } __API Protocol__
31+
32+
---
33+
34+
Technical reference for UDP socket communication, message formats,
35+
game states, action types.
36+
37+
[:octicons-arrow-right-24: API Protocol](api-protocol.md)
38+
39+
- :material-help-circle:{ .lg .middle } __Troubleshooting__
40+
41+
---
42+
43+
Common issues and debugging solutions for bot development
44+
and game integration problems (WIP).
45+
46+
[:octicons-arrow-right-24: Troubleshooting](troubleshooting.md)
47+
48+
</div>
49+

mkdocs.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,15 @@ theme:
3030
plugins:
3131
- search
3232
nav:
33+
- index.md
3334
- Installation: installation.md
3435
- Bot Development: bot-development.md
3536
- API Protocol: api-protocol.md
3637
- Troubleshooting: troubleshooting.md
3738
markdown_extensions:
39+
- attr_list
40+
- md_in_html
41+
- pymdownx.blocks.caption
3842
- admonition
3943
- pymdownx.details
4044
- pymdownx.highlight:
@@ -50,3 +54,6 @@ markdown_extensions:
5054
format: !!python/name:pymdownx.superfences.fence_code_format
5155
- pymdownx.tabbed:
5256
alternate_style: true
57+
- pymdownx.emoji:
58+
emoji_index: !!python/name:material.extensions.emoji.twemoji
59+
emoji_generator: !!python/name:material.extensions.emoji.to_svg

0 commit comments

Comments
 (0)