Foundry module documentation
Everything you need to install, run and fix the ShawnsVTTs modules for Foundry VTT.
Get started
Install the modules and keep them up to date.
- Install the Foundry modules
Step by step: make your install links, add the Phone, Handouts and the free Library to Foundry, enable them in your world, update and uninstall.
- GM guide
Run the phone at your table: handset states, battery and chargers, signal zones, phone numbers, notices, NPC calls and voicemail greetings.
- Compatibility
Which Foundry VTT versions the phone supports and has been tested on, what it needs, and how we handle new Foundry releases.
- Troubleshooting
Fixes for the usual problems: the Library is missing, the install link is refused, the Phone button is not there, or a call does not ring.
- Membership and updates
How your Patreon membership relates to the Foundry modules: what you get, what happens when you cancel, and how your install link works.
Player guide
One page for each app on the phone.
- Getting started with the Foundry phone
Open your character's phone in Foundry VTT, find your way around the home screen, and learn what a switched off, jammed or broken phone looks like.
- Send and receive text messages
Text other player characters and NPCs from the Foundry phone: start a conversation, format your text, and understand queued messages and anonymous senders.
- Unsend a text message
How unsending works on the Foundry phone: which messages you can take back, what everyone sees afterwards, and what is not removed.
- Group chats and the party feed
Create named group chats between player characters on the Foundry phone, and use the party feed that reaches everyone at the table.
- Make and answer calls
Dial, answer, decline and hang up on the Foundry phone, read your call history in Recents, and learn what happens when nobody picks up.
- Voicemail
How voicemail works on the Foundry phone: typed greetings, leaving a text message, reading voicemail in Recents, and what a GM can attach.
- Send and read email
Use the email app on the Foundry phone: read your inbox, compose a message with a subject, reply to a thread and address mail by contact or address.
- Contacts
See who your character can reach on the Foundry phone, open a contact card to text, email or call, and learn how NPCs get added by the GM.
- Keep notes on your character's phone
Write notes on your Foundry VTT character's phone and choose whether they stay private, go to the GM, or are shared with the whole table.
- View photos and files on the phone
See what the Photos and Files apps show on a Foundry VTT phone, and how a GM adds photos, handouts and documents with a macro.
- Check your balance and pay other characters
Check your character's money and pay other characters or NPCs from the Foundry VTT phone Wallet, with a memo on every payment and a history.
- Read the in-game date, time and weather
The Weather app shows the in-game date, time and weather set by your GM in Foundry VTT. It is typed by hand, not a live forecast.
- Use the in-game calendar
Read the in-game calendar on your Foundry VTT phone: a month view of the story date with events the GM adds, up to 200 per world.
- Use the phone calculator
How the pocket calculator on the Foundry VTT phone works: keys, how operators chain, digit limits and the ERROR display.
- Roll dice from the phone
Roll dice from your character's phone in Foundry VTT. Pick a die, a count and a modifier, and the result posts to the chat log.
- Phone settings: wallpaper, sound and battery
Set a wallpaper, mute phone sounds and check your battery from the Foundry VTT phone Settings. Learn what each option does and what the GM controls.
- Share your phone screen with the table
Turn your phone toward the table in Foundry VTT: share a snapshot of your phone screen with every player, and stop whenever you like.
GM guide
Run the phone: numbers, signal, battery and more.
- The GM Manage panel
A tour of the Manage screen on the GM phone: handset states, era and apps, battery, notices, signal, phone numbers and voicemail greetings.
- Set and change phone numbers
Give any character or NPC line a number of your choice, or reset it to the generated one. Covers the seven digit minimum and the unique last four digits.
- Share NPCs and manage contacts
Introduce an NPC to a character so they can text and call by name, and build an NPC address book from the GM phone. Includes the anonymous thread rule.
- Voicemail greetings and dropped voicemail
Write the greeting a caller sees when nobody answers, and leave a voicemail as any NPC without ringing. Settings, buttons and the no ring rule.
- Send notices to your players
Pin a short message on every phone, or only on the characters you choose. How to send a notice, who sees it, and the 50 notice limit.
- Jam, break and restore handsets
Set each character Online, Jammed or Broken, block NPC lines, and learn what every state does, including held messages.
- Signal zones per scene
Make a scene a weak signal or dead zone. Weak dims the bars, dead blocks sending and receiving and held messages arrive later.
- Turn on the phone battery
Switch on phone charging, set the drain per in-game hour, choose who it applies to and set levels by hand. The battery only moves with the world clock.
- Charge items: power banks and more
Name inventory items that recharge a phone, set how much each restores and whether it is used up. Works with items on any game system character sheet.
- Charging stations and charging zones
Mark a tile as a charging station or draw a Battery charging region. Every setting and default, plus the Foundry restart needed after install.
- Require a phone item in the inventory
Make the phone work only while a character carries a phone item. Which item names count, how to flag any item, and what players see without one.
- Choose the era and switch apps off
Switch the whole table between a modern smartphone and a 1990s brick phone, and turn individual apps off. Lists what each era includes and its limits.
- Echo phone messages to the chat log
Copy texts, group chats and party messages into the Foundry chat log, whispered to the GM or public. Setting, default, format and what is left out.
Handouts guide
Design handouts and business cards, and put them in front of your players.
- What ShawnsVTTs Handouts does
Design bounty notices, letters, case files, maps and business cards in Foundry VTT, then put them on your players' screens, in their Journal or on their phones.
- Make your first handout
Open the editor from the Journal tab, start from a preset, change the text, save it as a Journal entry, and open it again later.
- Design a handout
What each part of the Handouts editor changes: presets, formats, paper stock, edges, borders, colours, blocks and artwork.
- Show or give a handout
Pass a handout to chosen players, decide whether it is shown once or handed over to keep, and pick how it arrives on the table.
- Business cards
Make two-sided business cards in Handouts, fill their lines from an NPC or type your own, and spin them onto the table.
- Cards for NPCs
Give an NPC or character a business card from its sheet, type the details the sheet does not have, throw it to players and remove it.
- Every handout preset
The full list of presets in ShawnsVTTs Handouts for Foundry VTT, by set, with what each is for and the sheet it is drawn on.
Phone and Handouts together
What changes when both modules are enabled in the same world.
- Using Phone and Handouts together
What changes in Foundry VTT when ShawnsVTTs Phone and Handouts are both enabled: files that open handouts, cards with real numbers, and contacts from cards.
- Send a handout to a phone
Send a saved handout to characters' phones as a file in the Files app, and let the player open it from there with one button.
- Cards and contacts with the phone
How business cards and the phone's contacts work together: numbers on cards, saving a card's owner as a contact, and throwing a card from a contact's page.
- Ideas for using both
Four ways to use a handout and a phone in one scene in Foundry VTT: a tip, a fixer's card, a leaked document and a case file that follows the party.
Ideas and guides
Set it up in ten minutes, then use it for mysteries, horror, heists and more.
- Foundry phone quickstart for GMs: set up in ten minutes
A ten-minute setup for the ShawnsVTTs Phone in Foundry VTT: install, enable, share NPCs, set greetings, send a notice, and add battery and signal.
- Run a mystery with the Foundry phone
Run clue trails in Foundry VTT with texts, email, planted photos and files, shared notes and the GM call log. Concrete scenes for mystery tables.
- Run a horror game with the Foundry phone
Use jammed and broken handsets, dead zones, a battery tied to the world clock and late-arriving queued messages to build dread in Foundry VTT.
- Run a heist with the Foundry phone
Plan and run a heist in Foundry VTT with group chats, the party feed, calls to a fixer played by the GM, wallet payments and notices when the job goes wrong.
- Make NPCs feel real with the Foundry phone
Give NPCs a phone number, a voicemail greeting and a texting style in Foundry VTT, and reveal them one at a time as your characters earn their trust.
- Keep a big table in the loop with group chats
Use group chats, the party feed, notices and shared notes in the Foundry VTT phone to keep a large group informed between scenes and during splits.
Reference
Macros, the API and answers to common questions.
- Macros and the phone API
Open the phone, plant a photo or file on a character, and find every module setting, the P shortcut and the toolbar button for the Foundry VTT phone.
- Where the Foundry phone keeps your data
Where the Foundry VTT phone stores texts, photos and settings, who can read them, what players need, and how to back up and keep a long campaign light.
- Foundry VTT Phone: frequently asked questions
Answers to what people ask before installing the Foundry VTT phone: versions, game systems, what players need, the GM online, data, performance and cancelling.
- Release notes
What changed in each version of the ShawnsVTTs Library, Phone and Handouts for Foundry VTT, newest first.
- Handouts macros and API
Open the Handouts editor, find an NPC's business card, throw it to players or show it to yourself, from a macro or another Foundry module.