How to update Foundry VTT on The Forge

Documentation Foundry
, , ,
1

Introduction

In this article we explain how to prepare for, and update Foundry VTT. We will also explain how to downgrade, if needed.

Want more information about Foundry’s release schedule/system? Foundry Gaming explains it here: Versioning and Releases | Foundry Virtual Tabletop.

Upgrading to V12

V12 is now recommended on The Forge, and has worked well for the vast majority of users. Still, we warn users of the following potential issues.

One-Way Upgrade

Users upgrading to V12 should note that updates to V12 are one-way, and the content cannot be downgraded into an earlier version once it has been migrated. In other words, before updating BACKUP YOUR CONTENT. ONLY YOU CAN PREVENT DATA LOSS. We have a guide for backing up your data below.

Common Module Problems

Drag Ruler

Drag Ruler is not updated for V12 and will create significant issues within worlds where it is enabled. If you have Drag Ruler enabled on V12, disable it immediately, and we recommend uninstalling the module at this time.

MidiQOL

MidiQOL is a popular module for D&D 5e on Foundry, and introduces a dizzying amount of automation options and other quality of life features befitting the module’s name.

However, MidiQOL is currently not updated for the latest version of D&D 5e compatible with Version 12 of Foundry VTT, as of the time of this writing (November 1st, 2024). Users who require this module and its functionality for their games will need to avoid updating to versions of D&D 4.x, or temporarily switch to a module with similar functionality like Ready Set Roll for 5e.

Preparing to Update

We recommend taking the following steps whenever updating your version of Foundry VTT on The Forge.

1. Make sure your game systems work with the update

There is no guarantee that a game system will continue to work after updating Foundry VTT. When updating, we recommend verifying that there is a system version compatible with the Foundry VTT version that is being updated to.You can look up your game system, and verify their compatibility here.

2. Make sure important modules work with the update

Many users rely on modules as an important aid to their Foundry gaming experience. And just like systems, there is no guarantee a module will continue to work after updating Foundry VTT. You can check to see if there is an update for the module compatible with the new Foundry VTT version here.

3. Back up your data outside of The Forge!

There’s a lot that can go wrong when updating. By making a backup outside of The Forge, you can restore your content more easily, in the event of something breaking.

Follow these steps to back up game data (Without Game Manager):

  1. Login to The Forge, if you are not already logged in.
  2. Navigate to your My Foundry page, on the top bar of the website.
  3. Select the grey “Export Worlds” button under Game Tools, as shown below:
    firefox_k2qEgucZli
    firefox_k2qEgucZli1228×159 25.9 KB
  4. You will be shown a menu with every world, as well as a blue “Export All” button. Click the blue “Download” cloud button for the worlds you want to want to download. It should automatically export that world as a .zip file for you to download. If you wish to download every world, select “Export All”.
    firefox_mN6W8OQHr7
    firefox_mN6W8OQHr7794×684 41.4 KB
  5. Save these world files somewhere safe! The Forge recommends constant backups- but it is especially important while updating!

Follow these steps to back up game data (With Game Manager):

  1. Login to The Forge, if you are not already logged in.
  2. Navigate to your My Foundry page, on the top bar of the website.
  3. Select the world you wish to backup.
  4. Select the grey “Export World” button under Game Tools, as shown below:
    firefox_FUk88dhyE0
    firefox_FUk88dhyE01229×195 31.9 KB

    It will automatically export that world as a .zip file for you to download.
  5. If you wish to download every world, navigate to the Game Manager button, and select it.
    firefox_UDSDyX6UHx
    firefox_UDSDyX6UHx1230×263 36.2 KB

    You should see the following change to the Game Tools menu:
    firefox_hbMdZCgRZv
    firefox_hbMdZCgRZv1230×159 29.4 KB
  6. Select the grey “Export All Worlds” button. It should automatically export every world as a .zip file for you to download.
  7. Save these world files somewhere safe! The Forge recommends constant backups- but it is especially important while updating!

Backing up Compendium Modules

The Forge supports exporting custom/user created compendium modules. Modules in the default package listing of Foundry VTT must be re-downloaded outside The Forge.

Want to download Bazaar content? We explain how to do so here.

How to backup compendium modules :

  1. Login to The Forge, if you are not already logged in.
  2. Navigate to your account’s My Foundry page.
  3. Select the grey “Export Compendium Modules” button to the left.
    image
    image1232×165 29.6 KB
  4. Select the module in question to be exported. You will then begin downloading the compendium module.

Updating Foundry VTT

Make sure you’ve followed the best practices laid out in the previous section. The Forge is not responsible for any data loss as a result of user error. Updating without following the previous steps can result in game data destruction, world loss, and other campaign-ending consequences.

Updating (With Game Manager)

To update Foundry VTT, complete the following steps:

  1. Login to The Forge, if you are not already logged in.
  2. Navigate to your My Foundry page, on the top bar of the website.
  3. Select the Game Manager button.
    firefox_UDSDyX6UHx
    firefox_UDSDyX6UHx1230×263 36.2 KB
  4. Under the “Select the default Foundry VTT Version for your games” drop-down menu, select your preferred version of Foundry.
    image
    image1495×184 25.7 KB
  5. All worlds should now be updated to use that version of Foundry, unless you have chosen a separate Foundry version per-world (not recommended). If you have selected a different version per-world and wish to update that world, follow the instructions below.
  6. Restart any servers that are currently active for these changes to take effect (If you are still uncertain about updating, this is your last chance to revert the update. If the server is already offline, it is too late.)
  7. Your Foundry version has now been updated. Make sure to update your systems and modules before checking out the new features!

Updating (Without Game Manager)

To update Foundry VTT, complete the following steps:

  1. Login to The Forge, if you are not already logged in.
  2. Navigate to your My Foundry page, on the top bar of the website.
  3. Navigate to the bottom of your Foundry server page.
  4. Under "Foundry VTT Server Version, select your preferred version.
    image
    image1182×198 18.9 KB
  5. At the bottom of the page, it will state “You have unsaved changes to your game configuration.” If you are certain that you are ready to update, select “Save Changes”. Otherwise, select “Reset Changes”. Once you select “Save Changes”, the Foundry version will be updated.
  6. if the server is currently online, stop the server for these changes to take effect (If you are still uncertain about updating, this is your last chance to revert the update. If the server is already offline, it is too late.)
  7. Your Foundry version has now been updated. Make sure to update your systems and modules before checking out the new features!

Updating Per World (With Game Manager)

With Game Manager enabled, you are able to selectively update worlds to different versions of Foundry. The Forge recommends against doing this, owing to potential system and module conflicts that can occur with different-versioned worlds. If you wish to proceed regardless of these warnings, complete the following steps:

  1. Login to The Forge, if you are not already logged in.
  2. Navigate to The Bazaar, at the top bar menu.
  3. Select the world you wish to update.
  4. Navigate to the bottom of your Foundry server page.
  5. Under "Foundry VTT Server Version, select your preferred version.
    image
    image1181×215 22.1 KB
  6. At the bottom of the page, it will state “You have unsaved changes to your game configuration.” If you are certain that you are ready to update, select “Save Changes”. Otherwise, select “Reset Changes”. Once you select “Save Changes”, the Foundry version will be updated.
  7. if the game is currently online, stop the server for these changes to take effect (If you are still uncertain about updating, this is your last chance to revert the update. If the server is already offline, it is too late.)
  8. Your Foundry VTT version has now been updated on this world.

Updating Systems and Modules

After updating Foundry VTT, you need to update your systems and modules. To update this content, follow the steps below:

  1. Login to The Forge, if you are not already logged in.
  2. Navigate to The Bazaar, at the top bar menu.
  3. Navigate to your Has Update filter. You can navigate there via the hyperlink, or by selecting “Has Update” within menu to the left on The Bazaar.
  4. Here, you should see the following display on the top left:
    image
  5. Select the green “Update All Packages” button
  6. Finally, select the green “Update All” button in the popup menu.
    image
    image785×1043 90.1 KB
  7. Your modules and systems should now be updated. You are free to begin enjoying your new version of Foundry Virtual Tabletop!

Downgrading Foundry VTT

The Forge does not recommend downgrading Foundry versions, unless upgrading has created serious issues in your worlds. We strongly recommend restoring from a world backup after downgrading. For downgrading from V12 this is mandatory, as worlds will not function after being migrated to V12.

When downgrading a world, The Forge cannot guarantee survival of world, game, or content data. As with upgrading, backup these worlds in case something goes wrong.

To downgrade your content on The Forge, complete the same steps you took while upgrading. However:

  • When selecting a Foundry version, select your preferred downgraded version.
  • Complete the usual steps from there.
  • “Update” your systems and modules through The Bazaar, to revert them to a version compatible with the older version of Foundry VTT.

If you followed the best practices above, you should have backups of your worlds from before updating. Upload them via the summon import wizard after downgrading Foundry VTT. Overwrite the existing worlds via the prompt it gives you. Your worlds should now be restored to their previous functionality.

If you did not backup your worlds before upgrading, you will have to downgrade your existing worlds, and verify that each world has survived the downgrade with its content and data intact. If the world is corrupted by the downgrade, you will now need to upgrade Foundry back to its upgraded version, and then import the pre-downgraded backups.

If you world data is corrupted after this process and you have no backups to restore from, you will need to contact Forge Support. Unfortunately, The Forge cannot guarantee:

  • Success in restoring your worlds.
  • Timeliness in restoring your worlds.
  • The version of the world that is restored (you may lose several days, or even weeks worth of work).

As they say on the Foundry VTT Discord, only you can prevent data loss.

1 Like