Updating for New Versions

Verge3D is being actively developed with software releases occurring regularly. There is also the pre-release channel of updates with new versions coming out even more often. We recommend you to keep in pace with the development cycle and timely update your Verge3D distribution and applications.

Update Verge3D Installation

Backup your current Verge3D folder by renaming it (from "verge3d" to "verge3d_old", for example).

Download and unpack the latest Verge3D bundle in a fresh folder with the same name (that is, "verge3d").

By using the same name for the fresh folder you can avoid re-configuring paths in the 3D editor of your choice.

Update Applications

Method #1 (Automatic) - use the update feature

Simply copy the entire folder with your application to the applications folder of the fresh Verge3D installation. After launching the App Manager, your app name should appear in the list of apps (reload the page if not). Click the update button with the round arrow on it.

In the window shown up, select the template files you'd like to overwrite. You can safely select everything if you didn't edit the files. If you modified the files, be sure to backup them first so that you can cherry-pick the changes back later, and only after that proceed with overwriting.

Under the hood, this operation overwrites the engine modules by the files from the /build folder, namely, Verge3D runtime v3d.js (or v3d.legacy.js if you used the IE 11 checkbox in the app creation panel) and optional compatibility modules:

If you choose so, this operation will also overwrite the selected HTML/CSS/JavaScript files and the icons folder media by the files from the /manager/templates/template_name folder.

Upon updating, App Manager will save older versions of your files in the app's v3d_app_data/update_backup directory with a time stamp added. This allows you to restore any of the previously saved revisions of your app files when you need them. Simply copy a file back to the application folder root and remove the time stamp from its name.

Method #2 (Clean) - re-create your app from scratch

This is an alternative method of updating where you are in full control of your files. You can use it to get rid of obsolete files or if for some reason the automatic update method is not applicable.

To perform clean updating, in the App Manager type the name of your app in the "Create new App" window and click "Create App" button.

Copy Blender/Max/Maya scene files, all the textures/sounds, and the Puzzles scenario file visual_logic.xml from your old app folder to the newly created app folder (located within verge3d/applications). Overwrite files when you're asked so. If you were using HTML-based UI in your app, copy all relevant files as well.

Finally, you should perform exporting to glTF so that the exported format receives the latest updates. If you were using Puzzles in your app, you'll need to re-save your scenario in the Puzzles editor so that the generated code matches the newest version of the engine.

If you changed anything in your application's .html, .css or .js files, be sure to backup them first so that you can cherry-pick the changes back later.

After Update

Restore Puzzles library

If you were adding new entries in the Puzzles library, you can restore it after updating by copying the file /puzzles/library.xml to the fresh installation folder and overriding the old file.

Re-activate your license

You should enter the license key each time you update to a new version, otherwise your apps may render the trial watermark when running.

Known Issues and Troubleshooting

On rare occasions the Puzzles button can disappear for your app in the App Manager. Please perform clean updating to fix this.

On rare occasions the Puzzles editor may fail to load after updating. Please reset your browser settings to fix this.

If after updating some feature got broken, please report this on the forums so that we can investigate the problem and issue a correcting release.

Got Questions?

Feel free to ask on the forums!

© Soft8Soft – 3D Solutions for the Web
Last updated on June 27, 2022