PixiJS Create

A CLI tool to scaffold PixiJS projects

Scaffolding Your First PixiJS Project

Check out the full documentation at pixijs.io/create-pixi.

Compatibility Note: PixiJS requires Node.js version 18+, 20+. However, some templates require a higher Node.js version to work, please upgrade if your package manager warns about it.

With NPM:

$ npm create pixi.js@latest

With Yarn:

$ yarn create pixi.js

With PNPM:

$ pnpm create pixi.js

With Bun:

$ bun create pixi.js

Then follow the prompts!

Advanced Usage

You can also directly specify the project name and the template you want to use via additional command line options. For example, to scaffold a PixiJS + Vite project, run:

# npm 7+, extra double-dash is needed:
npm create pixi.js@latest pixi-project -- --template bundler-vite

# yarn
yarn create pixi.js pixi-project --template bundler-vite

# pnpm
pnpm create pixi.js pixi-project --template bundler-vite

# Bun
bun create pixi.js pixi-project --template bundler-vite

Currently supported template presets include:

• bundler-vite
• bundler-vite-js
• bundler-webpack
• bundler-webpack-js
• bundler-esbuild
• bundler-esbuild-js
• bundler-import-map
• creation-web
• framework-react
• framework-react-js
• extension-default

You can use . for the project name to scaffold in the current directory.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgements

This project is based on amazing create-vite tool and inspired by the create-game project by Phaser. We are grateful for their work and the inspiration it provided.