Skip to content

Commit 249ec7e

Browse files
committed
docs: remove table of contents from md files
1 parent 74a6816 commit 249ec7e

15 files changed

+0
-154
lines changed

docs/README.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,6 @@
22

33
Welcome to the comprehensive documentation for **Balatrobot** - A powerful botting API for the game Balatro.
44

5-
## 📋 Table of Contents
6-
7-
- [Overview](#overview)
8-
- [Quick Start](#quick-start)
9-
- [Documentation Sections](#documentation-sections)
10-
- [Requirements](#requirements)
11-
- [Support](#support)
12-
135
## Overview
146

157
Balatrobot is a sophisticated modding framework that provides a complete API for creating automated bots for the card game Balatro. It consists of both Lua components (that run within the game) and Python components (for bot logic implementation).

docs/actions.md

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,6 @@
22

33
Complete reference for all available actions in Balatrobot.
44

5-
## 📋 Table of Contents
6-
7-
- [Overview](#overview)
8-
- [Action Format](#action-format)
9-
- [Blind Actions](#blind-actions)
10-
- [Hand Actions](#hand-actions)
11-
- [Shop Actions](#shop-actions)
12-
- [Joker Actions](#joker-actions)
13-
- [Consumable Actions](#consumable-actions)
14-
- [Booster Actions](#booster-actions)
15-
- [Arrangement Actions](#arrangement-actions)
16-
- [Examples](#examples)
17-
185
## Overview
196

207
Actions in Balatrobot are represented as lists that tell the game what to do. Each action follows a specific format and is returned from bot methods to control game behavior.

docs/architecture.md

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,6 @@
22

33
This document explains the architecture and design of the Balatrobot system, including how components interact and communicate.
44

5-
## 📋 Table of Contents
6-
7-
- [System Overview](#system-overview)
8-
- [Component Architecture](#component-architecture)
9-
- [Communication Flow](#communication-flow)
10-
- [Game State Management](#game-state-management)
11-
- [Action Processing](#action-processing)
12-
- [Performance Optimizations](#performance-optimizations)
13-
145
## System Overview
156

167
Balatrobot consists of two main components working together:

docs/best-practices.md

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,6 @@
22

33
Guidelines and best practices for developing effective Balatrobot bots.
44

5-
## 📋 Table of Contents
6-
7-
- [General Principles](#general-principles)
8-
- [Code Organization](#code-organization)
9-
- [Decision Making](#decision-making)
10-
- [Performance](#performance)
11-
- [Debugging](#debugging)
12-
- [Testing](#testing)
13-
- [Common Patterns](#common-patterns)
14-
- [Pitfalls to Avoid](#pitfalls-to-avoid)
15-
165
## General Principles
176

187
### 1. Keep It Simple

docs/bot-development.md

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,6 @@
22

33
This guide teaches you how to create custom bots for Balatro using the Balatrobot framework.
44

5-
## 📋 Table of Contents
6-
7-
- [Bot Development Basics](#bot-development-basics)
8-
- [Creating Your First Bot](#creating-your-first-bot)
9-
- [Understanding Game States](#understanding-game-states)
10-
- [Implementing Bot Methods](#implementing-bot-methods)
11-
- [Action Reference](#action-reference)
12-
- [Advanced Techniques](#advanced-techniques)
13-
- [Testing and Debugging](#testing-and-debugging)
14-
155
## Bot Development Basics
166

177
### Bot Architecture

docs/configuration.md

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,6 @@
22

33
Complete guide to configuring Balatrobot for optimal performance and functionality.
44

5-
## 📋 Table of Contents
6-
7-
- [Configuration File Overview](#configuration-file-overview)
8-
- [Core Settings](#core-settings)
9-
- [Performance Optimization](#performance-optimization)
10-
- [Visual Settings](#visual-settings)
11-
- [Network Configuration](#network-configuration)
12-
- [Bot-Specific Settings](#bot-specific-settings)
13-
- [Configuration Examples](#configuration-examples)
14-
155
## Configuration File Overview
166

177
The main configuration is stored in `config.lua` in the mod directory. This file controls all aspects of the Balatrobot mod behavior.

docs/examples.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,6 @@
22

33
This document provides detailed walkthroughs of the example bots included with Balatrobot, showing different strategies and implementation patterns.
44

5-
## 📋 Table of Contents
6-
7-
- [Basic Example Bot](#basic-example-bot)
8-
- [Flush Bot](#flush-bot)
9-
- [Strategy Patterns](#strategy-patterns)
10-
- [Custom Bot Examples](#custom-bot-examples)
11-
- [Performance Considerations](#performance-considerations)
12-
135
## Basic Example Bot
146

157
The `bot_example.py` demonstrates fundamental bot structure and simple decision-making logic.

docs/game-state.md

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,6 @@
22

33
Complete reference for understanding the game state object provided to bot methods.
44

5-
## 📋 Table of Contents
6-
7-
- [Overview](#overview)
8-
- [Game State Structure](#game-state-structure)
9-
- [Hand Information](#hand-information)
10-
- [Jokers](#jokers)
11-
- [Shop](#shop)
12-
- [Blinds](#blinds)
13-
- [Consumables](#consumables)
14-
- [Examples](#examples)
15-
165
## Overview
176

187
The game state object (`G`) is a comprehensive dictionary containing all information about the current state of the Balatro game. This object is passed to all bot methods and provides access to:

docs/installation.md

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,6 @@
22

33
This guide will walk you through installing and setting up Balatrobot for automated Balatro gameplay.
44

5-
## 📋 Table of Contents
6-
7-
- [Prerequisites](#prerequisites)
8-
- [Step 1: Install Steamodded](#step-1-install-steamodded)
9-
- [Step 2: Install Balatrobot Mod](#step-2-install-balatrobot-mod)
10-
- [Step 3: Configure Balatrobot](#step-3-configure-balatrobot)
11-
- [Step 4: Set Up Python Environment](#step-4-set-up-python-environment)
12-
- [Step 5: Test Installation](#step-5-test-installation)
13-
- [Troubleshooting](#troubleshooting)
14-
155
## Prerequisites
166

177
Before installing Balatrobot, ensure you have:

docs/logging-replay.md

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,6 @@
22

33
Complete guide to logging bot actions and replaying games for analysis and debugging.
44

5-
## 📋 Table of Contents
6-
7-
- [Overview](#overview)
8-
- [Action Logging](#action-logging)
9-
- [Game State Logging](#game-state-logging)
10-
- [Log Formats](#log-formats)
11-
- [Replay System](#replay-system)
12-
- [Analysis Tools](#analysis-tools)
13-
- [Performance Monitoring](#performance-monitoring)
14-
- [Debugging with Logs](#debugging-with-logs)
15-
- [Best Practices](#best-practices)
16-
175
## Overview
186

197
The logging and replay system in Balatrobot provides comprehensive tracking of:

0 commit comments

Comments
 (0)