Scene Description File (JSON)
Global Settings
The settings object contains various global settings that affect the behavior and appearance of the application. Below are descriptions of each global setting:
screenShare(Boolean):Description: Determines whether screen sharing is enabled in the application.
Values:
true: Screen sharing is enabled.false: Screen sharing is disabled.
webcamShare(Boolean):Description: Specifies whether webcam sharing is enabled in the application.
Values:
true: Webcam sharing is enabled.false: Webcam sharing is disabled.
micShare(Boolean):Description: Controls whether microphone sharing is enabled in the application.
Values:
true: Microphone sharing is enabled.false: Microphone sharing is disabled.
joinMuted(Boolean):Description: Determines whether users joining meetings are automatically muted upon entry.
Values:
true: Users join meetings in a muted state.false: Users join meetings with their microphones unmuted.
autoSpawn(Boolean):Description: Specifies whether users are automatically spawned in the virtual environment.
Values:
true: Users are automatically spawned.false: Users are not automatically spawned and may need to manually join the environment.
autoSpawnPoint(Object):Description: Defines the point users gets automatic re spawn users in the three-dimensional space.
Structure:
x(Number): The x-coordinate of the spawn point.y(Number): The y-coordinate of the spawn point.z(Number): The z-coordinate of the spawn point.
lightIntensity(Number):Description: Sets the intensity of the lighting in the virtual environment.
Value: A numerical value indicating the light intensity.
spawnPoint(Object):Description: Specifies the default spawn point for users in the three-dimensional space.
Structure:
x(Number): The x-coordinate of the spawn point.y(Number): The y-coordinate of the spawn point.z(Number): The z-coordinate of the spawn point.
description(String):Description: Provides a descriptive label or name for the application.
Value: A string containing the application's description or label.
passwordProtected(Boolean):Description: Indicates whether the application requires a password for access.
Values:
true: The application is password-protected.false: The application does not require a password for access.
automaticEnvironmentMap(Boolean):Description: Specifies whether to automatically use an environment map in the application.
Values:
true: Automatically use an environment map.false: Do not use an environment map.
maxUsers(Number):Description: Sets the maximum number of users allowed in the virtual environment.
Value: A numerical value indicating the maximum number of users.
duplicateSpaces(Boolean):Description: Determines whether duplicate spaces are allowed in the application.
Values:
true: Duplicate spaces are allowed.false: Duplicate spaces are not allowed.
useSky(Object):Description: Configures settings related to the sky appearance in the virtual environment.
Structure:
use(Boolean): Specifies whether to use a custom sky.colorTop(String): The color at the top of the sky.colorBottom(String): The color at the bottom of the sky.useEnvironment(Boolean): Specifies whether to use an environment map for the sky.toneMapped(Boolean): Specifies whether to use toneMapped.textureSrc(String): The source URL for the Sky texture.
useGround(Object):Description: Configures settings related to the ground appearance in the virtual environment.
Structure:
use(Boolean): Specifies whether to use a ground.chunkColor(String): The color of the ground chunks.voxelsColor(String): The color of ground voxels.
useEnvironment(Object):Description: Configures environmental settings, including the texture source for the environment.
Structure:
use(Boolean): Specifies whether to use environmental settings.textureSrc(String): The source URL for the environmental texture.
The source URL for the environmental texture. The defaults are one of the following:
"courtyard_1k.jpg"
"hotel_room_1k.jpg"
"moonless_golf_1k.jpg"
"ninomaru_teien_1k.jpg"
"spruit_sunrise_1k.jpg"
"venice_sunset_1k.jpg"
"portland_landing_pad_1k.jpg"
"dam_wall_1k.jpg"
"industrial_sunset_puresky_1k.jpg"
"kloofendal_43d_clear_puresky_1k.jpg"
"pizzo_pernice_1k.jpg"
"small_empty_room_4_1k.jpg"
"sunflowers_puresky_1k.jpg"
Supported formats for textures are equirectangular hdr, exr, jpg (gaimaps). ( convert hdr to jpg gainmaps https://gainmap-creator.mono-grid.com/) prefered Format is jpg (gainmaps 1k Resolution)
spawnRotation(Object):Description: Sets the default rotation for spawned users in the three-dimensional space.
Structure:
x(Number): The rotation around the x-axis (in degrees).y(Number): The rotation around the y-axis (in degrees).z(Number): The rotation around the z-axis (in degrees).
featureFlags(Object):
Description: Sets upcoming Feature Flags.
These global settings collectively define the behavior, appearance, and interaction options of the application. You can configure them to tailor the application to your specific requirements and user experience.
Last updated
