ItharDev/RPG-Viewer-Client

Official client-side application for RPG Viewer VTT

RPG Viewer VTT

Official cliend-side application for RPG Viewer VTT

By reading this guide, you will understand everything you need to know about this application and its features

Disclaimer

This guide is highly outdated, and will be updated in the next major update.

Table of contents

• Installation
• User guide
  • Connecting
  • Accounts
  • Sessions
  • Game view
    • Side buttons
    • Side panel
  • Journal pages
  • Scenes
    • Creation & modification
    • Tokens
    • Lights
    • Notes
  • Blueprints
    • Permissions
      • Owner
      • Observer
      • None
• Keyboard shortcuts

Installation

You can find the latest release on the right hand panel

1. Download RPG-Viewer.zip

2. Extract all of the zip file's contents

3. Run the applicaton by starting RPG Viewer.exe

   Windows may ask for permission to operate on private networks. Please accept this to allow the application to work normally

4. See user guide below

User guide

Connecting

• When the application is started, an IP Address must be specified to which the application will try to connect

• This can be done from the top right corner of the main menu

• Syntax: <IP Address>:<Port> For example: 127.0.0.1:3000 will connect to localhost, on port 3000

• Once connected for the first time, the application will automatically connect to this IP address when opened.

• • The IP address can be changed at any time by entering a new address in the top right hand corner of the main menu using the syntax above.

Accounts

Account data is synchronised across all devices, including

• Sessions
• Blueprints
• Scenes
• Notes

Sessions

• There is no limit to the number of sessions you can create.
• Landing page will be visible if there are no Scenes loaded or the session is not synced with players (more on this later).
• Click the button next to the Join panel drop down menu to copy the session ID to your clipboard.
• Invite someone to this session by giving them this ID
• Accept invitations by pasting a key you have received into the right hand panel
• You can remove your access to any session you have been invited to by clicking the 'Remove Licences' button.

Game view

• When you first join, you should see your landing page as the background.
• As a player, you won't be able to see the side panel on the right. It is only visible to Game Masters.

Side buttons

All buttons are only visible when a Scene is active.

• Pan Tool

  • Quick select this Tool by pressing 1 on your keyboard
  • Left-click to move the camera

• Measure Tool

  • Quick select this Tool by pressing 3 on your keyboard
  • Precise. Measures every foot
  • Cell-based. Snaps measurement points to cells in a grid. Distances are calculated using D&D 5e's optional movement. Each cell counts as 5 feet, and every other diagonal counts as 10 feet.
  • Right-click while measuring to add waypoints
  • Quick select this Tool by pressing 2 on your keyboard

• Ping Tool

  • The markers remain on the map for 10 seconds
  • Left-click and hold to move each players' camera to that location

• Note Tools

  • Quick select this Tool by pressing 4 on your keyboard
  • Add Notes by clicking left-clicking
  • See Notes

• Fog Tool (Game Master only)

  • Quick select this Tool by pressing 5 on your keyboard
  • Player view. Clicking on a Token with this enabled will simulate that player's view of the game.
  • Vision only. Clicking a Token with this enabled will show what that player can see. Everything else is shown opaque
  • No Fog. This will remove all Fog and allow you to see the entire map and Tokens.

• Light Tool (Game Master only)

  • Quick select this Tool by pressing 6 on your keyboard
  • Left-clicking on a map will add a light source on that location
  • More on lights can be found here

• Sync (Game master only)

  • Sync session to players
  • While locked, players will only see the landing page.
  • While syncing, players will see the active Scene if there is one.

• Centre camera

  • Move camera back to centre and reset zoom

• Leave session

  • Leave session and return to main menu
  • Clicking this as a Game Master will set the sync state to locked, so that players will only see the landing page.

Side panel

• Create and modify Scenes and Blueprints (Game Master only)
• Create and modify Journal pages. More information here
• Scene configuration can be seen here
• Creating and managing Blueprints can be seen here

Journal pages

• Create a new Journal pages from the right panel.
• Right-clicking on a Journal page in the right panel allows you to delete, modify, or share it with others
• Journal pages shared with you are located in the Shared folder
• You can drag Journal pages and folders from one folder to another
• Rename folders by double clicking them

Scenes

• Create and modify Scenes by opening the tab on the right.
• Scene configuration can be seen here
• While modifying or creating a Scene, players will not be able to affect the current Scene and will only see the landing page.

Creating and modifying scenes

• Wall Tools

  • Restrict players' vision and lighting. Create toggleable doors that can be hidden from players.
  • Regular walls. Block player movement, light and vision
  • Doors. Works like normal walls. Can be turned on and off (door icons visible to players)
  • Hidden doors. Works like a normal door, but the door-icons are not visible to players
  • Invisible walls. Blocks player movement, but not light or vision
  • Click and drag to create walls
  • Hold Ctrl and drag from wall endpoint to continue wall
  • Click on a wall endpoint to select it. Press Backspace or Delete to delete that wall point.
  • Snap wall endpoints together by dragging one endpoint over another

• Grid configuration

  • Configure the grid for this Scene. Activate grid snap and measure Tools

  • Configure grid settings

    

    • Enable grid: Enables / disables the grid for this Scene

    • Snap to grid: Snaps Tokens to grid cells. Does nothing if grid is off.

    • Grid dimensions: Grid size. Default size when creating the Scene is 10x10.

    • Grid colour: Opens a colour picker where you can choose the colour for your grid.

      There is currently a known bug where you have to click this button at least twice to update the colour of the colour picker.

    • Grid opacity Opacity of the grid. Set to 0 to hide the grid

    • To save changes, click Save

    • To discard changes, click Close

  • Enable & disable grid visibility. Applies to Modification View only

  • Scale grid by dragging one of its corners. Move grid around using Arrow keys or W A S D

• Fog configuration

  • Restrict players' view. Add dynamic lighting and shadows to the Scene

  

  • Enable Fog of War: Enables / disables Fog of War for this Scene.

  • Global lighting: Light up the entire Scene. Lights have no effect when this is enabled.

  • Translucency: Change global lighting translucency.

  • Fog colour: Opens a colour picker where you can choose the colour for your Fog.

    There is currently a known bug where you have to click this button at least twice to update the colour in the colour picker.

  • To save changes, click the Save button.

  • To discard changes, click Close

• Night Filter

  • Apply the Night filter to this Scene to create the illusion of night lighting.

  

• Night effect strength controls how much of the night filter is applied. 0 is no effect and 100 is the maximum effect.

• Rename Scene from the top left corner

• Save and exit

Tokens

While you are the owner of the Token, you can do the following

• Switch between the Tokens you own by clicking Tab.

• Move Tokens using the left mouse button (with the Pan Tool enabled)

• Click on a Token to select it

  • Press Delete or Backspace to delete the Token
  • Move the Token with the arrow keys

• Movement is blocked by walls (normal walls, doors, hidden doors, invisible walls)

• As the Game Master, you can move the Token through walls. You will be notified if you collide with a wall.

• When dragging, right-click to add a waypoint.

  Releasing the left mouse button will move the Token along its waypoints.

  If snap to grid is enabled. The Token will snap to the nearest cell. To prevent this, press Alt while releasing the left mouse button.

• Move distance and path is displayed when dragging.

• Copy and paste Tokens using Ctrl + V and Ctrl + V.

  Distance is calculated in the same way as the cell based measure Tool (see [Tools guide](#side buttons))

• Double-click on a Token to open its configuration panel

  

  • Display name: The name of the Token

  • Token type: Character type can have vision

    Mount types can have vision and will grab other Tokens on top of them when they move.

    Item types cannot have vision

  • Token size: The dimensions of the Token. Scales the Token's image to fit (does not stretch).

  • Image: Token's sprite

  

  • Has vision: Does this Token have vision. Does nothing if the Token type is set to Item.

  • Night vision: A special light source that only you can see. Does nothing if the Token does not have vision enabled

  • Token highlighted: Small light source to show this Token even if it's in total darkness.

  • Light Source: Select the light source of the Token. There are a few presets that will automatically change the light depending on the source.

    By selecting Flickering or Pulsing you can fully configure the effect speed, strength etc.

    Larger light sources have reduced shadow resolution and precision.

  • Select the light colour. Selecting one of the light presets will automatically update this to match that preset's settings.

    There is currently a known bug where you need to click this button at least twice to update the colour of the colour picker.

    By selecting Flickering or Pulsing you will be able to fully configure effect speed, strength, etc.

    Bigger light sources have decreased shadow resolution and precision

  • Light color Select light color. Selecting one of the light presets automatically updates this to match that preset settings

    There is currently a known bug, where you have to click this button at least twice to update the color picker's color

  

  • Select possible conditions for this Token. Conditions will be visible as small icons at the top of the Token

• To save changes, click Save

• To discard changes, click Close

Lights

• Move lights with the left mouse button. New position will not be updated for players until you stop dragging.
• Copy and paste lights with Ctrl + V and Ctrl + V.
• Click on a light to open its configuration panel

• Enabled: to enable/disable a light source

• Light Radius: Configure the size of the light. Larger light sources have reduced shadow resolution and precision.

• Light Intensity: configure light intensity (how bright the emitted light is)

• Light source: Select light source. There are a few presets that will automatically change the light depending on the source.

  By selecting Flickering or Pulsing you can fully configure the effect speed, strength etc.

  • Select the light colour. Selecting one of the light presets will automatically update this to match that preset's settings.

    There is currently a known bug where you need to click this button at least twice to update the colour of the colour picker.

• To save changes, click Save.

• Discard changes will be added in the near future.

Notes

• Create Notes by selecting the Notes Tool and clicking on a Scene
• By default, Notes are set to be visible only for you
• Double clicking on a Note icon will open it
• Modify Note text by pressin Ctrl + M, and save edits by pressin Ctrl + S
• Move Notes around by dragging, and minimise by double clicking. Both actions can be done from the top left corner
• Scale Notes from bottom right corner

Blueprints

• Create a new Blueprint from the right panel. This will open a configuration panel. (see Token configuration)
• Add Tokens to the Scene by dragging Blueprints out from the side panel
• Right-clicking on a Blueprint in the right panel allows you to delete, modify, or set permissions for it
• Modifying Blueprints doesn't update any Tokens already on the Scene.
• You can drag Blueprints and folders from one folder to another
• Rename folders by double clicking them

Permissions

• Open Permission panel by right-clicking on a Blueprint, and selecting Permissions
• Configure permissions for each user you have invited to this game session
• Clicking on Refresh will add any missing users, who have been invited after this Blueprint was created

Owner

• This player can see through the eyes of the Token, but cannot move or delete it.
• This option is useful for general NPCs.

Observer

• This player can see through the Token's eyes, but have no permissions to move, or delete it
• This option is useful for general NPCs

None

• This player does not have permissions to move, edit, delete or see through the Token's eyes.
• This option is useful for enemies and Tokens that you don't want the player to interact with.

Keyboard shortcuts

• Here are some useful keayboard shortcuts that everyone should know
• More will be added in future updates

Game View

Tokens

• Tab: Switch between Tokens you own
• Arrow keys: Moves selected Token on the map, one cell at a time
• Alt: Prevents Token from snapping to grid when moved

Side panel

• Num 1: Pan Tool
• Num 2: Measure Tools
• Num 3: Ping Tool
• Num 4: Note Tool
• Num 5: Fog Tools (Game Master only)
• Num 6: Light Tools (Game Master only)