Skip to main content

Display battle maps for TTRPGs on a secondary tv

Project description

PyPI - Version Tests Mypy Ruff

Battle Map TV

Display battle maps for TTRPGs on a tv that lies flat horizontal on your table.

This Python application aims to do one thing: quickly show an image on your secondary screen, in the right size and with a 1-inch grid.

For GM's with little time or who improvise their sessions: much easier to use in-session than a full blown VTT.

screenshot

Features

  • Works natively on Linux, macOS and Windows.
  • Doesn't use a browser.
  • Free and open source
  • Works offline
  • Simple UI
  • Two windows:
    • one on the TV with your map and grid on it
    • one on your GM laptop with controls
  • Import local image files to display on the tv.
  • Scale, pan and rotate the image.
  • Store the physical size of your screen to enable grid and autoscaling.
  • Overlay a 1-inch grid.
  • Automatically detect the grid in an image and scale to 1 inch.
  • Save settings so images load like you had them last time.

Quickstart

This assumes you have Python installed. Probably you also want to create a virtual environment.

python -m pip install battle-map-tv
python -m battle_map_tv

Drag the TV window to your TV and make it fullscreen with the 'fullscreen' button.

Then use the 'add' button to load an image.

There are two text boxes to enter the dimensions of your secondary screen in milimeters. This is needed to display a grid overlay and autoscale the image to 1 inch.

You can drag the image to pan and zoom with your mouse scroll wheel, or use the slider in the GM window.

Close the application with the 'exit' button.

Technical

  • Uses PySide6 for the graphical user interface.
  • Uses OpenCV to detect the grid on battle maps.
  • Uses Hatch to build and release the package.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

battle_map_tv-0.2.0.tar.gz (22.8 kB view details)

Uploaded Source

Built Distribution

battle_map_tv-0.2.0-py3-none-any.whl (25.3 kB view details)

Uploaded Python 3

File details

Details for the file battle_map_tv-0.2.0.tar.gz.

File metadata

  • Download URL: battle_map_tv-0.2.0.tar.gz
  • Upload date:
  • Size: 22.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.8

File hashes

Hashes for battle_map_tv-0.2.0.tar.gz
Algorithm Hash digest
SHA256 dfae3223ac56eb0b7155f5aa5c803fff5a1420dbaf5b759f6ad33306a9f4675d
MD5 4be0a1087a7a0bf7ebb15678737508d0
BLAKE2b-256 e361624e81f52bbbe6c57b64f59ed31344d633de589ed89a17f033e5dec8d5b8

See more details on using hashes here.

File details

Details for the file battle_map_tv-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for battle_map_tv-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1173a4fb01b38030ae0deab343fbd0ef256b9459260d38bd67147b094b87497b
MD5 b8d47cb8047dbf72247bbc30db68eb5c
BLAKE2b-256 3a081c44bc7d72b2b73a68e5bb8e906a6a7dc0149c4b969c906eeb978eb4c09b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page