pixi-vn-narration

Write Pixi'VN story scenes with labels, dialogue, choices, and branching narration flow.

145|9|Updated Feb 14, 2024
One-click install
npx skills add https://github.com/DRincs-Productions/pixi-vn --skill pixi-vn-narration-drincs-productions
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: pixi-vn-narration
Source: https://github.com/DRincs-Productions/pixi-vn/tree/main/skills/narration
Command: npx skills add https://github.com/DRincs-Productions/pixi-vn --skill pixi-vn-narration-drincs-productions

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires @drincs/pixi-vn, @drincs/pixi-vn-ai.

What problem does it solve? Writing interactive story content in Pixi'VN requires knowing the engine's specific APIs for scenes, dialogue, choices, and story flow. This Skill provides the exact patterns for defining labels with newLabel, displaying dialogue, building choice menus, and driving story progression, so you can author narrative content without digging through the full engine documentation. ## Core Features & Use Cases - Scene and Dialogue Authoring: Define labels (scenes) with newLabel, write narrator and character dialogue lines, glue text across steps, and use Markdown or Tailwind-styled HTML for rich text. - Choices and Branching: Build choice menus with newChoiceOption/newCloseChoiceOption, create conditional label content based on storage flags, and request typed player input. - Story Flow Control: Start the game with Game.start, advance steps with narration.continue, and call or jump between labels with correct async/await and return conventions. - Use Case: A writer asks to add a scene where the player meets a character, picks between two dialogue responses, and the story branches based on a previously set flag — the Skill supplies the complete label definition, choice wiring, and conditional steps. ## Quick Start Write a new Pixi'VN scene called 'meet-liam' where Liam greets the player and offers two choices that jump to different labels.

Frequently Asked Questions about pixi-vn-narration

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I create a scene or label in Pixi'VN?

Create a label by calling newLabel with a unique id and an array of step functions, each setting narration.dialogue or other state. The label self-registers at module scope, so importing the file makes it available to choices, narration.call, and Game.start.

How do I add player choices in a Pixi'VN story?

Assign an array to narration.choices built with newChoiceOption for options that open another label, or newCloseChoiceOption to just close the menu. Options support call or jump types, oneTime visibility, and autoSelect behavior.

What is the difference between narration.call and narration.jump?

narration.call opens a label like a function call and returns to the caller when its steps finish, while narration.jump closes the current label first with no return. When used inside a step, both should be awaited and returned for correct history bookkeeping.

Can Pixi'VN dialogue use Markdown or HTML formatting?

Yes, Markdown is the recommended format for dialogue text and can be mixed with raw HTML. Official templates render it with react-markdown plus remark-gfm and rehype-raw, and Tailwind-styled inline elements should use inline-block for transforms to apply.

How do I branch a Pixi'VN scene based on game state?

Pass a function returning the steps array to newLabel instead of a static array. The function re-runs whenever the engine reads the label's steps, so branch on stable storage flags from the storage module rather than values that change mid-step.

When should I not use the Pixi'VN narration module?

Do not use it for character definitions and appearance, undo or go-back mechanics, save files, or persistent variables. Those belong to the characters, history, saves, and storage modules respectively, which have their own dedicated skills.