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 horizontally 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.

Capture

Features

  • Works on Linux, macOS and Windows by using Python.
  • 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 a 1 inch grid.
  • Save settings so images load like you had them last time.
  • Simple initiative tracker

Installation

  • Open terminal or cmd.
  • Check that you have Python installed by running the python --version command.
  • Install Battle Map TV with this command: python -m pip install battle-map-tv
  • Then run it with: python -m battle_map_tv

Manual

  • Drag the TV window to your TV and make it fullscreen with the 'fullscreen' button.
  • Ue the 'add' button to load an image.
  • You can drag the image to pan. Zoom with your mouse scroll wheel or use the slider in the controls window.
  • Close the application with the 'exit' button.

Set screen size

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

Initiative tracker

In the controls window, you can add players and their initiative. The list will be sorted automatically. Just put a number and a name on each line.

The '+' and '-' buttons increase and decrease the font size.

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.3.0.tar.gz (24.7 kB view details)

Uploaded Source

Built Distribution

battle_map_tv-0.3.0-py3-none-any.whl (27.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: battle_map_tv-0.3.0.tar.gz
  • Upload date:
  • Size: 24.7 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.3.0.tar.gz
Algorithm Hash digest
SHA256 d30e65e79b85098369f9f8a864c657df1ca2b44f9213814e22b9b69c985c6641
MD5 3c7953244695f5adfb34b4be27839aa3
BLAKE2b-256 9b16e9461624d98c0be50cb2c07123202eaf8fea234fb37762773208ac7ba761

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for battle_map_tv-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d33423eacf3dc3a2d672134f2a0104e8719157690a1447e9c9d8ec36982b73ba
MD5 04985b43c07691bb9aedb7973499980f
BLAKE2b-256 a4f5c8e296455c7039c0bdb6ad96640677d16be44b95ce323f9df96853162c93

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