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.

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 a 1 inch grid.
  • Save settings so images load like you had them last time.

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.

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.

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

Uploaded Source

Built Distribution

battle_map_tv-0.2.2-py3-none-any.whl (25.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: battle_map_tv-0.2.2.tar.gz
  • Upload date:
  • Size: 23.0 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.2.tar.gz
Algorithm Hash digest
SHA256 a41e8f7410d2ef78b8a4b7426d6a24f1d80c50ddf24a392760083cde4f720457
MD5 36072c51cb653936f260aa0822b40522
BLAKE2b-256 0946283f20bbbb4695cc64314673f48551c3872ac60c836b4950e8b791bd5470

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for battle_map_tv-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 f444a4ec2d88f34fba04db88a7b99dd5b78f666bf6fd1a5b2a00da47a771bf96
MD5 1bf5d4181e1e41243a90373f6b87f121
BLAKE2b-256 a66a90aa395b5a4a19843eee30ea4f15b4816ce6fef4cccfd9d05123b2c4f699

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