Pixi’VNLabels and steps
Explains the core concepts of labels and steps in Pixi’VN, detailing how narrative flow is structured and managed within the game engine.
Visual novels are typically a sequence of scenes with images and text. In Pixi’VN, the entire narrative flow is based on the concepts of labels and steps.
A label is used to organize the narrative; it works as a "bookmark" or section of the story. Technically, a label is a class that acts as a container for steps.
A step is an individual action or event that occurs within a label. Steps are used to display images, text, and other narrative elements.
Nomenclature
The term label is borrowed from Ren'Py, where it acts as a "bookmark" or "landmark" in the story. In the ink language, the equivalent term is knot.
The term step is introduced by Pixi’VN to represent the individual actions or events that occur within a label.
Add
To create a label, use the newLabel function.
import { narration, StepLabelProps } from "@drincs/pixi-vn";
export const startLabel = newLabel("start", [
() => {
narration.dialogue = { character: liam, text: "Example of dialogue" };
},
(props: StepLabelProps, { labelId }) => narration.jump(labelId, props),
]);