Foundry VTT

https://foundryvtt.com/article/
Admin
Foundry Virtual Tabletop is a self-hosted virtual tabletop application for playing tabletop...
Tokens:105,737
Snippets:1,704
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Module Manifest: Media Field Example

Source: https://foundryvtt.com/article/module-development

Illustrates the 'media' field in the module manifest, used to provide images for the setup screen, including type, URL, and thumbnail.

```json
"media": [
  {
    "type": "setup",
    "url": "modules/demon-queen-awakens/scenes/DemonQueenCover.webp",
    "thumbnail": "modules/demon-queen-awakens/scenes/thumbs/the-valley-of-stone.webp"
  }
]
```

--------------------------------

### Example Manual Document Links

Source: https://foundryvtt.com/article/journal

These examples demonstrate how to apply the manual document linking syntax for Actors.

```foundryvtt
@Actor[Locke]
```

```foundryvtt
@Actor[Pt1jPTgVWdJ6QYIA]{Locke}
```

--------------------------------

### Initial Portable Installation Structure

Source: https://foundryvtt.com/article/installation

This illustrates the directory structure of a portable Foundry VTT installation before its first run.

```text
E:\
            FOUNDRYVTT-PORTABLE-12.345
                    App
                    README.txt
```

--------------------------------

### Quick-Start Adventure Registration Example

Source: https://foundryvtt.com/article/adventure

Example configuration for registering quick-start adventures in a module's module.json file. This allows new worlds to easily import your adventure.

```json
"quickstart": {
    "adventures": {"dnd5e": uuid.of.the.5e.adventure, "pf2e": uuid.of.the.pf2e.adventure}
    "postImport": true,
    "world": {
        "background": "modules/your-modules-id/assets/background.webp",
        "cover": "modules/your-modules-id/assets/thumb.webp"
    }
}

```

--------------------------------

### Example Complete Module File Structure

Source: https://foundryvtt.com/article/module-development

An example of a more complex module file structure that includes additional assets like artwork and specific content files.

```text
{userData}/Data/modules/
  dice-tray/
    module.json
    artwork/
      d4-icon.png
      d6-icon.png
      d8-icon.png
      d10-icon.png
      d12-icon.png
      d20-icon.png
    templates/
      dice-roller.html
    scripts/
      roller.js
    styles/
      roller.css
    packs/
      rolltables
    lang/
      en.json

```

--------------------------------

### Example module.json Configuration

Source: https://foundryvtt.com/article/publisher-handbook

This is a minimal example of a module.json manifest file required for the Premium Content System. Ensure 'manifest' points to your package's public URL, 'protected' is set to true, and the 'download' field is omitted.

```json
{
    "id": "your-modules-name",
    "title": "Your Module's Name",
    "manifest": "https://r2.foundryvtt.com/packages-public/your-modules-name/module.json",
    "protected": true
}
```

--------------------------------

### V10 Manifest: Example - Compatible V9 to V10

Source: https://foundryvtt.com/article/manifest-migration-guide

Example showing how to specify compatibility from V9 to V10, including older V9 fields and the new V10 compatibility object.

```json
{
  "minimumCoreVersion": 9, // V9 compatible minimum field
  "compatibleCoreVersion": "10.120", // V9 compatible verified field
  "compatibility": {
    "minimum": 9, // Can't be installed before V9
    "verified": "10.120", // Verified compatible up to build 10.120
    "maximum": 10 // Can't be installed after V10
  }
}
```

--------------------------------

### Example UUID Document Link

Source: https://foundryvtt.com/article/journal

This example shows how to use the UUID syntax to link to a specific Actor.

```foundryvtt
@UUID[Actor.VXbvLWzJkGYkMc63]{Akra (Dragonborn Cleric)}
```

--------------------------------

### Example Item Creation and System Field

Source: https://foundryvtt.com/article/system-development

Demonstrates the structure of a created item, highlighting the 'system' field and its contents.

```json
{
  "_id": "e6c7US1VK2cqejVJ",
  "name": "Test Weapon",
  "permission": {
    "default": 0
  },
  "system": {
    "rarity": "common",
    "damage": 5
  },
  "flags": {},
  "type": "weapon",
  "img": "icons/svg/sword.svg"
}
```

--------------------------------

### Install Apache on Ubuntu or Debian

Source: https://foundryvtt.com/article/apache

Installs the Apache web server on Ubuntu or Debian-based Linux distributions.

```bash
sudo apt install apache2

```

--------------------------------

### V10 Manifest: Example - Compatible V10 to V11

Source: https://foundryvtt.com/article/manifest-migration-guide

Example of a V10 manifest specifying compatibility from V10 up to V11, with verification up to a specific build.

```json
{
  "compatibility": {
    "minimum": 10, // Can't be installed before V10
    "verified": "10.120", // Verified compatible up to build 10.120
    "maximum": 11 // Can't be installed after V11
  }
}
```

--------------------------------

### Minimal module.json Manifest Example

Source: https://foundryvtt.com/article/module-development

This is a basic example of a module.json file. It includes the essential fields required for Foundry VTT to recognize and display your module.

```json
{
  "id": "dice-tray",
  "title": "Dice Tray - An Example FVTT Module",
  "description": "A simple module created as a demo for working in the Foundry Virtual Tabletop framework.",
  "authors": [
    {
    "name": "Atropos"
    }
  ],
  "version": "1.0.0",
  "compatibility": {
    "minimum": "10",
    "verified": "11"
  }
}
```

--------------------------------

### V10 Manifest: Example - Compatible with only V10

Source: https://foundryvtt.com/article/manifest-migration-guide

Example of a V10 manifest specifying compatibility strictly within V10.

```json
{
  "compatibility": {
    "minimum": 10, // Can't be installed before V10
    "verified": 10, // Verified compatible with all of V10
    "maximum": 10 // Can't be installed after V10
  }
}
```

--------------------------------

### Create Application and User Data Directories

Source: https://foundryvtt.com/article/installation

Create the necessary directories for Foundry VTT application and user data. This is a prerequisite for installation.

```bash
cd $HOME
mkdir foundryvtt
mkdir foundrydata
```

--------------------------------

### Example Full V10+ Manifest

Source: https://foundryvtt.com/article/manifest-migration-guide

This is a comprehensive example of a manifest file structured for Foundry VTT version 10 and later. It includes all necessary fields for package identification, compatibility, authors, relationships with systems and modules, script and style paths, languages, and distribution URLs.

```json
{
  "id": "vue-encounter-builder",
  "title": "🌑 Dungeon Moon Encounter Builder",
  "description": "A fair encounterൺ builder for Foundry",
  "version": "1.0.0",
  "compatibility": {
    "minimum": 10,
    "verified": 10.120,
    "maximum": 10
  },
  "authors": [
    {
      "name": "Cody Swendrowski",
      "url": "https://swendrowski.us",
      "email": "cody@swendrowski.us",
      "discord": "cswendrowski#9701"
    }
  ],
  "relationships": {
    "systems": [
      {
        "id": "toolkit13",
        "manifest": "https://github.com/Mageflame/Toolkit13/releases/download/latest/system.json",
        "compatibility": {
          "minimum": "1.11.0",
          "verified": "1.14.0",
          "maximum": "1.15.0"
        }
      }
    ],
    "requires": [
      {
        "id": "dlopen",
        "type": "module",
        "manifest": "https://raw.githubusercontent.com/ForgeVTT/fvtt-module-dlopen/master/module.json",
        "compatibility": {
          "minimum": "1.2.0",
          "verified": "1.4.0",
          "maximum": "2.0.0"
        }
      },
      {
        "id": "vueport",
        "type": "module",
        "manifest": "https://raw.githubusercontent.com/ForgeVTT/fvtt-module-vueport/master/module.json"
      }
    ]
  },
  "esmodules": [
    "/scripts/dugeonmoon.js"
  ],
  "styles": [
    "/css/dugeonmoon.css"
  ],
  "languages": [
    {
      "lang": "en",
      "name": "English",
      "path": "languages/en.json"
    }
  ],
  "url": "https://github.com/cswendrowski/FoundryVTT-Encounter-Builder",
  "manifest": "https://github.com/cswendrowski/FoundryVTT-Encounter-Builder/releases/latest/module.json",
  "download": "https://github.com/cswendrowski/FoundryVTT-Encounter-Builder/releases/download/1.0.0/module.zip"
}
```

--------------------------------

### Install Apache on Red Hat or CentOS

Source: https://foundryvtt.com/article/apache

Installs the Apache HTTP Server on Red Hat Enterprise Linux or CentOS.

```bash
sudo yum update -y
sudo yum -y install httpd

```

--------------------------------

### Install Nginx on Ubuntu or Debian

Source: https://foundryvtt.com/article/nginx

Use these commands to update your package list and install Nginx on Ubuntu or Debian-based systems.

```bash
sudo apt-get update
sudo apt-get install nginx

```

--------------------------------

### Start Foundry VTT Server (Windows V12 and before)

Source: https://foundryvtt.com/article/installation

Use this command to start the Foundry VTT server on Windows for versions V12 and older. Specify the data path using the --dataPath argument.

```bash
node resources/app/main.js --dataPath=%userprofile%/foundrydata
```

--------------------------------

### Portable Installation Structure After First Run

Source: https://foundryvtt.com/article/installation

This shows the directory structure of a portable Foundry VTT installation after it has been run for the first time, including the automatically created Config, Data, and Logs folders.

```text
E:\
            FOUNDRYVTT-PORTABLE-12.345
                    App
                    Config
                    Data
                    Logs
                    README.txt
```

--------------------------------

### Install Nginx on Red Hat or CentOS

Source: https://foundryvtt.com/article/nginx

Execute these commands to update your system and install Nginx on Red Hat or CentOS systems.

```bash
sudo yum update -y
sudo yum install nginx

```

--------------------------------

### Incrementing Version Examples

Source: https://foundryvtt.com/article/intro-development

Illustrates simple version increments. Suitable for user-facing packages like content and modules.

```text
1 -> 2 -> 3
1.1 -> 1.2 -> 2.0
alpha1 -> alpha2 -> beta1 -> stable1
```

--------------------------------

### Example Foundry VTT Usage Data

Source: https://foundryvtt.com/article/privacy-policy

This JSON object represents a real example of the usage data collected by the Foundry Virtual Tabletop software when the 'Share Usage Data' setting is enabled. It includes details about the operating system, Foundry VTT version, installed modules, game systems, and playtime.

```json
{
  "timestamp": 1677769428480,
  "os": {
    "platform": "win32",
    "version": "Windows 10 Pro",
    "node": "18.13.0"
  },
  "foundry": {
    "generation": 11,
    "build": 292,
    "channel": "prototype",
    "hosting": null
  },
  "modules": {
    "atropos-maps": {
      "version": "1.4.0"
    },
    "caeora-maps-tokens-assets": {
      "version": "2.1.3"
    },
    "demon-queen-awakens": {
      "version": "1.1.1"
    },
    "dice-so-nice": {
      "version": "4.6.5"
    },
    "gameboard-support": {
      "version": "1.0.5"
    },
    "house-divided": {
      "version": "1.1.2"
    },
    "michaelghelfi": {
      "version": "1.3"
    },
    "pf2e-abomination-vaults": {
      "version": "1.2.0"
    },
    "pf2e-beginner-box": {
      "version": "2.2.0"
    },
    "token-action-hud-core": {
      "version": "1.2.3"
    },
    "token-action-hud-dnd5e": {
      "version": "1.2.2"
    },
    "touch-vtt": {
      "version": "1.9.1"
    },
    "trs-housedivided-dice-set": {
      "version": "1.0.1"
    },
    "trs-metal-rainbow": {
      "version": "1.0.0"
    }
  },
  "systems": {
    "dnd5e": {
      "version": "2.1.5",
      "playtime": 25306
    },
    "pf2e": {
      "version": "4.7.2"
    },
    "worldbuilding": {
      "version": "0.7.2",
      "playtime": 0
    }
  },
  "worlds": {},
  "playtime": {
    "total": 129731,
    "max": 104425
  }
}
```

--------------------------------

### Install Homebrew Package Manager (macOS)

Source: https://foundryvtt.com/article/ssl

Install Homebrew on macOS to manage packages. This is a prerequisite for installing Certbot.

```bash
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
```

--------------------------------

### Install Node.js for Red Hat / Amazon Linux

Source: https://foundryvtt.com/article/installation

Installs Node.js version 20.x using the package manager for Red Hat-based Linux distributions. Ensure Node.js 20.18 or later is installed for compatibility.

```bash
sudo yum install -y openssl-devel
curl --silent --location https://rpm.nodesource.com/setup_20.x | sudo bash -
sudo yum install -y nodejs
```

--------------------------------

### Configure Demo Mode with a JSON file

Source: https://foundryvtt.com/article/configuration

Example of a separate JSON configuration file for demo mode, specifying world name, source zip, and reset interval.

```json
{
"worldName": "pathfinder-demo",
"sourceZip": "pathfinder-demo.zip",
"resetSeconds": 3600,
  }
```

--------------------------------

### Install Certbot on Fedora Linux

Source: https://foundryvtt.com/article/ssl

Install Certbot on Fedora Linux distributions using dnf.

```bash
sudo dnf install certbot
```

--------------------------------

### Install Certbot on Debian-based Linux

Source: https://foundryvtt.com/article/ssl

Install Certbot on Debian-based Linux distributions using apt.

```bash
sudo apt install certbot
```

--------------------------------

### Install Certbot on Arch-based Linux

Source: https://foundryvtt.com/article/ssl

Install Certbot on Arch-based Linux distributions using pacman.

```bash
sudo pacman -S certbot
```

--------------------------------

### Launch Foundry via Electron (Windows)

Source: https://foundryvtt.com/article/configuration

Example of launching the packaged Foundry VTT executable on Windows with specified port, world, and data path.

```bash
FoundryVTT.exe --port=30000 --world=my-world --dataPath=D:\FoundryVTT
```

--------------------------------

### Install Foundry VTT Software

Source: https://foundryvtt.com/article/installation

Download and unzip the Foundry VTT software into the application directory. Ensure you replace the placeholder URL with the actual download link.

```bash
cd foundryvtt
wget -O foundryvtt.zip "<foundry-website-download-url>"
unzip foundryvtt.zip
```

--------------------------------

### Install Certbot using Homebrew (macOS)

Source: https://foundryvtt.com/article/ssl

Install the latest version of Certbot on macOS using the Homebrew package manager.

```bash
brew install certbot
```

--------------------------------

### Semantic Versioning (Semver) Examples

Source: https://foundryvtt.com/article/intro-development

Shows the common Major.Minor.Patch format for Semver. Recommended for libraries, game systems, or CLI tools. Note: Pre-release notation (+/-) is not supported.

```text
1.0.0 -> 1.0.1 -> 1.1.0 -> 2.0.0
```

--------------------------------

### Launch Foundry via Node.js

Source: https://foundryvtt.com/article/configuration

Example of launching Foundry VTT using Node.js with specified port, world, and data path.

```bash
node main.js --port=30000 --world=my-world --dataPath=/local/data/foundryvtt
```

--------------------------------

### Install Caddy on Ubuntu/Debian

Source: https://foundryvtt.com/article/caddy

Installs Caddy stable version on Ubuntu or Debian-based systems using apt package manager.

```bash
$ sudo apt install -y debian-keyring debian-archive-keyring apt-transport-https
$ curl -1sLf 'https://dl.cloudsmith.io/public/caddy/stable/gpg.key' | sudo gpg --dearmor -o /usr/share/keyrings/caddy-stable-archive-keyring.gpg
$ curl -1sLf 'https://dl.cloudsmith.io/public/caddy/stable/debian.deb.txt' | sudo tee /etc/apt/sources.list.d/caddy-stable.list
$ sudo apt update
$ sudo apt install caddy
```

--------------------------------

### Basic "Hello World" JavaScript Module Script

Source: https://foundryvtt.com/article/module-development

A simple JavaScript example demonstrating immediate execution, initialization hook, and ready hook. Use the browser's developer console to observe the log messages.

```javascript
console.log("Hello World! This code runs immediately when the file is loaded.");

Hooks.on("init", function() {
  console.log("This code runs once the Foundry VTT software begins its initialization workflow.");
});

Hooks.on("ready", function() {
  console.log("This code runs once core initialization is ready and game data is available.");
});
```

--------------------------------

### Calendar Versioning (CalVer) Examples

Source: https://foundryvtt.com/article/intro-development

Demonstrates date-based versioning using CalVer. Recommended for user-facing packages. Note: Pre-release notation (+/-) is not supported.

```text
2022-01-01 -> 2022-02-20 -> 2022-03-12
220101 -> 20220220 -> 20220312
```

--------------------------------

### Launch Foundry via Electron (Linux)

Source: https://foundryvtt.com/article/configuration

Example of launching the packaged Foundry VTT executable on Linux with specified port, world, and data path.

```bash
foundryvtt --port=30000 --world=my-world --dataPath=/local/data/foundryvtt
```

--------------------------------

### Install Nginx on Amazon Linux 2

Source: https://foundryvtt.com/article/nginx

Run these commands to update your system and install Nginx version 1 on Amazon Linux 2.

```bash
sudo yum update -y
sudo amazon-linux-extras install nginx1 -y

```

--------------------------------

### Configure Demo Mode in options.json

Source: https://foundryvtt.com/article/configuration

Configuration for demo mode within the options.json file, specifying world name, source zip, and reset interval.

```json
{
	...,
	"demo": {
	  "worldName": "demo-world",
	  "sourceZip": "demo-world.zip",
	  "resetSeconds": 3600
	},
	...
  }
```

--------------------------------

### Example: Roll Five Twenty-Sided Dice

Source: https://foundryvtt.com/article/dice

This example rolls five twenty-sided dice and outputs the sum. Comments can be included to describe the roll.

```text
/r 5d20 #Rolls five twenty-sided dice, generating random numbers from 1 to 20, and outputting the sum of all rolls.
```

--------------------------------

### Linux Installation Archive Extraction

Source: https://foundryvtt.com/article/installation

Use this command to extract the Foundry VTT zip archive to your home directory on Linux. Ensure you have unzip installed.

```bash
unzip foundryvtt.zip -d $HOME/foundryvtt
```

--------------------------------

### Install Caddy on CentOS 7

Source: https://foundryvtt.com/article/caddy

Installs Caddy on Red Hat or CentOS 7 using yum package manager and enabling the Caddy copr repository.

```bash
$ yum install yum-plugin-copr
$ yum copr enable @caddy/caddy
$ yum install caddy
```
Tokens:
Raw