Pixi’VN - Pixi Visual Novel Engine

Contents

Pixi’VN - Pixi Visual Novel Engine#

Pixi’VN is a npm package that provides various features for creating visual novels.

Pixi’VN has functions to manage story steps, saving and loading, variable storage, dialogues, and character creation.

Pixi’VN is based on Pixi.js, a modern 2D rendering engine.

Use Pivi’VN Templates#

Pixi’VN template (React + Vite + MUI joy)

Get Started#

Installation#

npm install @drincs/pixi-vn

Usage#

For the following example we will use TypeScript, but you can use JavaScript as well.

// main.ts
import { GameWindowManager } from '@drincs/pixi-vn'
import App from './App'
import './index.css'

// Canvas setup with PIXI
const body = document.body
if (!body) {
    throw new Error('body element not found')
}

GameWindowManager.initialize(body, 1920, 1080, {
    backgroundColor: "#303030"
})

First steps#

After setting up the interface, you can start creating the visual novel using Pixi’VN functions.

Advanced topics#

Other#