Metadata-Version: 2.4
Name: timberbot
Version: 0.9.0
Summary: Python client and `tbot` CLI for the Timberbot Timberborn HTTP API
Project-URL: Homepage, https://github.com/impuls42/timberbot
Project-URL: Issues, https://github.com/impuls42/timberbot/issues
Author: Timberbot contributors
License: MIT
Keywords: ai-agent,modding,timberborn,timberbot
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Games/Entertainment
Requires-Python: >=3.10
Requires-Dist: pydantic>=2.6
Requires-Dist: requests>=2.33.1
Requires-Dist: toons>=0.5.4
Provides-Extra: dev
Requires-Dist: mypy>=1.8; extra == 'dev'
Requires-Dist: openapi-spec-validator>=0.7; extra == 'dev'
Requires-Dist: pytest-httpserver>=1.0; extra == 'dev'
Requires-Dist: pytest>=8; extra == 'dev'
Requires-Dist: pyyaml>=6.0; extra == 'dev'
Requires-Dist: ruff>=0.5; extra == 'dev'
Requires-Dist: typing-extensions>=4.5; extra == 'dev'
Description-Content-Type: text/markdown

timberbot
=========

Python client and `tbot` CLI for the
[Timberbot](https://github.com/impuls42/timberbot) Timberborn mod HTTP API.
Talks to the C# mod running inside the game on `localhost:8085`.

Install
-------

```
pipx install timberbot
```

Or from source:

```
pip install -e python/
```

Use
---

```
tbot summary
tbot buildings
tbot place_building prefab:Path x:120 y:130 z:2 orientation:south
tbot top
tbot --help
```

The `tbot` command is the entry point for everything. Run with no args to list
all commands; run with `--help` for global flags.

Layout
------

- `timberbot.api.client.TimberbotClient` — pure HTTP client, one method per endpoint.
- `timberbot.state.SettlementContext` — per-settlement persistent memory (`brain.toon`).
- `timberbot.formatters` — colors, tables, ASCII map, live dashboard renderer.
- `timberbot.cli` — argv parsing, command registry, main entry point.

The `from timberbot import Timberbot` alias re-exports `TimberbotClient`.
