Skip to content

Commit 42cbde3

Browse files
committed
docs: remove legacy content in the README
1 parent 2947b32 commit 42cbde3

File tree

1 file changed

+0
-92
lines changed

1 file changed

+0
-92
lines changed

README.md

Lines changed: 0 additions & 92 deletions
Original file line numberDiff line numberDiff line change
@@ -4,95 +4,3 @@
44
</div>
55

66
---
7-
8-
9-
## Features
10-
11-
- 🎮 **Game State Access** - Full access to Balatro's game state and mechanics
12-
- 🐍 **Python API** - Write bots in Python with a clean, intuitive interface
13-
- 🌙 **Lua Integration** - Direct Lua scripting support for advanced users
14-
- 🔌 **Middleware System** - Extensible middleware for custom bot behaviors
15-
- 📊 **Logging & Debugging** - Comprehensive logging system for bot development
16-
- 🚀 **Easy Setup** - Simple installation and configuration process
17-
18-
## Quick Start
19-
20-
### Installation
21-
22-
1. Clone the repository:
23-
```bash
24-
git clone https://github.com/your-username/balatrobot.git
25-
cd balatrobot
26-
```
27-
28-
2. Install Python dependencies:
29-
```bash
30-
pip install -r requirements.txt
31-
```
32-
33-
3. Configure the bot (see [Configuration Guide](docs/configuration.md))
34-
35-
### Basic Usage
36-
37-
**Python Bot Example:**
38-
```python
39-
from bot import BalatroBot
40-
41-
bot = BalatroBot()
42-
43-
@bot.on_turn_start
44-
def handle_turn_start(game_state):
45-
# Your bot logic here
46-
pass
47-
48-
bot.run()
49-
```
50-
51-
**Lua Bot Example:**
52-
```lua
53-
local bot = require('src.bot')
54-
55-
bot.on_turn_start(function(game_state)
56-
-- Your bot logic here
57-
end)
58-
```
59-
60-
## Documentation
61-
62-
- 📖 [Full Documentation](https://your-username.github.io/balatrobot/)
63-
- 🛠️ [Installation Guide](docs/installation.md)
64-
- ⚙️ [Configuration](docs/configuration.md)
65-
- 🏗️ [Architecture Overview](docs/architecture.md)
66-
- 🤖 [Bot Development Guide](docs/bot-development.md)
67-
- 🐍 [Python API Reference](docs/python-api.md)
68-
- 💡 [Examples](docs/examples.md)
69-
- 🔧 [Troubleshooting](docs/troubleshooting.md)
70-
71-
## Project Structure
72-
73-
```
74-
balatrobot/
75-
├── src/ # Lua source code
76-
├── docs/ # Documentation
77-
├── lib/ # External Lua libraries
78-
├── bot.py # Python API
79-
├── main.lua # Main entry point
80-
└── config.lua # Configuration
81-
```
82-
83-
## Contributing
84-
85-
Contributions are welcome! Please read our contributing guidelines and submit pull requests for any improvements.
86-
87-
## License
88-
89-
This project is licensed under the MIT License - see the LICENSE file for details.
90-
91-
## Support
92-
93-
If you encounter any issues or have questions:
94-
95-
- Check the [Troubleshooting Guide](docs/troubleshooting.md)
96-
- Open an issue on GitHub
97-
- Join our community discussions
98-

0 commit comments

Comments
 (0)