Installation

From template

npx degit RSamaium/CanvasEngine/starter my-project
cd my-project
npm install
npm run dev # and go to localhost:5173

In existing project

Your project must already be under Vite.

npm i canvasengine @canvasengine/compiler

Add in vite.config.ts

import { defineConfig } from 'vite';
import canvasengine from '@canvasengine/compiler';

export default defineConfig({
  plugins: [canvasengine()],
});

For production builds, the CanvasEngine plugin automatically keeps PixiJS and CanvasEngine runtime modules in stable chunks. If your project already defines custom Rollup chunks, keep them as usual; CanvasEngine chunks are applied first and your custom chunks are preserved.

import { defineConfig } from 'vite';
import canvasengine, { withCanvasEngineManualChunks } from '@canvasengine/compiler';

export default defineConfig({
  plugins: [canvasengine()],
  build: {
    rollupOptions: {
      output: {
        manualChunks: withCanvasEngineManualChunks((id) => {
          if (id.includes('node_modules/lodash')) return 'vendor';
        }),
      },
    },
  },
});