pixi-vn-cover-json

Pixi’VN can be integrated with JSON files to create a visual novel. This method is useful for:

Add a new narrative to Pixi’VN (It was used to create the integration with ink
Create a external tool to create visual novels with Pixi’VN

( In both these cases it is advisable to notify the developers of Pixi’VN to add the new feature to be helped )

How use Pixi’VN + Json?

First of all you need to install the following library:

npm install @drincs/pixi-vn-json

All you need to do to use this integration is create a object using the <DynamicLink href="/json/PixiVNJson">PixiVNJson Model and use the importPixiVNJson() function to import the object.

labels.json

{
    "$schema": "https://pixi-vn.com/schemas/latest/schema.json",
    "labels": {
        "back_in_london": [
            {
                "dialogue": "We arrived into London at 9.45pm exactly.",
            },
            {
                "labelToOpen": {
                    "label": "hurry_home",
                    "type": "jump",
                },
            },
        ],
        "hurry_home": [
            {
                "dialogue": "We hurried home to Savile Row as fast as we could.",
            },
            {
                "end": "label_end",
            },
        ]
    }
}

main.ts

import { PixiVNJson, importPixiVNJson } from "@drincs/pixi-vn-json";
import json from "./labels.json";

importPixiVNJson(json);

After that you can run the back_in_london label with <DynamicLink href="/start/labels#run-a-label">Pixi’VN functions.

main.ts

import { narration } from "@drincs/pixi-vn";

narration.call(`back_in_london`, {});

Pixi’VN + Json Integration

How use Pixi’VN + Json?

On this page