Getting Started

Setting up a Scene

Add Volplane Controller

Once you have imported the Volplane package into Unity you need to set up your project. For communication with the AirConsole API inside a scene, the "VolplaneController" component has to be instantiated. You can find a Prefab of it in the Assets/Volplane/Prefabs folder. Alternatively, the object can also be instantiated via the menu bar or hierarchy: Create > Create Other > Volplane Controller.

Volplane Controller

The VolplaneController component offers you the following options:

Option Description
Browser Start In order to test your game, Volplane will open up your default browser which then runs the AirConsole API (or simulator) and creates a connection to your Unity editor. This will change how Volplane interacts with your browser.
Auto Scale Canvas This option is enabled by default and scales your final WebGL canvas automatically to the window size. Your specified aspect ratio will be kept during the scaling.
Use Persistent Data When checked, synchronises saved user data with the AirConsole servers. Data will be stored persistently for later use.

Script Execution Order

Script Execution Order

To ensure the correct functioning of the Volplane framework, the script execution order must be set properly. This setting can be found under Edit > Project Settings > Script Execution Order.

Make sure the VolplaneController script will be executed before the Default Time block.

Build Settings

Volplane WebGL Template

Before building your WebGL project, the HTML/CSS template which should be used must be specified. In the player settings of Unity (Edit > Project Settings > Player). Under the WebGL tab "Resolution and Presentation", set the template to Volplane.

After a successful build of your project a new button appears in the "Volplane Controller" inspector named "Open Last Build". It will run the built AirConsole project on a local web server.