Hosting and Connectivity Guide¶
In Foundry Virtual Tabletop, a game session has one host and several clients. In order to enjoy a multi-player gaming experience the clients must be able to connect to the host which is running the tabletop software.
There are two main hosting modes. The following section attempts to help you understand which hosting mode may be the best choice for you.
In a self-hosted setting, the application runs on your own computer and creates a local web server which allows other players to connect directly to your computer. The self-hosted mode is most similar to the setup of Fantasy Grounds, Maptool, or GM Forge.
- Free (assuming you have a computer).
- Almost zero setup.
- Easy management of content using your own computer’s file system.
- Your world is only available when the host is running a session.
- Requires clients to be able to connect to your computer - either through a local network or using port forwarding.
- Player experience depends on the host’s internet speed.
In a dedicated hosting setting, the application runs on a persistent web server using node.js and all players (including the GM) connect to the game session. The dedicated hosting mode is most similar to the experience of Roll20 or Astral Tabletop.
- Your world is always online, although gameplay can be paused in between sessions
- Clients connect to your world regardless of local network configurations.
- Network transfer speeds are typically faster than self-hosted resulting in a better player experience.
- Requires a accessible web server which is configured to serve the Foundry VTT application.
- More complicated initial setup, especially for users who are unfamiliar with web hosting.
- Your world’s static files (maps, tokens, music) need to be served from a static location or from the web server.
In a self-hosted configuration, you will need to ensure that clients can connect to your PC using your IP address.
There are multiple ways to achieve this and you can use a combination of approaches for different players. By default,
Foundry Virtual Tabletop runs on port
Firewall Rules: For all self-hosted configuration models you will need to be sure that your local operating system firewall is not blocking network traffic for the application. For Windows users, you should be prompted to allow (or deny) a firewall exception when the Foundry VTT application is first started. If you have followed other steps to allow connectivity but users are still unable to connect, be sure to check your Firewall rules.
Local Area Network¶
If your players are on the same network as you, they should be able to connect to your
computer using your local IP address. To discover your own local IP address: for Windows check your Connection Settings
ipconfig from the Command Prompt, for Mac look at Network Settings under System Preferences or use
ipconfig in your Terminal, for Linux use
hostname -i. Local network players should connect to your local
IP address and port, for example
If your players are connecting over the internet, they will use your public IP address.
Use a site like http://whatismyip.host/ to easily discover your public IP address. In order for this to work, you
will need to forward web traffic for your local network to send the Foundry VTT port to your computer’s local IP
address. This step is required in order for your network to know where to send the connection. Port forwarding can
be intimidating for some users, but it is the recommended approach as it is more secure than other options. The exact
steps to implement port forwarding will depend on your network configuration and hardware. Most frequently, port
forwarding is done within your router configuration interface. The website https://portforward.com/ has general
instructions for the most common router configurations. Once the port is forwarded corretly players can connect
to your public IP address in the browser
Virtual Private Network¶
If your players are remote but port forwarding is not an option, a third option can be to use a VPN service. Please be aware - if you find yourself in this situation, the dedicated hosting option may be a better choice for you. With a virtual private network, other users will have access to details about your computer as well as any content (like documents or pictures) that you are sharing with your local network. If you do choose to go down this route, however, services like Hamachi (https://www.vpn.net/) can create a virtual network - once inside a VPN your players can connect to your session using the above instructions for Local Area Network.
For self-hosted installation simply download the zipped application which is suitable for your operating system and extract the archive into a directory of your choice.
The first time starting the application under a self-hosted configuration, you may be prompted by your operating system for permission to allow the application to interact with the external network. Be sure to allow this permission otherwise network traffic may be blocked by your operating system firewall.
To configure Foundry Virtual Tabletop for a dedicated server configuration there are a few simple steps to follow. Firstly you will need to create a server instance on which you want to host the Foundry VTT application. Secondly you will need to install Node.js and the Foundry VTT software.
Launch a Server Instance¶
The configuration for a dedicated server will vary somewhat depending on your hosting platform and networking requirements. This section provides a simple configuration example for running the server using an AWS instance (https://aws.amazon.com/ec2/). Foundry Virtual Tabletop can work even with a t2.micro size instance which is supported by the free tier program which is an easy way to begin trying out the software.
To get started, launch a t2.micro (or larger) instance using the Linux distribution of your choice. These instructions are for
the standard Amazon Linux AMI. Configure the inbound rules for your instance security group using the AWS dashboard to allow
inbound traffic using a
Custom TPC Rule for port
30000 (or a different port of your choice). Lastly, connect to your
new host via SSH. You will need to configure your SSH client to use the security key-pair provided by AWS.
To get started with Foundry VTT, you will need to install
nodejs which is used to host the server.
For Red Hat / Amazon Linux:
sudo yum install -y openssl-devel curl --silent --location https://rpm.nodesource.com/setup_10.x | sudo bash - sudo yum install -y nodejs
For Debian / Ubuntu:
sudo apt install -y libssl-dev curl -sL https://deb.nodesource.com/setup_10.x | sudo bash - sudo apt install -y nodejs
Once Node.js is installed, next download and extract the latest Foundry Virtual Tabletop Linux version from Patreon. The following commands will create an application directory and a sibling user data directory:
# Create application and user data directories mkdir foundryvtt mkdir foundrydata # Install the software cd foundryvtt wget https://s3-us-west-2.amazonaws.com/foundryvtt/releases/<patreon-link-here>.zip -O foundryvtt.zip unzip foundryvtt.zip # Start running the server node resources/app/main.js --dataPath=~/foundrydata
Foundry VTT will eventually be supported as a native application on macOS using Electron. In the short term there are some technical requirements for building applications to run in the macOS environment which are not yet satisfied by the software. This prevents the native Electron app from being an option for Mac users until they are solved, however it is still very possible to use Foundry VTT on Mac before that time.
Note that you can run a dedicated server from Windows also, for Windows you should download and install node.js from https://nodejs.org/en/download/.
Running the Application¶
Once you have extracted the Foundry VTT software you can start the software by running the Electron application or by
main.js directly using Node.js. If you start the application from the command line (or command prompt
in Windows), you can pass additional command-line arguments which are detailed below.
|--port||[Optional] You may specify a specific port on which to run the application. The default is 30000.|
|--world||[Optional] You may specify the name of a specific World directory which should be automatically loaded when the server is started.|
|--dataPath||[Optional] You may specify an explicit path to the user data directory which should be used as the source for packages and other content.|
- Node.js Example
node main.js --port=30000 --world=myworld --dataPath=/local/data/foundryvtt
- Electron (Windows) Example
FoundryVTT.exe --port=30000 --world=myworld --dataPath=D:\FoundryVTT
- Electron (Linux) Example
foundryvtt --port=30000 --world=myworld --dataPath=/local/data/foundryvtt
Once the server is running, your players can connect to the server using the public IP address or DNS name of your web host. You can also connect to your own running session from a web browser using localhost.
Application Configuration Options¶
You can configure some aspects of the application by editing the
options.json file in the Config directory inside
your application data folder.
- A port number which defines the default port used by the application unless one is explicitly provided using the
- A boolean flag for whether to run the Electron application in fullscreen mode.
- You may specify an explicit path to the user data directory which should be used as the source for packages and other content. This option is only used of the command line flag with the same name is not also passed.
- A custom hostname to use in place of the host machine’s public IP address when displaying the address of the game session. This allows for reverse proxies or DNS servers to modify the public address.
- A string path which is appended to the base hostname to serve Foundry VTT content from a specific namespace. For
example setting this to
demowill result in data being served from
- An absolute or relative path that points towards a SSL key file which is used jointly with the
sslCertoption to enable SSL and https connections. If both options are provided, the server will start using HTTPS automatically.
- An absolute or relative path that points towards a SSL certificate file which is used jointly with the
sslKeyoption to enable SSL and https connections. If both options are provided, the server will start using HTTPS automatically.
- An absolute or relative path which points to an optional AWS configuration file in JSON format containing
regionproperties. This file is used to configure integrated AWS connectivity for S3 assets and backup.
Where Do I Put My Data?¶
In order to comply with operating system expectations (most notably on Windows and MacOS), it is important not to store actively updated user data inside the application directory itself. Therefore Foundry Virtual Tabletop relies upon the concept of a user data path which defines the location that user data is saved. There are four ways that the user data location can be set.
- Command Line Flag. See the Command Line Options above.
- Environment Variable. Set
- Config Data Override. See the Application Configuration Options section above.
- Default OS Application Data. See below for details.
These options are evaluated in the above order, so if multiple options are set, the first valid option will be used. The default application data location for each operating system is the following:
/local/FoundryVTTin order of availability.
These default locations may not be ideal for many users, so it is recommended to use one of the above alternative methods to point Foundry VTT to a different data location as suits your preferences. The user data folder contains the following basic directory and file structure.
- These are application launch options which you can configure
- This directory contains the game systems which you have installed
- This directory contains the add-on modules which you have installed
- This directory contains the game worlds which you have available
When referencing data from within the virtual tabletop application, any content stored inside the Data directory is publicly available to be served directly. This is where you should put your content that you intend to use inside the application. You are free to create any folder or directory structure that you want inside this data directory. For example, if you have the following file in your file system:
<User Data Path>/Data/worlds/my-world/maps/dungeons/deadly-dungeon-01.jpg
When using that map image inside Foundry VTT, you can reference it as a web-accessible URL using the path relative to the Data folder:
Regarding File Naming Conventions: Since Foundry VTT works as a web server, you should be sure to use directory and file names which conform to web file and URL encoding conventions. You should generally avoid using spaces or special characters as these are likely to cause issues when serving your content to other players. See Google URL Guidelines for more detail.