Taos API Reference
    Preparing search index...

    Interface ProjectDoc

    interface ProjectDoc {
        schema: 1;
        name: string;
        defaultScene: string;
        createdAt: string;
        modules?: string[];
        title?: string;
        description?: string;
        faviconPath?: string;
        splashPath?: string;
    }
    Index

    Properties

    schema name defaultScene createdAt modules? title? description? faviconPath? splashPath?

    Properties

    schema: 1
    name: string
    defaultScene: string

    Stable guid of the default scene asset. Legacy projects stored a project-root-relative path here; those are migrated to a guid on open. Resolve to a path via assets:resolveGuid.

    createdAt: string

    ISO 8601 timestamp.

    modules?: string[]

    Optional engine subsystems this project's component scripts may import (e.g. ['physics', 'terrain']). The core barrel (taos) and taos/math are always available; everything else is opt-in so a project pulls in only the modules it actually uses. The editor script sandbox and the standalone player both gate import 'taos/<id>' on this list (the module registry lives in the editor's engineModules.ts). Absent ⇒ unrestricted (every module resolves), the back-compatible default for projects authored before this field existed.

    title?: string

    Optional display title for the built/player page (<title> and heading). Falls back to name when unset.

    description?: string

    Optional one-line description, emitted as the page's <meta name="description">.

    faviconPath?: string

    Optional project-root-relative path (e.g. 'Content/favicon.png') to an image used as the web build's browser-tab favicon. Must live under Content/ so the build copies it. Falls back to the Taos logo when unset.

    splashPath?: string

    Optional project-root-relative path to an image shown on the player's loading screen in place of the Taos logo. Must live under Content/.

    Settings

    Member Visibility

    On This Page

    Properties