Getting Started

Installation

The SnapEngine project is split into multiple packages, so you only need to install the ones you require. The core engine is available as @snap-engine/core:

npm install @snap-engine/core

SnapEngine and all of its assets are TypeScript-based, so it will install the necessary type definitions automatically.

Importing

Import the modules you need from the @snap-engine/core package:

import { Engine } from "@snap-engine/core";

Additional modules are available as subpath imports:

import { DebugRenderer } from "@snap-engine/core/debug";
import { AnimationObject, SequenceObject } from "@snap-engine/core/animation";
import { CollisionEngine, RectCollider, CircleCollider } from "@snap-engine/core/collision";