Skip to content

Commit 405595e

Browse files
authored
Update README.md
1 parent 7ec6296 commit 405595e

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

README.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@
55

66
# Battle Map TV
77

8-
Display battle maps for TTRPGs on a tv that lies flat horizontally on your table.
8+
Display battle maps for TTRPGs on a tv or monitor that lies flat horizontally on your table.
99

10-
This Python application aims to do one thing: quickly show an image on your secondary screen,
11-
in the right size and with a 1-inch grid.
10+
No more features than needed: just show an image the way you want. Optionally add a grid, initiative order and area of effect shapes.
1211

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

15-
![Capture](https://github.com/Conengmo/battle-map-tv/assets/33519926/55b1d72f-3621-49a7-afb1-0d70e542d0c3)
14+
![Screenshot](https://github.com/Conengmo/battle-map-tv/assets/33519926/56395c6e-f12a-44e5-93a5-24badca97103)
15+
1616

1717

1818
## Features
@@ -31,6 +31,7 @@ For GM's with little time or who improvise their sessions: much easier to use in
3131
- Automatically detect the grid in an image and scale to a 1 inch grid.
3232
- Save settings so images load like you had them last time.
3333
- Simple initiative tracker
34+
- Overlay area of effects
3435

3536

3637
## Installation
@@ -45,7 +46,7 @@ For GM's with little time or who improvise their sessions: much easier to use in
4546
## Manual
4647

4748
- Drag the TV window to your TV and make it fullscreen with the 'fullscreen' button.
48-
- Ue the 'add' button to load an image.
49+
- Use the 'add' button to load an image.
4950
- You can drag the image to pan. Zoom with your mouse scroll wheel or use the slider in the controls window.
5051
- Close the application with the 'exit' button.
5152

@@ -61,6 +62,15 @@ Just put a number and a name on each line.
6162

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

65+
## Area of effect
66+
67+
Click on one of the buttons for a shape like 'circle' or 'square'. Then click and drag anywhere in the TV window
68+
to create the shape in the size you want.
69+
70+
The default color for shapes is white, but you can also toggle another color with the color buttons.
71+
72+
You can delete a shape by right-clicking on it, or by using the 'Clear' button.
73+
6474

6575
## Technical
6676

0 commit comments

Comments
 (0)