Commit ce17cc11 authored by Andrew's avatar Andrew

Updates to Items and Map Notes pages

parent ad82673c
......@@ -37,11 +37,6 @@ sudo yum -y install httpd
<VirtualHost *:80>
ServerName your.hostname.com
# Log Configuration
ErrorLog "/var/log/httpd/your.hostname.com.error_log"
CustomLog "/var/log/httpd/your.hostname.com.access_log" common
LogLevel error
# Proxy Server Configuration
ProxyPreserveHost On
ProxyPass "/socket.io/" "ws://localhost:30000/socket.io/"
......@@ -90,11 +85,6 @@ sudo systemctl restart httpd
<VirtualHost *:443>
ServerName your.hostname.com
# Log Configuration
ErrorLog "/var/log/httpd/your.hostname.com.error_log"
CustomLog "/var/log/httpd/your.hostname.com.access_log" common
LogLevel error
# SSL Configuration
SSLCertificateKeyFile "/etc/letsencrypt/live/your.hostname.com/privkey.pem"
SSLCertificateFile "/etc/letsencrypt/live/your.hostname.com/fullchain.pem"
......
<p>Foundry Virtual Tabletop uses the concept of items, for objects that have their own statistics and information and can then be associated with or used by actors. This page provides an overview on Items, the Items Directory, and their functionality.</p>
<hr/>
<h2>The Items Directory</h2>
<figure class="right">
<img title="The Items Sidebar" src="https://foundryvtt.s3.us-west-2.amazonaws.com/website-media-dev/user_1/screen/items-directory-2020-05-19.png" />
<figcaption>The Gamemaster's view of the Items Directory sidebar.<br>Notice the buttons at the bottom of the sidebar <br>for creating new items and folders.</figcaption>
</figure>
<p>Items in Foundry can be viewed, created, and managed in the Items Directory sidebar. Like the Scenes, Actors, and Journal Entries directories, this directory can contain folders to organize your world's items. Only a Gamemaster or Assistant-level user can change or move folders, but any players with at least Limited permissions on an item can see the item and the folder(s) containing it in the Items Directory.</p>
<p>Like folders in other directories, the "quill" icon on an item folder will create a new item in that folder, and the "plus folder" icon will create a new subfolder.</p>
<figure class="right">
<img title="The Items Sidebar Context Menu" src="https://foundryvtt.s3.us-west-2.amazonaws.com/website-media-dev/user_1/screen/items-sidebar-context-menu-2020-05-19.png" />
<figcaption>The Gamemaster's context menu for an item<br> and is accessed by right-clicking the item.</figcaption>
</figure>
<h3>Item Context Menu Options</h3>
<dl>
<dt>View Item Artwork</dt>
<dd>Views the item's artwork in new window.</dd>
<dt>Clear Folder</dt>
<dd>Removes the item from all folders, placing it at the top level of the Items directory.</dd>
<dt>Delete</dt>
<dd>Deletes the item, after accepting a confirmation prompt.</dd>
<dt>Duplicate</dt>
<dd>Creates a copy of the item in the directory.</dd>
<dt>Configure Permission</dt>
<dd>Configure the permission levels of the item, allowing players of your choice to view or modify the item in the directory.</dd>
<dt>Export Data</dt>
<dd>Exports the item's data as a JSON file on your computer.</dd>
<dt>Import Data</dt>
<dd>Imports data into the item from a JSON file on your computer.</dd>
</dl>
<p>Gamemasters, Assistants, and other players with permissions to view items can do so by double-clicking on an item in the Items Directory. This opens the item sheet, whose features depend on the sheet itself or the system being used.</p>
<h3>Owned Items</h3>
<p>When an Item is added to an Actor, it becomes an "Embedded Entity" which is called an Owned Item. These Owned Items appear in the Actor sheet and, depending on the system, can be used by the actor. Dragging an item from the directory onto an actor's sheet will create a copy of the item as an "Owned Item". This owned item is separate from the original item - changes in the original item will not affect the owned item, and vice versa. Additionally, this owned item is not accessed from the Items Directory - it can only be viewed through the actor's sheet.</p>
<h3>Importing Items</h3>
<p>When, the Items Directory will initially be empty. Though items can be created fairly quickly from scratch, it may be desirable to import items from elsewhere.</p>
<h4>Importing from Compendium</h4>
<p>An item can be imported from a compendium by either dragging the item from the compendium into the Items Directory, or by right-clicking the item in the compendium and selecting "Import".</p>
<h4>Importing from JSON</h4>
<p>If the system and modules your world uses provide no compendiums, you can still import items directly from a JSON file. This JSON file is created by right-clicking an item in the Directory and selecting "Import Data" to import the JSON data into that item. This will overwrite the item.</p>
<hr/>
<h3>API References</h3>
<p>To interact with Item entities programmatically, you will primarily use the following API concepts:
<ul>
<li>The <a href="/api/Item.html" title="The Item Entity" target="_blank">Item</a> Entity</li>
<li>The <a href="/api/Items.html" title="The Items Collection" target="_blank">Items</a> Collection</li>
<li>The <a href="/api/ItemSheet.html" title="The Item Sheet Application" target="_blank">ItemSheet</a> Application</li>
</ul>
</p>
<hr/>
\ No newline at end of file
......@@ -46,9 +46,17 @@ events {
http {
include mime.types;
default_type application/octet-stream;
sendfile on;
# Configure Logging
error_log /tmp/nginx.error.log warn;
access_log /tmp/nginx.access.log combined;
sendfile on;
# Allow File Uploads
client_max_body_size 300M;
keepalive_timeout 5;
# Define Server
server {
# Enter your fully qualified domain name or leave blank
......@@ -57,10 +65,6 @@ http {
# Listen on port 80 without SSL certificates
listen 80;
# Allow File Uploads
client_max_body_size 300M;
keepalive_timeout 5;
# Proxy Requests to Foundry VTT
location / {
......@@ -129,9 +133,17 @@ events {
http {
include mime.types;
default_type application/octet-stream;
sendfile on;
# Configure Logging
error_log /tmp/nginx.error.log warn;
access_log /tmp/nginx.access.log combined;
sendfile on;
# Allow File Uploads
client_max_body_size 300M;
keepalive_timeout 5;
# Define Server
server {
# Enter your fully qualified domain name or leave blank
......@@ -142,10 +154,6 @@ http {
ssl_certificate "/etc/letsencrypt/live/your.hostname/fullchain.pem";
ssl_certificate_key "/etc/letsencrypt/live/your.hostname/privkey.pem";
# Allow File Uploads
client_max_body_size 300M;
keepalive_timeout 5;
# Proxy Requests to Foundry VTT
location / {
......
<p>Tabletop roleplaying games often require note-taking for specific objects in a scene, or landmarks on a map. Foundry Virtual Tabletop supports the use of placing journal entries on the map to serve as map notes. This page details the process of creating and working with Map Notes (a.k.a. Journal Notes) to notate scenes in Foundry Virtual Tabletop.</p>
<hr>
<h3>Creating Notes</h3>
<p>A Map Note is first made by creating its respective <a rel="nofollow" target="_blank" title="Journal Entries" href="../journal/">Journal Entry</a> in the directory. The Journal Entry can be dragged from the sidebar onto the scene to create the Map Note. Finally, a dialog window should appear, allowing you to configure the note before it is placed. A Map Note can be configured again by double right-clicking it. The details of each configuration option are listed below:</p>
<figure>
<img alt="The Map Note Configuration Dialog" src="https://foundryvtt.s3.us-west-2.amazonaws.com/website-media-dev/user_1/screen/map-note-configuration-2020-05-19.png">
<figcaption>An example Map Note and its Map Note Configuration dialog which is opened by double right-clicking on the control icon.</figcaption>
</figure>
<dl>
<dt>Journal Entry:</dt>
<dd>The Journal Entry assigned to the Map Note. Double clicking the Map Note will bring up the Journal Entry.</dd>
<dt>Text Label:</dt>
<dd>The label the Map Note will display when moused over. If left empty, the label will default to the name of the Journal Entry.</dd>
<dt>X/Y-Position:</dt>
<dd>The coordinates for the Map Note on the scene. It is worth noting The Map Note can still be dragged and relocated after placing, making these fields more suitable for fine-tuning the placement of pins.</dd>
<dt>Entry Icon:</dt>
<dd>The display icon for the Map Note.</dd>
<dt>Icon Size:</dt>
<dd>The size of the Map Note's icon on the Scene. This is equal to the length of one side of the icon, in pixels.</dd>
<dt>Icon Tint:</dt>
<dd>The tint color of the Entry Icon. Empty by default.</dd>
<dt>Font Size:</dt>
<dd>The font size of the Text Label entered.</dd>
<dt>Text Anchor Point:</dt> The placement of the Text Label relative to the Map Note itself.</dd>
</dl>
<hr>
<h3>Viewing Notes</h3>
<p>The visibility of Map Notes are determined by its corresponding Journal Entry - if a player has "Limited" permissions to the Journal Entry, they will be able to view the Map Note. If a Map Note has no Journal Entry associated with it, the note will be visible to all users currently viewing the scene. Note that if a player only has Limited permission to a Journal Entry, they will still be able to see the position of the Map Note pin and it's assigned tooltip, but not any details of the Journal Entry itself.</p>
<p class="note info">If you right click on a Journal Entry in the sidebar, you can conveniently "Jump to Pin" to pand the canvas to it's placed Note location.</p>
<p>Map Notes are not always seen straight away - depending on the user's settings, they may only appear while the Journal Notes button is selected in the scene control toolbar. If you wish to see available map notes on the scene at all times, simply click on the Journal Notes button (bookmark icon) in the scene control toolbar, and click "Toggle Notes Display" (magnifying glass icon). Once enabled, notes will always be visible. This setting is <em>per user</em> - each player is able to turn on and off Map Note visibility.</p>
<hr>
<h3>Deleting Notes</h3>
<p>A Map Note can be deleted from a Scene by a Gamemaster by mousing over the note and pressing the Delete key. Alternatively, all Map Notes on the current scene can be deleted by clicking the Map Notes button (bookmark icon) in the scene control toolbar, and clicking "Clear Notes" (trash can icon).</p>
<p class="note info">Remember that deleting a placeable object like a Map Note will not delete the Journal Entry that it refers to.</p>
<hr>
<h3>API References</h3>
<p>To interact with Map Note objects programmatically, you will primarily use the following API concepts:
<ul>
<li>The <a href="/api/Note.html" title="The Note Object" target="_blank">Note</a> Object</li>
<li>The <a href="/api/NotesLayer.html" title="The Notes Canvas Layer" target="_blank">NotesLayer</a> Canvas Layer</li>
<li>The <a href="/api/NoteConfig.html" title="The Note Config Application" target="_blank">NoteConfig</a> Application</li>
</ul>
</p>
<hr/>
......@@ -182,5 +182,21 @@
</ul>
<hr />
<h2>The Token HUD</h2>
<p>TODO</p>
\ No newline at end of file
<p>TODO</p>
<hr/>
<h2>Frequently Asked Questions</h2>
<blockquote class="question" id="shared-token-vision">How can I allow players to have shared vision across multiple Tokens?</blockquote>
<p>This can be accomplished by ensuring the player or players have Observer or Owner permission to each of the Actors.If a User has permission to more than one token with vision, when no Token is controlled, the vision displayed will be the union of vision across all Tokens. If a User has a single Token controlled, their vision will be only what is visible to that one Token.</p>
<p>If you select a single Token and want to go back to shared vision across all tokens just de-select it by one of the following methods:</p>
<ul>
<li>Select an empty rectangle on the map.</li>
<li>Shift+click the token to remove it from the controlled set.</li>
<li>Press ESCAPE.</li>
<li>[Optionally] Use the "deselection" module which will release control of your token when you left-click anywhere else in the Scene.</li>
</ul>
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment