Quick intro

This needs tidying up...

TODO:

• Add in some introductory text
• Explain what Infinity Engine does
• Roughly explain how it works, benefits, etc enough to get the idea over
• Give the user the bare-minimum required to get the examples running
• Direct their attention to the config files and talk about some common config values
• Encourage them to check out the scene-from-scratch guide next

Creating a Scene from Scratch

See here for a in-depth guide to importing your own scene: Creating a Scene from Scratch.

Scene Configuration

For a full example of a config file see Infinity Engine Configuration. See src/sceneConfigType.ts for configuration types.

Some of the most common config options are covered below:

• Parcel size: defines the size of the scene. Set these to match the tile_dimensions declared in scene.json

   //src/config.ts - line #16
   const ParcelCountX = 5
   const ParcelCountZ = 5

• Infinity Engine defaults: default properties used by the engine. These can be over-ridden on a per-scene basis.

   //src/config.ts
   AVATAR_TRAP_DEFAULTS   // #72 - defaults for how avatar trap is configured
   AVATAR_DEFAULTS        // #81 - defaults for how avatar swap is rendered
   SKYBOX_DEFAULTS        // #116 - defaults for how skybox is generated
   WORLD_VEHICLE_DEFAULTS // #124 - defaults for how world vehicle is configured
   GRID_DEBUG_DEFAULTS    // #148 - the defaults when grid debug is enabled

• Scene Admins: define a list of users authorised to see the various debug/control UI elements.

   //src/config.ts, line #24
   ADMINS = [
     "any", // if set to any will allow anyone to see
   ];