Bolt
>
FAQ
>

How To Import Examples

Updated: 2019-01-16

Bolt comes with multiple example projects to get you started and inspired.

We keep the core Bolt package entirely separate from these examples. That is, the plugin does not include the examples out of the box, and the examples don't include the plugin.

This reduces the download size of Bolt lets you choose which version you want to use with the examples.

Downloading Examples

All official example projects are found in the Learn Hub, under the Examples section.

There are two types of example projects:

  • Full Projects: These examples are *.zip files containing a complete Unity project. This lets us include predefined Project Settings for things like input, physics, etc.
  • Unity Packages: These examples are *.unitypackage files that can be imported in an existing Unity project.

Each type of example has slightly different import steps.


Full Projects

1. Download & extract the project

Download the example project ZIP file to any location on your computer.

Extract all the contents under the same root folder, including the Assets, ProjectSettings and Packages folder.

2. Open the project

Open the project using the Unity Hub. Select the root folder from step 2 (the one that contains the Assets folder) as the path.

All example projects were created with Unity 2017.4 in .NET 3.x for maximum compatibility, but they can easily be converted to another version.

You can use any Unity version that supports the Bolt version you want:

    • For Bolt 1, that is 2017.4 and above.
    • For Bolt 2 Alpha, that is 2018.3 and above.

    Once you selected your Unity version, hit Open and let Unity import the project.

    2019 01 16 12 16 11
    Open the root project folder with the hub.
    Unity Hub 2019 01 16 12 17 54
    Choose your preferred Unity version.
    Unity Hub 2019 01 16 12 30 04
    If prompted, let Unity upgrade the project.

    3. Switch to .NET 4.x (Optional)

    If you want to use .NET 4.x (optional for Bolt 1, required for Bolt 2), change the Scripting Runtime Version in the Project Settings now.

    You can find the setting under Edit > Project Settings... > Player > Configuration.

    2019 01 16 12 32 49
    Change your scripting runtime version to .NET 4.x.
    Unity 2019 01 16 12 34 51
    Restart Unity when prompted.

    4. Download & Import Bolt

    Head over to the Download page and download the Bolt version that you want. You can also download Bolt from the Asset Store if you prefer (the Asset Store version is always the latest stable version available).

    Then, import it in Unity with Assets > Import Package > Custom Package.... In this example, we are importing Bolt v.1.4.1b5.

    After importing, follow the setup wizard to configure the new Bolt install.

    5. Restart Unity

    Restart Unity to to make sure it loads all Bolt assets and components properly.

    This is a precautionary step; usually, it should not be required, but due to various issues in different versions of Unity, it's safer to restart.

    6. Reimport Prefabs (2018.3+)

    If you are using Unity 2018.3 and above, you need to Reimport all prefabs in the project.

    This is because all the prefabs in the example projects were created with 2017.4, using the old prefab workflow. Due to a known Unity issue, the prefab data will be corrupted in versions of Unity with the new nested prefab workflow (2018.3 and above).

    The solution is simply to Reimport the affected prefabs. You can do so by selecting the prefabs, then choosing Assets > Reimport.

    We recommend using Assets > Reimport All instead of manually selecting prefabs, just to make sure you didn't miss any. Note that a full reimport can be very long depending on the size of your project, but since example projects are usually small, it should be pretty fast.

    Unity 2019 01 16 12 55 48
    Reimport all assets in the project (recommended).
    Unity 2019 01 16 12 55 30
    Or manually choose the prefabs to reimport.

    7. Fix Missing Scripts (Bolt 2 Alpha)

    If you imported a Bolt 2 Alpha, you will need to run the script reference resolver in Tools > Bolt > Fix Missing Scripts.

    After running the resolver, a Unity restart is required.


    Unity Packages

    1. Create a new project

    Examples in Unity Packages need to be imported in existing projects.

    Create a new blank project from the Unity Hub using any Unity version that supports the Bolt version you want:

      • For Bolt 1, that is 2017.4 and above.
      • For Bolt 2 Alpha, that is 2018.3 and above.

      2. Switch to .NET 4.x (Optional)

      If you want to use .NET 4.x (optional for Bolt 1, required for Bolt 2), change the Scripting Runtime Version in the Project Settings now.

      You can find the setting under Edit > Project Settings... > Player > Configuration.

      2019 01 16 12 32 49
      Change your scripting runtime version to .NET 4.x.

      Note that projects created with Unity 2018.3 or above already use the .NET 4.x runtime by default.

      3. Download & import Bolt

      Head over to the Download page and download the Bolt version that you want. You can also download Bolt from the Asset Store if you prefer (the Asset Store version is always the latest stable version available).

      Then, import it in Unity with Assets > Import Package > Custom Package.... In this example, we are importing Bolt v.1.4.1b5.

      After importing, follow the setup wizard to configure the new Bolt install.

      4. Download & import the example package

      Head over to the Learn Hub and download the example package you want.

      Then, import it in Unity with Assets > Import Package > Custom Package.... In this example, we are importing the Doors & Portals example.

      4. Restart Unity

      Restart Unity to to make sure it loads all Bolt assets and components properly.

      This is a precautionary step; usually, it should not be required, but due to various issues in different versions of Unity, it's safer to restart.

      5. Reimport Prefabs (2018.3+)

      If you are using Unity 2018.3 and above, you need to Reimport all prefabs in the project.

      This is because all the prefabs in the example projects were created with 2017.4, using the old prefab workflow. Due to a known Unity issue, the prefab data will be corrupted in versions of Unity with the new nested prefab workflow (2018.3 and above).

      The solution is simply to Reimport the affected prefabs. You can do so by selecting the prefabs, then choosing Assets > Reimport.

      We recommend using Assets > Reimport All instead of manually selecting prefabs, just to make sure you didn't miss any. Note that a full reimport can be very long depending on the size of your project, but since example projects are usually small, it should be pretty fast.

      Unity 2019 01 16 12 55 48
      Reimport all assets in the project (recommended).
      Unity 2019 01 16 12 55 30
      Or manually choose the prefabs to reimport.

      6. Fix Missing Scripts (Bolt 2 Alpha)

      If you imported a Bolt 2 Alpha, you will need to run the script reference resolver in Tools > Bolt > Fix Missing Scripts.

      After running the resolver, a Unity restart is required.

      Was this article helpful?
      This article was helpful for 0 people.
      Yes, helpful
      No, not for me