Metadata-Version: 2.4
Name: ttrpg-control-desk
Version: 0.1.0
Summary: Dual-screen display tool for tabletop RPG game masters with fog of war, character portraits, and pointer
Project-URL: Homepage, https://github.com/mesfoliesludiques/ttrpg-control-desk
Project-URL: Repository, https://github.com/mesfoliesludiques/ttrpg-control-desk
Project-URL: Issues, https://github.com/mesfoliesludiques/ttrpg-control-desk/issues
Author-email: Emmanuel Ruaud <em.ruaud@gmail.com>
License: MIT
License-File: LICENSE
Keywords: battlemap,display,dnd,fog-of-war,gamemaster,gm-tools,pathfinder,rpg,tabletop,ttrpg
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: MacOS X :: Cocoa
Classifier: Environment :: Win32 (MS Windows)
Classifier: Environment :: X11 Applications :: Qt
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Games/Entertainment :: Role-Playing
Classifier: Topic :: Multimedia :: Graphics :: Viewers
Requires-Python: >=3.9
Requires-Dist: pyqt5>=5.15
Description-Content-Type: text/markdown

# TTRPG Control Desk

A desktop application for tabletop RPG game masters to display backgrounds, character portraits, and fog of war to players on an external screen.

## Features

- **Dual-window system** - Control panel for GM, separate display for players
- **Background images** - Select and display scene backgrounds
- **Character portraits** - Multi-select characters, displayed at bottom of screen
- **Fog of war** - Paint to reveal areas, per-image fog masks
- **Zoom and pan** - Navigate large images with mouse
- **Pointer** - Hold P to show pointer on player display, move mouse to position
- **Fast loading** - Async loading, thumbnail caching, image preloading

## Installation

Requires Python 3 and PyQt5:

```bash
pip install PyQt5
```

## Usage

```bash
python3 main.py                      # Start empty, select folders manually
python3 main.py /path/to/project     # Auto-detect subfolders
```

When providing a project path, the app looks for:
- `Backgrounds/` or `Fonds/` - Background images
- `Characters/` or `Personnages/` - Character portraits

## Controls

### Keyboard
- **Esc** - Quit
- **F** - Toggle fullscreen
- **P** (hold) - Show pointer on player display
- **Left/Right** - Previous/next background

### Mouse (on preview)
- **Left click + drag** - Paint fog (reveal areas)
- **Right click + drag** - Pan when zoomed
- **Zoom slider** - Zoom in/out

### Docks
- **Backgrounds** - Click to select, folder button to change directory
- **Characters** - Click to toggle selection (multi-select), size slider adjusts portrait size
- **Fog of War** - Enable/disable fog, brush size, clear/fill buttons

## Supported Formats

PNG, JPG, JPEG, BMP, GIF, WebP

## License

MIT
