Guide

Interacting with Your World

Creating

You create a new mill by clicking on the "+ Mill" link on your mills page. This will take you to a form where you can specify the following details:

  • The name
  • The foundry version (from a drop-down of available versions)
  • The admin password for your foundry instance
  • A Foundry license key
  • S3 storage details (key, secret, region, endpoint)

Choose your name carefully. Once you have picked it, you can't change it. The only way to alter your name is to delete your mill and create a replacement with the new name.

If you want advice on naming your mill, consider that it's the destination for all the games that you will want to play. You can (and probably will) run many Foundry worlds with perhaps different games systems from the same mill, so it's best not to name the mill after a single world or game type. It's best to think of something that represents you.

The password, license and S3 details are all optional. You should change your password, else you will get a default value which would make it easy for anyone to access your mill. If you don't specify a license key, then you must enter one manually when you first access your mill. S3 details are used to configure your mill with S3 access from within Foundry. If you don't have S3 storage, then feel free to ignore these fields.

When you press Confirm, assuming you still have subscription capacity to create more mills, your mill will be created, configured and deployed. This will take approx 2 minutes. Your new mill will be accessible at: https://<millname>-mill.worldmill.online.

Updating

If you click on the "admin" link on your mill, you'll be taken to the admin page where you can interact with and update your mill. You can modify the following:

  • The foundry version (from a drop-down of available versions)
  • The admin password for your foundry instance
  • Your Foundry license key
  • S3 storage details (key, secret, region, endpoint)

From this page you'll also be able to:

  • Backup your mill's data
  • Restore your mill from the existing backup
  • Download the backup of your mill to your computer
  • Delete your mill

If you have modified details, this will cause your mill to be re-deployed. If you change your Foundry license, you will need to accept the Foundry EULA again.

Deleting

If you click on the "edit" link on your mill, you are taken to a form where you can edit details relating to your mill or delete it. Once you delete your mill, you can no longer access it, so be sure you have backed-up or copied any assets before deleting.

Running

For efficiency reasons, we shut down your mills when they have been inactive for an hour (defined as "no network traffic received in the previous hour"). Nothing special is required to awaken your mill. When network traffic is received from a user, for instance yourself or one of your players, then we'll provision your mill and start it running. This usually takes a minute or so, but may take longer when our systems are very busy.

For the best experience with Foundry/Worldmill, make sure to configure your foundry with a default world using the normal Foundry default world configuration mechanism before launching a world. If you do this, then this mill will be started automatically as usual with Foundry when your mill starts. This means that a player can access the mill without requiring any interactions from the gamemaster.

Up/Down Loading my Content

Each deployed mill supports direct access to configured Foundry data at the address: https://<millname>.worldmill.online/worldmill. This address is running a webdav server, so any webdav aware client, such as Cyberduck or WinSCP, can be used to copy data to/from this location. Your username is "worldmill" and your password is the same as the password you specifed for admin use when creating your mill.

There are some steps to follow when copying data to/from your mill.

Firstly, Your mill must be running before you can load data into or save data from it. You can wake it up with any network traffic. For instance, trying to send/receive data will itself cause your mill to wake up if it is currently asleep.

Secondly, Foundry will not recognise that data has changed if you copy data into the world. You must cause Foundry to restart. You can do that using the "restart" button on your worlds screen. This button is only active if your world is currently running.

Cyberduck Instructions

Start Cyberduck and click on "Open Connection" in the "Open Connection" dialog box

Enter the following details:

  • WebDAV (HTTPS)
  • Server: <your mill name>-mill.worldmill.online
  • Username: worldmill
  • Password: <your password>
  • Path: /worldmill

In order to enter "Path" details, look further down the dialog box and expand the "More Options" arrow if it isn't already expanded.

You can leave other settings as they are. Now click "Connect". You should now be connected and will have a view of your mill which is based in the "Data" sub-folder. You can now upload/download into the modules, systems, worlds, directories as you like.

WinSCP Instructions

Start WinSCP, in the Login dialog choose "New Site".

Enter the following details:

  • File Protocol: WebDAV
  • Encryption: TLS/SSL Implicit encryption
  • Host name: <your mill name>-mill.worldmill.online
  • Username: worldmill
  • Password: <your password>
  • Remote directory: /worldmill

In order to enter "Remote directory" details, click on the "Advanced" button, select "Environment/Directories" from the tree dialog on the left hand side of the screen. Click Ok to return to the "Login" dialog.

You can leave other settings as they are. Now click "Login". You should now be connected and will have a view of your mill which is based in the "Data" sub-folder. You can now upload/download into the modules, systems, worlds, directories as you like.

General Up/Down Loading Notes

Both Cyberduck and WinSCP are general purpose file transfer tools and I've only scratched the surface of how to connect using them. If you want to know more about these tools I suggest reading documentation available on the internet. There's a lot of good quality information out there.

There are also a lot of other tools. If you are happy using a command line, then I recommend taking a look at rclone. It runs on most platforms and is very fast out of the box without tweaking for speed.

It can take a long time to transfer details between your computer and your mill. You can transfer anything you like, so I'm not going to be prescriptive here, but generally, it makes more sense to use Foundry VTT on your mill to install Systems and Modules, and then use Cyberduck/WinSCP/etc... to transfer other contents (e.g. Worlds). You can install the same Systems/Modules on your own computer, just don't copy them onto your mill.

This is because, when you install directly to your mill from the source via Foundry you will have two big computers talking to each other across fat pipes. This isn't necessarily the case when you interact with your mill from your home.

To give you some idea, you should expect about a 20/80 split between "your" data and data installed as Systems + Modules. So, if you are using 10Gi of space, 8Gi of that doesn't need to be transferred between your home computer and your mill. That can represent a big time saving when transferring data.

Backup

You can back-up your content on demand to our backup system. There is a backup button for each mill and you backup each mill individually. Backing up data will take some time, so you can't trigger another backup for the same mill whilst one is executing. You can download this backup archive at any time whilst you have a subscription with us.

Restore

You can restore your backed-up content on demand to your mill. There is a restore button for each mill and you restore each mill individually. Restoring data will take some time, so you can't trigger another restore for the same mill whilst one is executing.

Backup/Restore Notes

Backup/Restore is a convenience mechanism. You have the choice to use our automated full backup/restore mechanism or you can backup to your own storage (as much or as little as you like) and restore (again as much or as little as you like) from your own storage to your executing mill.

Backup or Restore will terminate an executing mill and prevent it from restarting until the operation completes. For this reason, make sure to only Backup/Restore when your mill is not being used to run a game.

We do this to prevent corruption of the backup due to file contents changing during the backup operation. Terminating your mill means that when a restore is performed Foundry will see the changes as soon as it starts executing without requiring a restart.

During a Backup/Restore you cannot interact with your mill. If you try you will see a 502 Bad Gateway error. Once the operation completes, normal service will be resumed. This is a safety measure to ensure no-one accidentally interacts with your mill whilst this admin process is executing.