Metadata-Version: 2.4
Name: faraway-realms
Version: 0.15.0
Summary: A real-time tick-based roguelike RPG built with tcod.
Author: Roel
Keywords: roguelike,rpg,tcod,game
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: End Users/Desktop
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.14
Requires-Python: >=3.14
Description-Content-Type: text/markdown
Requires-Dist: msgpack>=1.2.1
Requires-Dist: pyyaml>=6.0.3
Requires-Dist: tcod>=21.0
Requires-Dist: types-pyyaml>=6.0.12.20260408
Provides-Extra: dev
Requires-Dist: mypy; extra == "dev"
Requires-Dist: pre-commit; extra == "dev"
Requires-Dist: pylint; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: pytest-env; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Provides-Extra: toolkit
Requires-Dist: dearpygui>=2.3; extra == "toolkit"

# Faraway Realms

A real-time tick-based roguelike RPG built with [tcod](https://python-tcod.readthedocs.io/).

## Install & run

### Windows (no Python required)

```powershell
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
```

Restart your terminal, then:

```powershell
uv tool install faraway-realms
faraway-realms
```

### macOS / Linux

```bash
curl -LsSf https://astral.sh/uv/install.sh | sh
uv tool install faraway-realms
faraway-realms
```

## Make your own content

The **Faraway Toolkit** is a companion app for dungeon masters: build tiles, objects,
room types and maps with a live, game-accurate preview, then share them as a content pack.

```bash
uv tool install "faraway-realms[toolkit]"
faraway-toolkit --pack my-pack
```

See the [Creating Content guide](docs/creating_content.md) for a walkthrough.

## Multiplayer

```bash
# Server (headless)
faraway-realms --serve 0.0.0.0:9999 --headless

# Client on another machine
faraway-realms --connect HOST:9999
```
