Skip to main content

VisualNovelEngine

18 tools in this family (folder Editor/Tools/VisualNovelEngine/ in the bridge package). Effect: writes changes the project or the scene, read-only does not, destructive deletes or overwrites and the client asks before running it.

ToolEffectDescription
vn_add_backgroundwritesRegister a background for the visual novel — ID, sprite path, optional prefab path, and default tran…
vn_add_characterwritesDefine a character for the visual novel — ID, display name, text color, portrait sprites
vn_add_choicewritesAdd a branching choice point to a script. Each choice has text, a goto label,
vn_add_commandwritesAppend a command line to a .vnscript file. Supports show/hide character, change background,
vn_add_dialoguewritesAppend a dialogue line to a .vnscript file. Optionally include emotion and voice clip.
vn_add_transitionwritesDefine a named custom transition effect for use in scripts.
vn_add_unlockablewritesRegister unlockable content: CG gallery image, music track, tips text, or ending.
vn_create_chapterwritesCreate a new chapter/scene script file with a label, title card, and metadata.
vn_create_projectwritesInitialize a visual novel project structure with Scripts/, Characters/, Backgrounds/, Audio/, UI/ fo…
vn_export_projectread-onlyExport the entire VN project to a portable JSON document — characters, backgrounds,
vn_generate_flowchartread-onlyGenerate a visual flowchart from a script's branching structure.
vn_import_renpywritesImport a Ren'Py script (.rpy) and convert it to .vnscript format.
vn_localize_scriptwritesGenerate a localization template for a script (extract all dialogue/choice/print text)
vn_parse_scriptread-onlyParse a .vnscript file and return its structured representation — commands, labels, dialogue count, …
vn_set_variablewritesSet a VN variable in the project's variable registry. Variables can be used in script conditions
vn_setup_scenewritesGenerate a Unity scene with Canvas, character position slots, background image, dialogue panel,
vn_validate_scriptread-onlyValidate a .vnscript for errors: missing characters, undefined labels, broken branches,
vn_write_scriptwritesCreate or overwrite a .vnscript file with visual novel commands and dialogue.