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.
- When to Update?
- Update Verge3D Installation on Windows
- Update Verge3D Installation on macOS/Linux/ChromeOS
- Update Applications
- After Update
- Known Issues and Troubleshooting
When to Update?
Subscribe to the official announcements forum or Soft8Soft's social media to get notified about Verge3D development progress and new releases.
Also, if you notice a small orange dot near the i icon in the App Manager, this means that a new stable version of Verge3D is available for download.
Click on the i icon to display the About Verge3D dialog with information about new update:
Update Verge3D Installation on Windows
Simply download and install the latest Verge3D distribution in a folder with the same name (that is, "C:\Program Files\Verge3D_for_Blender").
Update Verge3D Installation on macOS/Linux/ChromeOS
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
Updating Verge3D installation does not bring new features to the existing applications. For these you should perform some additional steps.
Method #1 (Automatic) — use the update feature
After you completed updating Verge3D installation, relaunch App Manager. Your app should appear in the list with the round arrow button in the operations column (reload the page if not). Click on that button to start updating the app.
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 of the Verge3D installation folder, namely, Verge3D runtime v3d.js and optional modules:
- opentype.js — enabled by the Font Converter checkbox in the app creation panel.
- basis_transcoder.js, basis_transcorder.wasm — enabled by the Texture Decompressor checkbox in the app creation panel.
- ammo.wasm.js, ammo.wasm.wasm — enabled by the Physics checkbox in the app creation panel.
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 (located in Verge3D installation 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.
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.
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 your applications directory). 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
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!