Install the Runtime

Preview is useful while you write, but it is not the thing players run. Players need the installed runtime bundle: story data, presentation UI, save/load behavior, settings, and runtime assets.

Install the runtime when you are ready to test your visual novel as part of a Roblox game.

What gets installed

• DirectoryReplicatedStorage

  • DirectoryVisualNovelCreatorRuntime

    • VNCClient
    • StoryAssets
• DirectoryServerScriptService

  • VNCServer

The runtime contains the player-facing UI, story data, save/load behavior, settings, and authored assets needed to play the story.

The source project remains editor data. The runtime bundle is the compiled, player-facing copy.

Install or update

1. Open the plugin.
2. Compile the project.
3. Choose Install / Update Runtime.
4. Start a Studio play session to test the in-game menu and story flow.

Reinstall the runtime after changing story data, runtime menu fields, dialog styling, runtime assets, sprite assets, or extension settings. The installed copy cannot automatically know about every authoring change until you update it.

Runtime responsibilities

Story state

The runtime tracks active story progress, save data, text filtering, and world-facing actions.

Presentation

Players see menus, dialog, sprites, audio, settings, logs, and input prompts.

This split is intentional. The runtime accepts actions only when the active story is waiting for them. A choice click should not matter unless a Choice node is active.

Test both preview and runtime

Preview is for fast authoring feedback. Play testing is for runtime behavior such as saves, settings, and player-facing UI.

The payoff is confidence. Preview tells you the scene reads correctly; runtime testing tells you the game behaves correctly.

For a fuller checklist, use Testing Runtime.