Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ironmonk88 authored Oct 17, 2022
1 parent 7be353d commit 94a5413
Showing 1 changed file with 25 additions and 10 deletions.
35 changes: 25 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,48 @@
# Monk's Common Display
Add-On Module for Foundry VTT
Set up a display without all the ui so that it can be displayed on an alternate screen.

This module is used to display a common display for all players to view, such as a tv that your in person session can all view.
You do this by setting a player to be the common display and have them log into the account that is being displayed on that tv.
A handy control window allows you to specify how the screen is moved and what token to focus on.

## Installation
Simply use the install module screen within the FoundryVTT setup

## Usage & Current Features
Using the common display toolbar, you can change settings, clear any open images on the display screen, or toggle the display screen mirroring your actions.
You can set the common display player by either selecting the player in the settings window.

![monks-common-display](/screenshots/players.png)

![monks-common-display](/screenshots/toolbar1.png)
![monks-common-display](/screenshots/toolbar2.png)
Or by right clicking on the player in the players list and selecting `Set as Common Display`

Changing the settings will let you select which player is to be used as your display player. You can also set if the player is capable of mirroring the GM's screen. So when screen mirroring is turned on, it will only affect displays that allow it. You can also clear images for individuals using this window.
![monks-common-display](/screenshots/player-list.png)

![monks-common-display](/screenshots/players.png)
A player that is set to be common display will have a screen icon beside their name.

Pressing the clear images tool bar button will clear any open images for display players.
When you have a player selected as the common display, their ui will disappear, leaving just the viewing canvas. You can specify which parts of the screen you want to remain in the settings, in case you want to show the chat log, or the combat tracker.

Toggling the Mirror Screen button will allow your position and scale to be mirrored on the common display. This can be toggled off so that you can move the screen somewhere else. The M key is also set as the hotkey for toggling that setting. This can be changed in settings.
Using the common display toolbar you can clear any journal entries or images that have been shared.
As well, as in the settings you can have shared images clear after a certain amount of time.
You can toggle the toolbar being on the screen by clicking on the icon on the regular toolbar.

You can also configure if you want the side menu to show with the chat log. Or if you want the combat to be displayed. If combat is displayed, it will be automatically closed when the combat has ended.
![monks-common-display](/screenshots/toolbar.png)

You can also set what the screen on the common display will mirror or what token will be focussed, by right clicking the icon and selecting from the context menu.
And can toggle the feature on or off by clicking on the icon.

![monks-common-display](/screenshots/toolbar-menu.png)

## Bug Reporting
I'm sure there are lots of issues with it. It's very much a work in progress.
Please feel free to contact me on discord if you have any questions or concerns. ironmonk88#4075

## Support

If you feel like being generous, stop by my <a href="https://www.patreon.com/ironmonk">patreon</a>. Not necessary but definitely appreciated.
If you feel like being generous, stop by my <a href="https://www.patreon.com/ironmonk">patreon</a>.

Or [![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/R6R7BH5MT)

Not necessary but definitely appreciated.

## License
This Foundry VTT module, writen by Ironmonk, is licensed under [GNU GPLv3.0](https://www.gnu.org/licenses/gpl-3.0.en.html), supplemented by [Commons Clause](https://commonsclause.com/).
Expand Down

0 comments on commit 94a5413

Please sign in to comment.