Skip to content

Commit

Permalink
Added the Foundry Player's Guide
Browse files Browse the repository at this point in the history
  • Loading branch information
mattexdee committed Feb 25, 2024
1 parent 05b8472 commit 503540b
Show file tree
Hide file tree
Showing 15 changed files with 335 additions and 16 deletions.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
21 changes: 21 additions & 0 deletions docs/foundry-players-guide/chat-features.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
icon: fontawesome/solid/comments
---

# Chat Features
Messages that you and your party send, dice rolls, and uses of items, features, and spells are all tracked in the Chat Log. Let's take a deeper look at what you as a Player can use the chat to do.

---

## Messages
Foundry allows you to send messages, whispers, and in/out of character messages. By default normal messages and "in-character" messages will also appear over your Token's head but your Gamemaster may have disabled this.

- **In Character:** To send a message "in character" preface it with `/ic`.
- **Out of Character:** To send a message "out of character" preface it with `/ooc`. Messages sent this way will never appear above your Token.
- **Emote:** To send a message as an "emote" preface it with `/emote` like `/emote dances`.
- **Whisper:** To send a whisper to another player or your Gamemaster enter `/w PlayersName`. To send it to a group of users enter `/w [PlayersName, SecondPlayersName]`.

---

## Rolling Dice
Foundry has [basic](https://foundryvtt.com/article/dice/){ target=_blank } and [advanced](https://foundryvtt.com/article/dice-advanced/){ target=_blank } dice rolling. In most circumstances you can use your character sheet or an Item to roll but if you ever need to manually roll you can enter dice formula like `1d20 + 3 + 2d4` and press enter to roll. You can control who can see your rolls by setting the dropdown box above the chat box to: Public Roll, Private GM Roll, Blind GM Roll, or Self-Roll.
47 changes: 47 additions & 0 deletions docs/foundry-players-guide/combat-tracker.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
icon: material/sword-cross
---

# The Combat Tracker
Running combat varies from game system to game system but let's take a look at how the basics of the combat tracker works in Foundry VTT.

---

<figure class="right w450" markdown>
![Toggle Combat and Roll Initiative](../assets/foundry-players-guide/combat-tracker/toggle-combat-roll-initiative.webp){ loading=lazy }
<figcaption>Toggle your combat state and roll initiative.</figcaption>
</figure>

## Entering Combat and Rolling Initiative
Your GM may add you to the combat tracker themselves, but you can also toggle your combat state by clicking the sword and shield button from your [Token’s UI](token-features.md).

Similarly, the DM can automatically roll initiative for everyone in the encounter but you can roll it yourself by right from the combat tracker by clicking the <span class="reference">:material-sword-cross:</span> icon in the right-hand sidebar and then clicking the D20 next to your character’s name to roll.

??? foundry-tip "Pop Out the Combat Tracker"

Right click on the Combat Tracker's icon to pop it out of the right-hand sidebar. Then you can arrange it wherever you'd like and keep the sidebar on the Chat Log.

<div class="clear"></div>

---

<figure class="right w450 video_container" markdown>
<video controls="true" allowfullscreen="true">
<source src="../../assets/foundry-players-guide/combat-tracker/area-of-effect.webm" type="video/webm">
Your browser does not support the video tag.
</video>
<figcaption markdown>Rotate and place area of effect templates.</figcaption>
</figure>

## Making Attacks and Using Items
Every Game System's character sheet works differently but you should be able to click on the icon for your item, feature, or spell to send it to the Chat Log.

??? foundry-tip "Pop Out Chat Cards"

If there's an item, spell, or feature that you can use repeatedly like a Spiritual Weapon you can right click on the Chat Card and select <span class="reference">:octicons-link-external-16: Pop Out Chat Card</span> to continue to have access to its Attack, Saving Throw, and Damage buttons.

### Area of Effect Templates
Some abilities and spells impact an entire area. When you use one of these abilities Foundry will prompt you to place a measured template. These templates can be rotated by holding ++ctrl++ and scrolling up or down.

### Applying Healing and Damage
If an attack or healing spell applies to you, you can right click on it and apply its value as healing or damage to your Token. You can also apply healing or damage through your Token's Resource Bars by entering a value like "+15" or "-10".
36 changes: 36 additions & 0 deletions docs/foundry-players-guide/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# The Foundry VTT Player's Guide
Let me guess: Your DM has been raving about this thing called Foundry VTT for a couple weeks now and they’ve decided to start a game online or switch your game from Roll20 or Fantasy Grounds over to it. Now **you** have to learn how to play online for the first time or at least how to do it in Foundry. I’m going to try and make that as easy as possible. These guides will walk you through the Foundry UI, using your character sheet and Tokens, combat, and chat and webcam settings.

<div class="grid cards" markdown>
- :fontawesome-solid-display:{ .lg .middle } __The User Interface__

---

Familiarize yourself with the Foundry VTT interface.

[:octicons-arrow-right-24: Getting Started](user-interface.md)

- :fontawesome-solid-user:{ .lg .middle } __Using Your Token__

---

Learn how to use your Token and navigate Scenes.

[:octicons-arrow-right-24: Using Your Token](token-features.md)

- :material-sword-cross:{ .lg .middle } __The Combat Tracker__

---

Join the battle, roll for initiative and make your attack.

[:octicons-arrow-right-24: Join the Battle](combat-tracker.md)

- :fontawesome-solid-comments:{ .lg .middle } __Chat with Friends__

---

Send messages, whispers, and dice rolls to chat.

[:octicons-arrow-right-24: Chat with Friends](chat-features.md)
</div>
60 changes: 60 additions & 0 deletions docs/foundry-players-guide/token-features.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
---
icon: fontawesome/solid/user
---

# Using Your Token
Your Token is how you'll interact with Foundry most of the time. If your Actor is your character sheet, you can think of your Token as your mini. Let's look at what you can do with it now.

---

## The Token UI
<figure class="right w450" markdown>
![The Token UI](../assets/foundry-players-guide/tokens/player-token-ui.webp){ loading=lazy }
<figcaption>The Token User Interface</figcaption>
</figure>

1. **Elevation:** Sets your characters elevation and is useful for tracking your position when using something like a Fly spell.
2. **Move Up:** When multiple Tokens are present in the same square you can use this button to move your Token to the top of the stack.
3. **Move Down:** When multiple Tokens are present in the same square you can use this button to move your Token to the bottom of the stack.
4. **Status Effects:** When your character is impacted by a status effect like "Unconscious" you can set it using one of the effects in the Status Effects tray. Left click to add a small icon and right click to place a larger icon on your Token.
5. **Target:** Target this Token.
6. **Toggle Combat State:** Press this button to add or remove yourself from the combat tracker.
7. **Resource Tracker:** Displays any resource from your character sheet like Armor Class or Hit Points.
8. **Resource Tracker:** Displays any resource from your character sheet like Armor Class or Spell Slots.

---

<figure class="right w450 video_container" markdown>
<video controls="true" allowfullscreen="true">
<source src="../../assets/foundry-players-guide/tokens/movement.webm" type="video/webm">
Your browser does not support the video tag.
</video>
<figcaption markdown>Place waypoints with a click to measure out your movement.</figcaption>
</figure>

## Movement
You can drag your token to a new place and it will go there right away. You can also move around using the ++w+a+s+d++ or the ++up+down+left+right++ keys.

### Plan and Measure Your Movement with Waypoints
1. Hold the ++ctrl++ key (++cmd++ on a Mac) and drag away from your Token.
2. Left click to place a waypoint and keep adding more movement.
3. Once you’re satisfied with your planned movement just hit ++space++ and your Token will move quickly along the path that you set.

<div class="clear"></div>

---

## Vision

<figure class="right w450 video_container" markdown>
<video controls="true" allowfullscreen="true">
<source src="../../assets/foundry-players-guide/tokens/doors-and-rotating.webm" type="video/webm">
Your browser does not support the video tag.
</video>
<figcaption markdown>Players can open Doors and their line of sight updates automatically.</figcaption>
</figure>

Foundry has a very powerful vision and lighting system which includes support for things like darkvision, tremorsense, true sight, and other magically enhanced sight. Your Gamemaster may use all of these features for dynamic line of sight or none of them and just reveal fog of war manually. Here's what impacts what your Token can see when using the light and vision system:

- **Light:** If there's no light in a Scene you'll need darkvision or a torch to be able to see. There are also magical darknesses which can be placed in a Scene that you won't be able to see through even with darkvision.
- **Walls:** Foundry has a lot of Wall types like basic walls, windows, doors, and more. Depending on the type of wall, it will block your vision. Players have the ability to open doors if they're unlocked and your line of sight will update automatically while you navigate the Scene.
87 changes: 87 additions & 0 deletions docs/foundry-players-guide/user-interface.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
---
icon: fontawesome/solid/display
---

# The User Interface
This part of the guide is going to focus on the basic user interface. Be sure to check out the rest of the Player’s Guide which focuses on your character sheet, combat, rolling dice, reading and writing journals, controlling your token, and controlling your audio and video if you’re using Foundry’s built in video chat. I’ll also cover some shortcuts and nice quality of life tips. This will all be done using core Foundry features so some things might be different if your DM has installed modules to change how Foundry works. Let’s get started!

---

<figure markdown>
![The Foundry Player Interface](../assets/foundry-players-guide/user-interface/players-ui.webp){ loading=lazy }
<figcaption>The User Management Page</figcaption>
</figure>

=== "1. Scene Tools"

<figure class="right w350" markdown>
![Toolclips](../assets/foundry-players-guide/user-interface/toolclips.webp){ loading=lazy }
<figcaption>Toolclips break down every tool in the sidebar.</figcaption>
</figure>

The Scene Tools let you interact with things on the canvas. When there's no Scene open you can't use these tools. If you hover over one of the tools it will show you a quick example of how it works.

- <strong>:fontawesome-solid-user: Tokens:</strong> A Token is an Actor that has been placed in a Scene and the Token tools will let you interact with them.

- <strong>:fontawesome-solid-ruler-combined: Rulers:</strong> Rulers let you measure distance and place area of effect templates in a Scene.

- <strong>:fontawesome-solid-bookmark: Notes:</strong> See pages pinned to the Scene from Journal Entries in a Scene if your Gamemaster has given you access to them.

!!! foundry-tip "Hover to learn more about each tool."

Every tool in the sidebar has a helpful toolclip that you can see by hovering over it which will explain how you can use it. Once you're more familiar with how they work you can disable these toolclips in the Settings.

=== "2. Players List"

<figure class="right" markdown>
![User Configuration Window](../assets/foundry-basics/foundry-interface/user-configuration.webp){ loading=lazy }
<figcaption>The User Configuration Window</figcaption>
</figure>

The players list shows all of the logged in players. You can right click on your username in the list and click the <span class="reference">:material-human-male: User Configuration</span> option to set things like your:

- **Avatar:** The image used when you post a message in the chat log.
- **Player Color:** The color that represents you. Applies to borders on your chat messages, pings, targetting, and your mouse cursor indicator.
- **Pronouns:** Your pronoun preference.
- **Default Character:** The character that you will act as by default if none are selected.

!!! foundry-tip "You can see logged out players by clicking on the caret next to `Players`."

=== "3. Macro Bar"

Foundry supports Macros for rolling dice and running custom scripts. You can click on an empty box to create a new Macro or drag an Item from your character sheet to the Macro bar for quick access to it. You can have multiple pages of Macros by clicking the up and down arrows to the right.

!!! foundry-tip "You can also run a Macro by pressing the number assigned to its square on your keyboard."

=== "4. Sidebar"

!!! foundry-tip "Right click on any tab to pop it out. This allows you to rearrange the UI and access multiple tabs at once."

The sidebar is where you can find all of your World's useful data.

- <strong>:fontawesome-solid-comments: Chat:</strong> Chat messages, whispers, item/feature uses, and rolls will appear here. You can configure who can see your rolls by changing the dropdown to Public Roll, Private GM Roll, Blind GM Roll, or Self-Roll. Gamemaster users will be able to see every roll except self rolls.

- <strong>:material-sword-cross: Combat:</strong> When your Gamemaster starts an encounter you can track turns here.

- <strong>:fontawesome-solid-user: Actors:</strong> Your character and any other Actors you need for things like familiars, summons, etc. will appear here.

- <strong>:fontawesome-solid-suitcase: Items:</strong> Any items, spells, character abilities, and more that aren't on your character are visible here if you own them.

- <strong>:fontawesome-solid-book-open: Journal Entries:</strong> Journal entries for planning your adventures, tracking progress, and any other note taking are stored here.

- <strong>:fontawesome-solid-table-list: Roll Tables:</strong> Roll tables, which are tables of options that can be rolled on for a random result, are stored here.

- <strong>:material-cards: Cards:</strong> Decks/stacks of cards and hands are stored here.

- <strong>:fontawesome-solid-music: Music:</strong> Playlists and soundboards are stored here. Each player can also independently control their volume from this tab.

- <strong>:fontawesome-solid-book-atlas: Compendium Packs:</strong> Compendium Packs are long term storage for everything we just covered (except Encounters). You can think of it as cold storage for your data which will make the World load more quickly.

- <strong>:material-cogs: Settings:</strong> This tab contains a number of useful tools that let you: configure your settings, controls, explore Foundry's features with Tours, check out the official documentation, the community Wiki, and log out.

=== "5. Canvas"

This is where Scenes will display and where you'll interact with your Token and the rest of the elements in your toolbar.

??? question "What does `Game Paused` mean?"
When the game is paused you will not be able to move your Tokens or open doors. The Gamemaster can pause and unpause the game by pressing ++space++.
Loading

0 comments on commit 503540b

Please sign in to comment.