Skip to content

Getting Started

To get started using Worldbuilder, please follow these steps:

  1. Check the module's requirements
  2. (Not required for the demo) Link your Patreon account to your Foundry account
  3. Install and enable the module
  4. Configure the module
  5. Follow the quick start guide to familiarize yourself with the basics of Worldbuilder
  6. Learn more about the Worldbuilder application, articles, tags and settings

Requirements

To get Worldbuilder to work, you need:

Linking a Patreon Account

Linking your Patreon account is not required for the demo, continue to Module Installation.

Worldbuilder is a premium module that requires a subscription to the Material Foundry Patreon at the 'Material Apprentice' tier or higher.
As a patron you can gain access to the module by linking your Patreon account to your Foundry account:

  1. Log in on the Foundry VTT website
  2. Edit your profile here
  3. Link your Patreon account at the bottom of the page if you haven't already
  4. Verify that Worldbuilder shows up under your subscriptions. If it doesn't appear as expected under the "Subscribed Content" page of your user profile, you may need to refresh your Patreon link

Module Installation

Full Version

If you've subscribed to the Material Foundry Patreon at the correct tier and linked your Patreon account to your Foundry account, Worldbuilder should show up in Foundry's module browser if you search for Worldbuilder. Make sure you do not install Worldbuilder Demo. See here for more info on installing modules.

Demo Version

The demo version is available for free to everyone and can be installed through Foundry's module browser, seach for Worldbuilder Demo. See here for more info on installing modules.

Module Configuration

After installing and enabling Worldbuilder, you might have to do some configuration before you can start using the module.

User Permissions

Unless your server is on the Forge (see here for more info for Forge users), users will not need extra user permissions to view Worldbuilder articles (besides the article's ownership settings). However, to create or edit articles, your users will need the "Upload New Files" permission.

This permission is usually enabled for all user roles, except for "Player". If this is the case, Worldbuilder will detect this and show a popup where you can change these settings.
You can also change them by going to the "Game Settings" sidebar tab, clicking "Configure Settings", and then "Open Permission Configuration".
It is not required to grant this permission if you do not want specific user roles to be able to create or edit articles.

The Forge

Due to the way the Forge handles user data, there are some things you have to do if you want your players to have access to your Worldbuilder data.
If you do not do this, your users will not see any articles.

Forge Configuration

  1. Make sure you run Worldbuilder at least once
  2. Log into the Forge and go to your Assets Library.
    There should be a "worldbuilder" folder, if not, go back to step 1
  3. Hover over the "worldbuilder" folder and press the button, which opens a popup
  4. Set Permissions to "Read Assets, Write Assets"
  5. Set "Key name" to a name that's unique to your world. If you leave it set to "worldbuilder" and one of your players play in another game that uses Worldbuilder, there might be file conflicts. Something like "worldbuilder-[gameName]" could work
  6. Click "Share Folder"
  7. Let your players log into the Forge, then send them to the link.
    Tip: If you've previously made an API key, you can find the Share Url here
  8. Open Worldbuilder, go to the settings tab
  9. Under "Data Management" you will find "Forge Key Name" (if you're the GM), fill in the "Key name" used in step 5

You should be ready to go!