Skip to content
Pixi Solid

Project Setup

Creating a new project

Section titled “Creating a new project”

To use pixi-solid you'll need to have a SolidJS project set up. If you don't have one yet, you can create a new SolidJS project using the following command:

Terminal window
npm init solid@latest

This will create a new SolidJS project in a directory of your choice.

Next, install pixi-solid along with its peer dependency pixi.js in the new project you just created:

Terminal window
npm i pixi-solid pixi.js

Existing project

Section titled “Existing project”

If you already have a project setup you'll need to make sure that you also have pixi.js and solid-js installed. Then you can just install pixi-solid.

Terminal window
npm i pixi-solid

LLM skill

Section titled “LLM skill”

A pixi-solid skill for LLM coding assistants ships with the package. You can either:

  • Reference the path in your AGENTS.md or .cursorrules: node_modules/pixi-solid/dist/skill/pixi-solid/SKILL.md
  • Copy the files to your project root for more reliable access: cp -r node_modules/pixi-solid/dist/skill .

The skill covers the full public API: components, hooks, utilities, providers, and testing patterns.