Installing and Updating

Installation

Installing Blender

Authoring 3D scenes is carried out directly in Blender which is open source software and is distributed free of charge.

Before installation, please download and install the compatible Blender version, according to this table.

A current stable version of Blender should be used. It can be downloaded from the official site or from Blend4Web site.

_images/blender_first_run.png

Unpacking the Archive

Stable versions of the distribution are available as an archive (blend4web_ce_YY_MM.zip – free SDK, blend4web_pro_YY_MM.zip – commercial SDK). Simply unpack this archive somewhere.

Installing Blend4Web SDK

  1. Run Blender.

  2. Open the User Preferences panel File > User Preferences....

  3. Open the File tab.

  4. Set the path to the SDK directory in the Scripts field.

  5. Click the Save User Settings button.

    _images/user_preferences_sdk_path.png
  6. Restart Blender.

  7. Once again, open the User Preferences panel File > User Preferences....

  8. Open the Add-ons tab.

  9. Enable the Blend4Web add-on.

  10. Once again, click the Save User Settings button.

    _images/user_preferences_enable_addon.png

To verify it worked:

In the File > Export menu, the Blend4Web (.json) and Blend4Web (.html) options should appear.

Note

If you are planning to use only the normal editor, you might consider installing the Blend4Web addon instead of the SDK.

The addon can only export scenes to HTML format and has limited functionality (for example, it doesn’t have the project manager, example scenes, user manual and so on), but still it has everything you might need to create a simple application.

It can be installed the same way as any other Blender addon.


Switching to Blend4Web Mode

To reveal the engine settings, select Blend4Web from the upper panel menu:

_images/first_steps_selecting_engine.png

Updating

Updating the SDK

Before updating, we recommend to backup all projects in development using the project export tools.

To update the SDK, follow these steps:

  1. Download the new version of the SDK.

  2. Run Blender.

  3. Open the User Preferences window.

  4. Open the Add-ons panel.

  5. Disable Blend4Web Add-on.

    Note

    We recommend not to use the Remove button to disable the Add-on for updating the SDK, as doing so will completely delete the add-on, including its files in the SDK.

  6. Unpack the new version of the SDK from the archive.

    Note

    There are two methods to do this.

    Firstly, you can completely delete the SDK folder and, after that, extract the new version folder, as if you were installing the SDK for the first time.

    Secondly, you can simply overwrite the outdated SDK files with the new ones. This method is considered less “pure”, but in most cases it should not cause any problems.

  7. Open the File panel in the User Preferences window.

  8. Set the path to the SDK folder in the Scripts field.

  9. Press the Save User Settings button.

  10. Restart Blender.

  11. Open the User Preferences window once again.

  12. Open the Add-ons panel.

  13. Enable Blend4Web add-on.

  14. Press the Save User Settings button once again.

  15. Check if everything works correctly.

After updating is complete, you can import all saved projects using the project import tools.

Updating the Addon

If you are only using the Blend4Web add-on, follow this instruction instead.

Before installing a new version of the add-on, you may firstly remove the existing one. To do this, unfold the information tab of the Blend4Web addon and press the Remove button. Removing the old version is not required before installing a new one, but doing so makes sure there won’t be any coflicts.

_images/user_preferences_remove_addon.png
  1. Download the archive that contains the new version of the add-on, and save it to any place on your hard drive.
  2. Run Blender.
  3. Open the User Preferences window.
  4. Switch to the Add-ons panel.
  5. Install the new version of the add-on from the archive you downloaded.
  6. Press the Save User Settings button.
  7. Restart Blender.

Everything should be working now.

Updating Saved Projects

After you have updated your SDK (or Add-on), you can import projects that you exported before updating back to the Project Manager. To do this, follow the following instructions:

  1. Open Project Manager.
  2. Import your projects using the Import Project(s) button.
  3. Reexport projects’s .blend files using the re-export scenes link.
  4. Use the check modules link for every imported project to make sure there are no missing or unused modules in the program code. If there are, you may try to fix the poblems using the Update Modules button.
  5. Then use build command to make the build versions of the imported projects work again.
  6. The developer version of the projects using Copy or Compile engine binding type should also be build to properly work with the new version of the SDK (the developer versions of the projects with other bindning types should work fine without it).