Create a PixiJS app with one command
Answer a few prompts and get a working PixiJS 8 project with PixiJS 3D, a dev server, linting and formatting already set up.
npm create pixi.js@latestNeeds Node.js 22.12 or newer.
Then run npm install and npm run dev in the new folder.
Pick a template
These commands skip the prompts. Replace my-app with your folder name, or use . for the current folder.
Game
A game starter for the platform of your choice, with GSAP, PixiJS UI, PixiJS Sound, PixiJS Filters and Spine.
Starter, Web
A bunny that jumps when you press a button. A standalone browser game built with Vite.
Template guidenpm create pixi.js@latest my-app -- --template starter-webStarter, Web, multiplayer
A bunny that jumps when you press a button. A standalone browser game built with Vite. Adds a Colyseus server that keeps every player in sync.
Template guidenpm create pixi.js@latest my-app -- --template starter-web-multiplayerStarter, Discord Activity
A bunny that jumps when you press a button. Runs inside Discord as an Activity, with Discord sign-in.
Template guidenpm create pixi.js@latest my-app -- --template starter-discordStarter, Discord Activity, multiplayer
A bunny that jumps when you press a button. Runs inside Discord as an Activity, with Discord sign-in. Adds a Colyseus server that keeps every player in sync.
Template guidenpm create pixi.js@latest my-app -- --template starter-discord-multiplayer
Bundler
A minimal PixiJS app wired up to the build tool of your choice.
Vite
Instant dev server that reloads on save. The recommended starting point.
Template guidenpm create pixi.js@latest my-app -- --template bundler-vitewebpack
webpack with esbuild-loader for fast TypeScript builds.
Template guidenpm create pixi.js@latest my-app -- --template bundler-webpackesbuild
Plain esbuild scripts with a live-reloading dev server and no plugins.
Template guidenpm create pixi.js@latest my-app -- --template bundler-esbuildImport map
JavaScript onlyNo build step. PixiJS loads from a CDN through a browser import map.
Template guidenpm create pixi.js@latest my-app -- --template bundler-import-map
Framework
PixiJS rendered inside a UI framework.
React
React with @pixi/react, built with Vite.
Template guidenpm create pixi.js@latest my-app -- --template framework-react
Extension
A library project for publishing your own PixiJS plugin.
Default
TypeScript onlyBuild, test, document and publish a PixiJS extension with PixiJS Extension Scripts.
Template guidenpm create pixi.js@latest my-app -- --template extension-default
In every project
What every template includesDev server on port 8080
Start it with
npm run dev. Most templates open it in your browser too.Production build
npm run buildlints your code, type-checks TypeScript, and writes the app todist/.oxlint and oxfmt
lintandformatscripts, plus VS Code settings that lint and format on save.TypeScript or JavaScript
Most templates come in both. The JavaScript versions are the same code with the types removed.
The extension template uses PixiJS Extension Scripts for these instead, and the import map template has no build step.