README.md

Getting Started

You can start using Pixi’VN by initializing a new project.

Prerequisites

Before starting, you must have the following tools installed:

• Node.js version 18 or higher.
• Text Editor with TypeScript support.
  • Visual Studio Code
  • Cursor
• (Recommended) Git
  • Have a GitHub account

Project Initialization

To initialize a new project, you can use the following command:

# npm
npm create pixi-vn@latest

# yarn
yarn create pixi-vn

# pnpm
pnpm create pixi-vn

# bun
bun create pixi-vn

# bun
deno init --npm pixi-vn

The supported template presets are:

Visual Novel - React:

• Visual Novel - React - Typescript - Web page
• Visual Novel - React - Typescript - Web page + Desktop + Mobile
• Visual Novel - React - Ink + Typescript - Web page
• Visual Novel - React - Ink + Typescript - Web page + Desktop + Mobile

( More templates will be added in the future, see this issue for more information )

After the project is initialized, you can open the project directory with your text editor (VSCode is recommended) and start developing your visual novel.

Into all templates there is a README.md file with more information about the project.