Skip to main content

VNS (Visual Novel Script), a universal scripting language for creating scripts for visual novel games.

Project description

Visual Novel Script

Visual Novel Script, short for VNS, is a universal scripting language created with the goal of creating a language that allows visual novel developers to write once and compile everywhere, across different platforms, game libraries, and programming languages.

VNS provides a number of features that make it easy to create visual novels, such as:

  • A simple and easy-to-learn syntax
  • Support for branching dialogue and choices
  • Support for music and sound effects

Unlike Ren'py, writing visual novel script is more like writing a story instead of a program, and the developers also have the choice to create their own implementation.

How it started:

The development of the VNS can be traced all the way back to the initial stages of Linpg's development. During this period, the team faced the challenge of finding an efficient method to store the dialogue. Each conversation required the storage of multiple variables, including the narrator, the actual dialogue content, associated character images, ambient background music, and various other components:

example

Ultimately, the team opted for a design inspired by doubly linked list, but implemented using dictionary (HashMap for Java forks). This approach not only facilitated easier access to the data but also streamlined the saving process, enabling compatibility with formats like JSON or YAML. This method preserved readability while efficiently managing the dialogue. Today, the current system closely resembles our initial design, with only a few subtle refinements:

compiledAt: ...
dialogs:
  dialog1:
    head:
      background_image: bg1.jpg
      background_music: bgm1.mp3
      character_images:
      - alice.png
      contents:
      - Hello
      narrator: Alice
      next:
        target: ~01
        type: default
      previous: null
    ~01:
      background_image: bg1.jpg
      background_music: bgm1.mp3
      character_images:
      - alice.png
      contents:
      - Can you hear me?
      narrator: Alice
      next:
        target: ~02
        type: default
      previous: head
    ~02:
    ...
  dialog2:
    ...
  ...
id: 1
language: English

Although the overall data is easy to read, it is somewhat inconvenient to write. We came up with a dedicated dialogue editor to resolve the issue, but it's still a bit of a hassle. That is the reason why we begin to inquire about the possibility of simplifying the process.

Would it be possible to make it feel like we're writing the dialogue in a Microsoft Word document? Thus, VNS is born.

Tutorials:

VNS are written in a plain text file with the .vns extension. The script file contains a series of tags, which are used to specify the different elements of the visual novel, such as the characters, backgrounds, dialogue, music, and so on.

Tags with value

[tag]value

The [tag] represents the kind of value you are trying to represent, and the value is, well, the value.

ID:

[id]str, ex: [id]1

Specifies a (unique) ID for the current dialogue file. Every script file must have an ID.

Language:

[language]str, ex: [language]English

Specifies the language of the current dialogue. Every script file must specifies a language.

Section:

[section]str, ex: [section]dialog_example

Specifies the section of all the following dialogues.

Background image:

[bgi]str, ex: [bgi]bg1.png

Specifies the background image for the current and following dialogues.

Background music:

[bgm]str, ex: [bgm]bgm1.ogg

Specifies the background music for the current and following dialogues.

Display character(s)

[display]*str, ex: [display]character1.png character2.png

Displays the character(s) for the current and following dialogues.

Hide character(s)

[hide]*str, ex: [hide]character1.png character2.png or [hide]* for hiding all.

Hides the character(s) for the current and following dialogues.

New scene

[scene]str, ex: [scene]bg2.png

Enters a new scene and displays the specified background image.

Option(s)

[option]message->label, ex: [scene]Can you hear me?->yes_reply

Adding option(s) to current dialogues, and branch to the specified label according to the option chosen by the player.

Label

[label]str, ex: [label]jump_point1

Creates a label for the branch command. The value will be used as the key for the subsequent conversation.

Tags without value

End

[end]

Marks the end of the script.

Block

[block]

The player can't go back to the previous conversation.

Comments:

# this is a comment

Commenting the script to make it easier to understand.

Notes:

// this is a note

Notes are very similar to comments. It's used to make a note for a specific conversation and is saved to the file that is compiled.

Dialogue:

Conversations are written in the form of this:

Character name:
- Dialogue text
- More dialogue text

The character name is followed by a colon and then one or more lines of dialogue text. Each line of dialogue text must start with a hyphen and a space.

Example:

Here is a simple example of a VNS script:

[id]1
[language]English
[section]dialog_example

[bgi]bg1.png
[display]character1.png character2.png

Mabel:
- Hello my name is Mabel!
- How are you doing today!

[hide]character1.png

Dipper:
- Hi Mabel! I'm doing well, thanks for asking.

This script would display the background image bg1.png and the character images character1.png and character2.png. Mabel would then say "Hello my name is Mabel!" and "How are you doing today!". Next, character1.png would be hidden and Dipper would say "Hi Mabel! I'm doing well, thanks for asking." Finally, the script would end.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyvns-2.0.tar.gz (269.4 kB view hashes)

Uploaded source

Built Distributions

pyvns-2.0-cp312-cp312-win_amd64.whl (272.1 kB view hashes)

Uploaded cp312

pyvns-2.0-cp311-cp311-win_amd64.whl (268.2 kB view hashes)

Uploaded cp311

pyvns-2.0-cp310-cp310-win_amd64.whl (268.2 kB view hashes)

Uploaded cp310

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page