@vttforge/testing / container / FoundryContainerOptions

Interface: FoundryContainerOptions

Properties

acceptLicense?

readonly optional acceptLicense?: boolean

You have read Foundry's licence agreement and accept it. Required. FOUNDRY_ACCEPT_LICENSE=1 in the environment does the same.

---

adminKey?

readonly optional adminKey?: string

Admin password for the setup screens. Default vttforge.

---

coreVersion?

readonly optional coreVersion?: string

Foundry major version the world declares. Default 14.

---

image?

readonly optional image?: string

Docker image. Default felddy/foundryvtt:14.

---

name?

readonly optional name?: string

Container name. Default vttforge-foundry. Two runs sharing one collide.

---

packages?

readonly optional packages?: readonly FoundryPackageSource[]

Packages to install before the world launches. One must be a system.

---

port?

readonly optional port?: number

Host port, used when the port has to be published. Default 30001.

---

volume?

readonly optional volume?: string

Named volume for Foundry's data. Default <name>-data.

---

wait?

readonly optional wait?: object

How long to wait on each step. Default 150 tries, 2s apart.

attempts?

readonly optional attempts?: number

everyMs?

readonly optional everyMs?: number

---

worldId?

readonly optional worldId?: string

Id of the world the run creates. Default vttforge-test.

---

worldTitle?

readonly optional worldTitle?: string

Title of that world. Default VTTForge test world.