User Manual/Using Cloud and LAN features

From ScummVM :: Wiki
< User Manual
Revision as of 22:17, 17 September 2019 by Sev (talk | contribs) (Added libcurl to mingw-64 builds)
Jump to navigation Jump to search

Since ScummVM version 2.1.0, there are two new tabs in the Options dialog: Cloud and LAN (might be unavailable on some platforms).

NOTE: Currently supported builds from buildbot: debian-x86_64, mingw-w32, mingw-w64, osx_intel, ps3, psp2, switch. Other platforms are coming

In Cloud tab you can connect to a Cloud storage. That allows you to sync save games and download game files from your storage. Right now only Dropbox, OneDrive, Google Drive and Box are supported. You can connect one account in each of those, but only one storage could be active at the same time.

In LAN tab you can run a local webserver, which will be available in your Local Area Network (that is, all devices that are either connected to your router with cable or via Wi-Fi). Then you'll be able to access your device's files from another device using browser. That might be useful to move files between devices without connecting them to each other using any cables.


Connecting Cloud storage

In Cloud tab of Options dialog you can choose which provider to use. If you want to temporary disable Cloud-related features, you can select "<none>" there.

To connect ScummVM to selected Cloud storage,

  1. Open and select the provider you want (or simply press the button to open it in browser).
  2. Get a short code and enter it in ScummVM. For that, you'd need to confirm that you allow ScummVM to access your storage. If you copy the code, you can paste with the "Paste" button.
  3. Press "Connect" button.

After that storage will be connected. But, for security reasons, it will not be enabled yet. Your username and amount of used space will be shown in Options tab. If that information is correct, you can press "Enable storage" button, and only then ScummVM will start save games syncing and allow game files downloading. No files are downloaded to your device or uploaded from your device until you press "Enable storage" button.

ScummVM only works with its own folder in your storage and does not access any other files. Save games are kept in "saves" subdirectory.

ScummVM folder name
Dropbox Apps/ScummVM Cloud
OneDrive Apps/ScummVM
Google Drive ScummVM
Box ScummVM
Sync in progress

Cloud save games sync

ScummVM does save games sync automatically:

  • on launch;
  • when you save while playing (be it autosave, quick save or manual save);
  • when you open "Load Game" dialog;
  • when you press "Enable Storage" after connecting to storage.

You can also press "Sync now" button to do a sync.

While ScummVM works with your Cloud storage, it will be showing a fading cloud icon in the corner Add Game. Typically, it shows a "Save games sync complete" message when it is done.

ScummVM does not delete any files during the sync. If you delete a save game from your device, it will be downloaded from the Cloud. If you delete the file from the Cloud, it will be uploaded from your device. If you really want to delete a save game, you need to disable syncing and delete it from all your devices and from Cloud storage.

ScummVM overwrites save files with a newer version — that is, if you saved into the same slot, your newer save will be uploaded into the Cloud storage. Conversely, if the file is newer in the Cloud, it will be downloaded. If you accidentally selected the wrong slot, you might have a chance to prevent overwriting by stopping the sync via quitting ScummVM. Some Cloud storage providers also have a feature to switch between file versions, so you can do that outside of ScummVM and then sync to get the needed version back.

Download dialog

Downloading game files from Cloud storage

  1. Press "Download game files" button (not available for Google Drive).
  2. Select a directory to download. ScummVM can access anything in its own folder, so you can put your game files there.
  3. Select a directory on your device to download files into.
  4. Wait for files to download or press "Hide" to continue using ScummVM.

ScummVM will be showing a cloud icon in the corner while downloading and then show "Download complete" message when it is over.

If you don't hide the download dialog, ScummVM will automatically try to detect the game in the directory you downloaded files into. If game is detected, it will show you the usual game configuration dialog, which means you're ready to play!

Disconnecting Cloud storage

If you want ScummVM to logout from your Cloud storage, just press the "Disconnect" button in the Cloud tab. If you want to switch accounts for the same Cloud storage provider, you need to disconnect and then connect with another account.

Disconnecting won't deny ScummVM access on any other device, but on current device you'd have to connect again, if you'd like to use it. If you want to deny access completely, you should be able to do it outside of ScummVM in respective Cloud storage provider settings.


LAN tab with running server

Running a webserver

In LAN tab of Options dialog you can setup your webserver options. You can select a port for webserver to run on (the default one, 12345, is likely to be free) and specify a "root" directory. ScummVM will only give access to files under that directory.

Then you can press "Run server" to run the webserver and ScummVM will show the URL you can access this webserver with. It will stop automatically when you close Options dialog, and you can stop it manually with "Stop server" button.

File Manager opened in browser

Using webserver to upload and download files

Type the URL from the Options tab in the browser on another device, and you will see the Files Manager. In Files Manager you should be able to access your saves directory and your "root" directory (if you specified it). You can navigate through directories, create new ones using "Create directory" button, upload files with "Upload files" button and download files by clicking on their names.