Galacean Knowledge

Project scaffold for managing synchronization rules between Galacean-related repositories. It already understands how to mirror the cloneEngine/runtime, engine-toolkit, engine-lottie, and engine-spine workspaces so you can keep their sources and declarations up to date in this repo.

Goals

• Centralize knowledge of where Galacean projects live on disk.
• Describe how to mirror TypeScript sources and declaration files.
• Provide a light entry-point that future tooling can invoke.

Development

npm install
npm run build

Sync pipeline

npm run sync

• Execute the build/cleanup pipeline for every supported project.
• Copy the latest src and types artifacts into this repo under source-code/* and declare/*.

Per-project behavior

• engine (cloneEngine/runtime)
  • Runs pnpm run b:all.
  • Copies every packages/*/src folder into source-code/engine while retaining the packages/... structure.
  • Copies every packages/*/types folder into declare/engine, also retaining the packages/... structure.
• engine-toolkit
  • Runs pnpm run b:all.
  • Mirrors the packages/*/src folders into source-code/engine-toolkit.
  • Mirrors the packages/*/types folders into declare/engine-toolkit.
• engine-lottie
  • Runs pnpm run build.
  • Copies the whole src tree into source-code/engine-lottie/src.
  • Copies the whole types tree into declare/engine-lottie/types.
• engine-spine
  • Runs pnpm run build.
  • Copies the whole src tree into source-code/engine-spine/src.
  • Copies the whole types tree into declare/engine-spine/types.

Single target sync

npm run sync:engine
npm run sync:toolkit
npm run sync:lottie
npm run sync:spine

Configuration

• Override project locations with the following environment variables (or CLI flags):
  • GALACEAN_ENGINE_ROOT / --engine-root
  • GALACEAN_TOOLKIT_ROOT / --toolkit-root
  • GALACEAN_ENGINE_LOTTIE_ROOT / --lottie-root
  • GALACEAN_ENGINE_SPINE_ROOT / --spine-root
• Append -- --skip-build to skip every build step (when you already ran them manually).

Add new synchronization targets under src/ as you expand the knowledge base.