simple-visual-novel
    Preparing search index...

    Module simple-visual-novel

    Simple Visual Novel Engine

    A minimal TypeScript visual novel engine with vanilla DOM rendering. Supports dialogue with text effects, character management, scene transitions, and game state management.

    import { Script, Scene, Character, VNEngine } from "simple-visual-novel";

    // Create a script with scenes
    const script = new Script();

    // Create characters
    const narrator = new Character("Narrator");
    const alice = new Character("Alice", "alice.png");

    // Build a scene
    const scene1 = new Scene("intro", { background: "park.png" });
    scene1.add(narrator);
    scene1.add(alice, { position: "center" });
    narrator.say("It was a beautiful day.", { effect: "fade" });
    alice.say("Hello!", { effect: "typewriter" });
    script.addScene(scene1);

    // Initialize and run
    const engine = new VNEngine({
    script,
    container: "#game",
    startScene: "intro",
    renderer: { assetsDirectory: "assets" }
    });

    References

    CancellablePromise → CancellablePromise
    Character → Character
    DialogueOptions → DialogueOptions
    DOMRenderer → DOMRenderer
    EngineEvent → EngineEvent
    EngineEventListener → EngineEventListener
    EngineEventType → EngineEventType
    fadeIn → fadeIn
    FadeOptions → FadeOptions
    fadeOut → fadeOut
    GameState → GameState
    Position → Position
    RendererOptions → RendererOptions
    Scene → Scene
    SceneAction → SceneAction
    SceneActionType → SceneActionType
    SceneOptions → SceneOptions
    Script → Script
    Size → Size
    StateManager → StateManager
    typewriter → typewriter
    TypewriterOptions → TypewriterOptions
    VNEngine → VNEngine
    VNEngineOptions → VNEngineOptions