Upgrading Bolt

Contents

This is the step-by-step process of upgrading Bolt:

Upgrading To Bolt 1.2.9 Or Newer

  1. Ensure your project has a backup and/or is in a source control system (Git, SVN, Hg);
  2. Delete Assets/bolt and any other Bolt related files:
    1. Assets/Photon;
    2. Assets/samples;
    3. Assets/Plugins;
  3. Download latest Bolt package from Asset Store and import to your project;
  4. Restore the following files:
    1. If you are updating from Bolt v1.2.5 or older:
      1. Assets/bolt/project.bytes or Assets/bolt/project.xml;
      2. In this case you should also delete the Assets/Photon/PhotonBolt/project.json file, so your Assets could be converted to the JSON format.
    2. If you are updating from Bolt v1.2.7 or newer:
      1. Assets/bolt/project.json;
    3. Assets/bolt/assemblies/bolt.user.dll;
    4. Assets/bolt/resources/BoltRuntimeSettings.asset;
  5. Move the following files:
    1. Assets/bolt/project.json to Assets/Photon/PhotonBolt/project.json;
    2. Assets/bolt/assemblies/bolt.user.dll to Assets/Photon/PhotonBolt/assemblies/bolt.user.dll;
    3. Assets/bolt/resources/BoltRuntimeSettings.asset to Assets/Photon/PhotonBolt/resources/BoltRuntimeSettings.asset;
  6. Remove the Assets/bolt folder;
  7. Quit Unity;
  8. Open Unity and compile Bolt:
    1. Run the compilation at Bolt/Compile Assembly menu.
    2. Open the Bolt Assets window (Bolt/Assets menu), you should have all your assets as expected.
  9. If the Wizard window did not show up, open it at Bolt/Wizard menu;
  10. Follow the steps on the Wizard:
    1. Configure your Photon Cloud credentials;
    2. Install all desired packages. The Core package installation is not required anymore;
  11. Any doubt, talk with us on our Discord Community.
  12. You are ready to use Photon Bolt.

Back To Top

Upgrading To Bolt 1.2.0.0 To 1.2.8

  1. Ensure your project has a backup and/or is in a source control system (Git, SVN, Hg);
  2. Delete Assets/bolt and any other Bolt related files:
    1. Assets/Photon;
    2. Assets/bolt_samples;
    3. Assets/Plugins/;
  3. Download latest Bolt package from Asset Store;
  4. If the Wizard window did not show up, open it at: Bolt/Wizard menu;
  5. Follow the steps on the Wizard:
    1. Configure your Photon Cloud credentials;
    2. Install all desired packages. You must install at least the Core package;
    3. Any doubt, talk with us on our Discord Community.
  6. Quit Unity;
  7. Restore the following files:
    1. Assets/bolt/project.bytes or Assets/bolt/project.xml, if you are updating from Bolt v1.2.5 or older;
      1. In this case you should also delete the Assets/bolt/project.json file, so your Assets could be converted to the JSON format.
    2. Assets/bolt/project.json, if you are updating from Bolt v1.2.7 or newer;
    3. Assets/bolt/assemblies/bolt.user.dll;
    4. Assets/bolt/resources/BoltRuntimeSettings.asset;
  8. Open Unity and compile Bolt:
    1. Run the compilation at Bolt/Compile Assembly menu.
    2. Open the Bolt Assets window (Bolt/Assets menu), you should have all your assets as expected. If it's true, you can remove/delete the old project files (Assets/bolt/project.bytes or Assets/bolt/project.xml).
  9. You are ready to use Bolt.

Back To Top

Migrating Bolt Assets

Bolt saves all of its objects, states, commands and events in the Assets/bolt/project.json file. It's just a JSON file that defines all information from the assets. You can read it but we highly discourage that you modify this file directly, the modification can break the deserialization process.

To migrate to a new project, simply copy this file to the same location in the new project. This is also useful if you need to share Bolt data with other team members.

Back To Top

Upgrading Bolt Free To Bolt Pro

If you now have access to Photon Bolt Pro, it's easy to update your SDK to this new version. First, follow the instructions on the section Upgrading Bolt, as you are changing versions, the instructions are the same as if you upgrading.

The important aspects of the update are that you must maintain your project using a Version Control System like SVN or GitHub before doing any changes or make a backup of it. There are some files that are the most important ones for your game work properly after the update:

  • Assets/Photon/PhotonBolt/project.json: this contains all your Bolt Assets descriptions;
  • Assets/Photon/PhotonBolt/assemblies/bolt.user.dll: this is the generated DLL every time you Compile Bolt, it's nice to have it saved, so you don't see errors after the update.
  • Assets/Photon/PhotonBolt/resources/BoltRuntimeSettings.asset: the Scriptable Object that contains all Bolt Settings you've set for your game.

In summary, the update process is:

  1. Backup the files described above;
  2. Remove All Bolt Related files;
  3. Import the new version of Bolt;
  4. Revert your files on the right locations;
  5. Done.

Also, you need to restart Unity at least once, so it reloads all Bolt DLLs. We also suggest you remove the folders: Library, obj and Temp on the root for your project folder (those folders are not inside the Assets folder) only if you are having compilation issues. Keep in mind that removing those folders will cause your project to be completely recompiled by Unity, which may take a while, depending on the size of your project.

Regardless of the code or script changes, the update is almost minimal. The main difference is that you are now able to connect to a server directly using its IP/port. Once you have imported the SDK, you will find the samples_pro folder, and there you will find the BoltPro/BoltProInit.cs script. This script shows how you can start a Game Server using the DotNetPlatform (that allows the direct connection), and later how to connect to the server from the client using the BoltNetwork.Connect using the server EndPoint. The rest of the code and behaviors should be the same as on the Free version.

To Document Top