Project
An interface for project configuration and metadata that defines the structure of the entire animation project.
Properties
Basic Properties
| Property | Type | Description |
|---|---|---|
name | string | Project name |
scenes | FullSceneDescription[] | Scene description list |
plugins | Plugin[] | Plugin list |
Configuration
| Property | Type | Description |
|---|---|---|
logger | Logger | Logger |
meta | ProjectMetadata | Project metadata |
settings | SettingsMetadata | Settings metadata |
variables | Record<string, unknown> | undefined | Project variable default values |
experimentalFeatures | boolean | Whether experimental features are enabled |
Media
| Property | Type | Description |
|---|---|---|
audio | string | undefined | Audio file URL |
versions | Versions | Version information |
Factory Functions
makeProject(settings: ProjectSettings): ProjectSettings
Creates project configuration.
Examples
import {makeProject} from '@wangyaoshen/locus';
export default makeProject({
plugins: [
// Your plugins
],
scenes: [import('./scenes/scene1'), import('./scenes/scene2')],
});