Installation

@asset-studio/core is distributed through the private Asset Studio npm registry at registry.assetstud.io. You need an API key to access it. API keys are issued when you purchase a license.

Before you begin

You must have an active subscription to receive an API key. If you don't have one yet, you must first subscribe from here.

1. Configure the Registry

Tell npm to resolve @asset-studio scoped packages from the private registry and authenticate with your API key.

npm config set @asset-studio:registry https://registry.assetstud.io
npm config set //registry.assetstud.io/:_authToken "YOUR_API_KEY"

Replace YOUR_API_KEY with the key provided to you.

Project-level config

You can also place these settings in an .npmrc file at the root of your project instead of the global npm config:

# .npmrc
@asset-studio:registry=https://registry.assetstud.io
//registry.assetstud.io/:_authToken="YOUR_API_KEY"

This is useful for CI/CD environments where you inject the token via an environment variable:

# .npmrc
@asset-studio:registry=https://registry.assetstud.io
//registry.assetstud.io/:_authToken=${ASSET_STUDIO_TOKEN}

2. Install the Package

npm install @asset-studio/core

3. Install Peer Dependencies

npm install mediabunny perfect-freehand konva react-konva react-konva-utils

4. TypeScript

Asset Studio ships with full TypeScript declarations. No additional @types package is needed.

// tsconfig.json — ensure moduleResolution supports ESM packages
{
  "compilerOptions": {
    "moduleResolution": "bundler" // or "node16" / "nodenext"
  }
}

Supported Bundlers

Bundler	Supported
Vite	✅
Next.js	✅
Create React App	✅
Webpack 5	✅
Rollup	✅

Next Steps

• Quick Start — get a working editor running
• Session Setup — configure your session API credentials