Skip to content

Resource storage and disk management

The player chooses where downloaded server resources are stored. Client files have a separate location:

Content Location
Downloaded resources and their cache <storage>\resources
Client data, logs and crash dumps <storage>\projects\<projectId>
Client binaries and their download cache %LOCALAPPDATA%\revo\client
Saved storage and GTA paths %LOCALAPPDATA%\revo\installation.json

Display the storagePath and clientStoragePath returned by the helper.

When inspection returns storage_required, open a directory picker and save its absolute path:

Terminal window
.\client-helper.exe configure --storage-dir "C:\Revo\client-data"

Choose a dedicated, writable folder outside %LOCALAPPDATA%\revo. Paths that overlap that settings directory or contain links/junctions are rejected. The helper creates the selected folder if needed and checks write access before saving it.

Wait for configured, then inspect the selected server again. The Electron example already implements this initial folder picker.

Use the commands according to the action:

Action Command Effect
Choose a storage location configure --storage-dir PATH Save the path. Existing downloads stay in their previous location.
Move existing downloads move --path PATH Copy and verify managed files, switch the saved path, then remove the old copies.

If storage is already configured, use move for the launcher’s Move storage action. Running configure with a different path can require downloading the resources again.

Close clients using the storage and wait for any other helper operation to finish. Choose an empty destination folder, or a new folder that does not yet exist:

Terminal window
.\client-helper.exe move --path "E:\Revo\client-data"

The destination must be separate from the source and the shared settings folder. Drive roots, nested/overlapping locations and nonempty destinations are rejected.

A move covers the configured storage’s resources and projects directories, including downloads for other servers and saved logs. Client files remain in Local AppData. Unrelated files at the old storage root stay there.

The destination needs enough free space for a complete copy while the source still exists. This also applies when moving between folders on the same drive. The helper verifies copied files before changing the saved location.

During the copy, progress events have content: "storage". Use completedBytes, totalBytes and percent for the progress display.

Cancellation is available while copying. Send the usual cancellation command and wait for the terminal result, as described in Pause and resume. A cancelled copy keeps the original location active and removes its temporary copy when possible. Starting move again begins a new copy.

At status.stage: "activating_storage", cancellable becomes false. Disable the Cancel button and wait for the final event. Reaching 100% copy progress still requires this final step.

A successful result looks like this:

{
"protocolVersion": 1,
"event": "moved",
"storagePath": "E:/Revo/client-data",
"previousPath": "C:/Revo/client-data",
"copiedBytes": 1073741824,
"sourceCleanupPending": false
}

Update the displayed location from storagePath, then inspect the selected server again. If sourceCleanupPending is true, the verified destination is already active. Show that some old files remain at previousPath. Offer to open that folder for inspection, keeping in mind that it may also contain unrelated files.

Use inspection’s requiredBytes for the additional space requirement. It includes the reserve. Downloads may need space for both cached files and the prepared installation.

When the client and resources are on separate volumes, show clientSpace and resourceSpace separately. Their shortfallBytes identifies which drive needs space. Moving resource storage only changes the resource requirement’s drive. Display unknown (null) values as unavailable.

A move checks space again before copying. For insufficient_space, use the error’s details object (requiredBytes, freeBytes and shortfallBytes) to explain the shortfall. Let the player free space or choose another destination.

The helper reference describes the full disk-space response.

Offer Clean unused downloads using:

Terminal window
.\client-helper.exe cleanup

Successful preparation also runs cleanup automatically. Cleanup keeps current resource bundles, supported installed client versions and files still in use. Unused resource bundles, cached files and partial downloads become eligible for removal after seven days. Shared files stay while retained bundles need them. Data, logs and crash dumps remain in place.

Use the final cleaned event’s removedBytes to report the amount removed. A result of zero is valid. Missing dependency metadata can also cause old files to be retained.

For Remove downloaded resources for a specific project, use its public project ID:

Terminal window
.\client-helper.exe remove-project --project-id e04dc4c2-f622-4e41-9b12-2390c09b80c3

This removes known resource bundles for all servers belonging to that project and cached files no longer needed elsewhere. Client binaries, saved data, logs and crash dumps are preserved. The next preparation downloads any missing resources again. Completion is reported as project_removed.

Both cleanup commands work offline. Cancellation stops between removals, so files already removed stay removed. The command can be retried.

Keep these actions within the launcher’s existing single-operation flow:

Error Action
cache_busy Wait for the other helper operation to finish, then retry.
storage_busy Close clients using the affected files, then retry the move or removal.
invalid_storage Show the message and ask for a suitable destination.
storage_unavailable Check access to the selected drive and folder, then retry or choose another location.

Automatic cleanup can emit a nonterminal cleanup event containing an error. Continue reading until the preparation or launch result before deciding whether the overall operation succeeded. Explicit cleanup failures use the terminal error event.