Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Conengmo committed Mar 1, 2024
1 parent 46fb1f2 commit 9419883
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ For GM's with little time or who improvise their sessions: much easier to use in

![screenshot](https://github.com/Conengmo/battle-map-tv/assets/33519926/fe79eca8-0dfb-4986-99cd-a747a7603604)


## Features
- Works natively on Linux, macOS and Windows.
- Works on Linux, macOS and Windows by using Python.
- Doesn't use a browser.
- Free and open source
- Works offline
Expand All @@ -30,6 +30,7 @@ For GM's with little time or who improvise their sessions: much easier to use in
- 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
Expand All @@ -48,9 +49,18 @@ For GM's with little time or who improvise their sessions: much easier to use in
- 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

Expand Down

0 comments on commit 9419883

Please # to comment.