Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .claude/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
},
{
"type": "command",
"command": "mdformat --number docs/index.md docs/installation.md docs/developing-bots.md docs/balatrobot-api.md docs/protocol-api.md docs/troubleshooting.md"
"command": "mdformat --number docs/index.md docs/installation.md docs/developing-bots.md docs/balatrobot-api.md docs/protocol-api.md"
}
]
}
Expand Down
1 change: 0 additions & 1 deletion docs/developing-bots.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,4 +145,3 @@ After setting up your development environment:

- Explore the [BalatroBot API](balatrobot-api.md) for detailed client and model documentation
- Learn about the underlying [Protocol API](protocol-api.md) for TCP communication details
- Check the [Troubleshooting](troubleshooting.md) guide if you encounter issues
14 changes: 8 additions & 6 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,22 +27,24 @@ BalatroBot is a Python framework designed to help developers create automated bo

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

- :material-api:{ .lg .middle } __API Protocol__
- :material-api:{ .lg .middle } __Protocol API__

---

Technical reference for TCP socket communication, message formats,
game states, action types.

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

- :material-help-circle:{ .lg .middle } __Troubleshooting__

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

---

Common issues and debugging solutions for developing bots
and game integration problems (WIP).
Documentation in [llms.txt](https://llmstxt.org/) formats, easily digestible by LLMs.

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

[:octicons-arrow-right-24: Troubleshooting](troubleshooting.md)
[:octicons-arrow-right-24: llms-full.txt](llms-full.txt)

</div>
1 change: 0 additions & 1 deletion docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -256,7 +256,6 @@ If you encounter issues during installation or testing:

- **Discord Support**: Join our community at [https://discord.gg/xzBAj4JFVC](https://discord.gg/xzBAj4JFVC) for real-time help
- **GitHub Issues**: Report bugs or request features by [opening an issue](https://github.com/S1M0N38/balatrobot/issues) on GitHub
- **Documentation**: Check the [Troubleshooting](troubleshooting.md) page (work in progress)

---

Expand Down
1 change: 0 additions & 1 deletion docs/protocol-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,4 +162,3 @@ For higher-level integration:

- Use the [BalatroBot API](balatrobot-api.md) `BalatroClient` for managed connections
- See [Developing Bots](developing-bots.md) for complete bot implementation examples
- Check [Troubleshooting](troubleshooting.md) for common protocol issues
3 changes: 0 additions & 3 deletions docs/troubleshooting.md

This file was deleted.

16 changes: 15 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,21 @@ extra:
generator: false
plugins:
- search
- llmstxt:
markdown_description: |
BalatroBot is a Python framework for developing automated bots to play the card game Balatro.
The architecture consists of three main layers: a communication layer using TCP protocol with Lua API,
a Python framework layer for bot development, and comprehensive testing and documentation systems.
The project enables real-time bidirectional communication between the game and bot through TCP sockets.
sections:
Documentation:
- index.md
- installation.md
- developing-bots.md
- balatrobot-api.md
- protocol-api.md
full_output: llms-full.txt
autoclean: false
- mkdocstrings:
handlers:
python:
Expand All @@ -47,7 +62,6 @@ nav:
- Developing Bots: developing-bots.md
- BalatroBot API: balatrobot-api.md
- Protocol API: protocol-api.md
- Troubleshooting: troubleshooting.md
markdown_extensions:
- toc:
toc_depth: 3
Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ dev = [
"basedpyright>=1.29.5",
"mdformat-mkdocs>=4.3.0",
"mdformat-simple-breaks>=0.0.1",
"mkdocs-llmstxt>=0.3.0",
"mkdocs-material>=9.6.15",
"mkdocstrings[python]>=0.29.1",
"pytest>=8.4.1",
Expand Down
642 changes: 347 additions & 295 deletions uv.lock

Large diffs are not rendered by default.