The Forge regularly backs up all user data, but due to the (current) extreme difficulties and costs to restoring individual user data, we can only restore lost user data in the event of a service-wide catastrophe on The Forge.
It is every user’s responsibility to back up their own data. Although it is rare, software bugs, user error, or even accidental deletion can devastate a world/campaign permanently! It is extremely important to be prepared for this, and to back up your content regularly. Fortunately, we make it easy here at The Forge.
WARNING: Media files are not automatically exported with your Foundry VTT worlds. If you need to backup your media files outside of The Forge, make sure to read the following section of this guide.
To export and backup your Foundry worlds, you will need to take the following steps.:
Login to The Forge, if you are not already logged in.
Navigate to your account’s My Foundry page.
From here, the steps differ depending on if Game Manager is enabled or not.
Without Game Manager Enabled
- Select the grey “Export Worlds” button under Game Tools, as shown below:
- You will be shown a menu with every world, as well as a blue “Export All” button. Select the worlds you 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”.
- Extract these worlds into your personal (non-Forge) Foundry VTT instance, and make an additional backup somewhere safe! This last step is very important, if you wish to retrieve your images properly as well!
- Restart this non-Forge Foundry VTT instance if it is currently online, and confirm that the worlds are displaying properly in the setup menu.
With Game Manager Enabled
- Select the world you wish to backup.
- Select the grey “Export World” button under Game Tools, as shown below:
It will automatically export that world as a .zip file for you to download.
- If you wish to download every world, navigate to the Game Manager button, and select it.
You should see the following change to the Game Tools menu:
- Select the grey “Export All Worlds” button. It should automatically export every world as a .zip file for you to download.
- Store these zip files somewhere safe, where you’ll be able to find them! Since most world exports are small, we recommend uploading them to the cloud.
(Optional) Extract the zip file containing your worlds into your personal (non-Forge) Foundry VTT instance, in the
worldsfolder of your Foundry user data.
- (Optional) Restart this non-Forge Foundry VTT instance if it is currently online, and confirm that the worlds are displaying properly in the setup menu.
Backing up your worlds is as easy as that! Taking the extra time to backup your worlds after each session can mean the difference between losing weeks or even months of progress, or only experiencing a few minutes of inconvenience!
While we offer the ability to export your assets library out of The Forge, this is not as necessary as backing up your worlds. Unlike world data, data in the Assets Library is usually endangered only by accidental deletion. That said, we offer easy backing up of image data via our Asset Sync. By running our Asset Sync, it will automatically download all your asset library files from The Forge into your Foundry installation. It will also make restoring missing assets easier.
You can run the Asset Sync by taking the following steps:
- Ensure that any worlds extracted into your personal Foundry installation are showing up within the setup menu, and load correctly .
- Install The Forge module on the Foundry VTT installation with your worlds. This can be done via the traditional Foundry package browser, or via manifest URL installation.
- Keeping your personal Foundry VTT installation open in another window/tab, navigate to your My Account page on The Forge.
- Navigate to the “User Profile” section of the page.
- Select the grey “Open API Key Manager” button.
- You should be shown a popup menu. Select the blue “Generate New Keys” button.
- Copy this API key.
- From here, navigate back to your personal Foundry installation.
- Login to a world (any world) and enable The Forge module.
- In the “Game Settings” tab to the right-hand side, select “Configure Settings”.
- Navigate to the “Module Settings” tab in the popup menu. Scroll down until you find The Forge module.
- Under the “API Secret Key” field, paste the API key copied earlier in step 7.
- Click the “Save Changes” button.
- Open the “Configure Settings” popup menu again, and scroll down to The Forge once again.
- Select the “Open Asset Sync” button. You should get the following popup:
- (Optional) Select the “Update Foundry World & Compendiums to use Local Assets” checkbox. This will forcibly sync any images downloaded to the referenced images in each of your worlds.
- Click the Sync button. This will begin the Asset Sync. This may take anywhere from several minutes, to several hours- we do not recommend closing the Foundry instance during this time.
- After the Asset Sync completes, check your user data folder. If the images are now showing up in that folder, the asset sync was successful!
Of course, a backup is useless if it isn’t usable. We explain how to restore your content below.
We make it relatively easy to restore a world backup on The Forge- it’s just as easily as uploading existing Foundry VTT content when joining our service.
Steps to restore a world/your worlds:
Navigate to your My Foundry page.
Here, you have two options. You can restore a world backup from the exported zip file, or from your local Foundry
worldsfolder, if you have extracted your backup here. If you are restoring a Foundry world from a zip, select the blue “ZIP File” button. If you are selecting a Foundry world extracted from the backup, select “Local Folder. Please note that you can also select multiple Foundry worlds at once, following either process!
Drag the zip file/folder to the “Choose File” field, as appropriate.
Select the blue “Analyze Files” button at the bottom of the Import Wizard menu.
The Forge will analyze what you have uploaded, and show a preview of what it found. Usually, this will include the worlds you have backed up, and any other content bundled with them. Make sure you have selected the appropriate worlds at this point.
Select the blue “Import Selection” button. The Forge will begin importing this content (this may take a few minutes).
You will eventually be prompted with a menu stating that “World already exists”. If you are importing multiple world backups, you will be prompted for each world. The Import Wizard prompt will describe the existing world and state that it cannot continue import without confirmation. If you are certain you have chosen the correct backup, enter the overwrite code provided. Warning: Make sure you are overwriting with the correct backup at this point. Once you have overwritten your world, it will be completely and irrevocably deleted, and replaced with your backup.
Select the red “Overwrite (world name here)” button. This is the last chance to cancel the backup restoration, if you change your mind here.
You will be brought back to the importing content menu, where it will display the progress of the overwrite. Eventually, it will finish retrieving the content, and re-importing it. Select the blue “Finish” button once it is done.
After following these steps, the worlds should now appear like they did from their last backup. Make sure to log into each world that has been restored, and verify that everything works correctly! If something is not working correctly, we recommend reaching out to Forge support via Discord, or via email at email@example.com.
Restoring your assets backup is a similar process to restoring your worlds from a backup- but fortunately, with far less opportunity to permanently damage your ongoing worlds/campaigns.
Please note that restoring assets like this will only work if you have run the asset sync. If you have not, you will have to manually track down each media file you have uploaded to The Forge and are using, and upload it with the correct name, and file location manually. Needless to say, we do not recommend doing it that way.
Steps to restore missing assets:
Navigate to your My Foundry page.
Select the blue “Summon Import Wizard” button.
Select the blue “Local Folder” button, to the left.
Datafolder from the Foundry instance that you have backed up your assets to, via the asset sync. Drag it into the “Choose Folder” field.
Select the blue “Analyze Files” button at the bottom.
Select the blue “Import Selection” button, to the right.
Let it begin importing. It will automatically place that content in the correct folders on The Forge.
Each time that it tells you that the world already exists, select the “Cancel” button (recommended, unless you wish to overwrite your existing worlds).
The Import Wizard should automatically import each asset, without overwriting existing worlds.
(Optional) Navigate to your Assets Library or browse your Assets Library in game, and confirm that the media files are restored.
After following these steps, your Assets Library should now contain the assets from your backup, without importing duplicate images (unless you have edited them since backing them up).