Create stunning AI-generated skybox assets within Unity for use as HDRIs in game dev and immersive projects.
In order to use this package you need to provide an API key from Blockade Labs in the API section. Get one at https://api.blockadelabs.com.
Option 1: Install from the Unity Asset Store
- Add this package to your assets from the Unity Asset Store.
- Go to
Window > Package Manager
- Change the project scope to
My Assets
- Find
Blockade Labs SDK
and clickInstall
.
Option 2: Install with OpenUPM-CLI:
openupm add com.blockadelabs.sdk
Option 3: Install as a git package
- Go to
Window > Package Manager
+ > Add package from git URL...
- Enter
https://github.com/Blockade-Games/BlockadeLabs-SDK-Unity.git
The Blockade SDK can be used standalone or optionally together with a Pusher websockets package. If installed, the Pusher package will use websockets to listen for any changes in the Asset Generation Process on Runtime and make updates accordingly, which should improve performance for your games on Runtime.
You can learn more about the Pusher package here.
The Pusher library requires .NET Framework runtime:
- Set
Edit > Project Settings > Player > Api Compatibility Level
to.NET Framework
.
Option 1: Install the Pusher package with git:
- Go to
Window > Package Manager
+ > Add package from git URL...
- Enter
https://github.com/pusher/pusher-websocket-unity.git#upm
Option 2: Install the Pusher package with OpenUPM-CLI:
openupm add com.pusher.pusherwebsocketunity
After installing the Pusher package on 2021.x.x versions you might get an error saying:
Assembly 'Packages/com.pusher.pusherwebsocketunity/Packages/PusherClient.2.1.0/lib/net472/PusherClient.dll' will not be loaded due to errors: PusherClient references strong named Newtonsoft.Json Assembly references: 12.0.0.0 Found in project: 13.0.0.0.
To resolve the issue go to Edit > Project Settings > Player > Other Settings > Configuration > Assembly Version Validation
and disable Version Validation
.
Refer to the changelog file here.
2020.3 and newer.
After importing the package, open Packages > Blockade Labs SDK > Scenes > SkyboxScene
.
Note: Demo scene uses Text Mesh Pro elements for runtime UI. If you haven't imported TMP Essentials
you will be prompted to do so after you load the scene. When you are done importing TMP Essentials,
reload the scene by either double clicking on it in the Assets/Samples/Blockade Labs SDK/Scenes
.
The scene contains two notable gameObjects:
Blockade Labs Skybox Generator
generates skybox textures and materials.Blockade Labs Skybox Mesh
generates and configures a mesh which combines the skybox with a generated depth map.
To be able to generate assets on runtime you just need to follow these simple steps:
- Select the
Blockade Labs Skybox Generator
gameObject. - Add your Blockade Labs'
API key
in the designated field. - Play the scene. You will see the necessary elements to generate a new skybox. You can look around by clicking and dragging the mouse and zoom with the scroll wheel.
- Enter a prompt, select a style, click generate.
- Generated textures and materials are placed in the
Assets/Blockade Labs SDK
for use in your project.
You can generate a new skybox that will replace the existing one by following these steps.
- Select the
Blockade Labs Skybox Generator
gameObject. - Add your Blockade Labs'
API key
in the designated inspector field. - Click the
Apply
button. - After the plugin is successfully initialized, some additional fields will become available.
- Select the desired style.
- Fill in the
Prompt
field. - Click the
Generate Skybox
Button. - Generated textures and materials are placed in the
Assets/Blockade Labs SDK
for use in your project. - You should see your new skybox in the game view. You can also click
Move Scene Camera to Skybox
to see the skybox in the scene view.
For detailed information on how skyboxes work in Unity, see using skyboxes.
- Go to
Window > Rendering > Lighting
. - Go to the
Environment
tab. - Drag the generated
skybox material
into the theSkybox Material
field. - If you want to use the skybox as background lighting in your scene, ensure
Environment Lighting Source
is set toSkybox
, then clickGenerate Lighting
.
- Add a global volume to your scene:
GameObject > Volume > Global Volume
. - Drag the generated
HDRP volume profile
in to theProfile
field.
The Blockade Labs Skybox Generator
component generates a color texture and a depth texture, which are assigned to the skybox material.
The Blockade Labs Skybox Mesh
component generates a Tetrahedron mesh to apply this material. You can configure the Mesh Density
and Depth Scale
fields. The mesh and material will be configured to apply the generated depth map to deform the mesh.
Try zooming in and out with the scroll wheel in play mode to see the effect of the depth scale!
If you want to use the generated mesh in your own scene, click Save Prefab
, then drag the new prefab into your scene.