Guide:Script Formatting

Script Formatting describes the methods used to lay out a script while it is still being written. There are no standards, unlike other in other industries such as writing for the screen, so the exact methods used will be up to you and/or your team.

How Do I Format My Script?

It is most common for VN writers to write in a way that resembles the script code of the engine they are using. Some developers do prefer to write in more human-readable styles, such as full novel-style prose or screenplay script format, and later convert it into actionable code.

As writing is such an individual process, it can be worth the extra effort to write in whatever way you're used to, if it makes the process easier for you. However, it's worth noting that writing your original script in a format as close as possible to actionable code will make programming and directing much easier and more efficient later on (which is useful if you're participating in a game jam or have some other exterior deadline).

Whichever methods you use, there may be some simple changes you can make in your word processor to make the process easier, such as turning off automatic smart quotes and tab characters, and using inter-document hyperlinks or heading styles to simulate jumping between script labels.

Engine Script:

label scene_1:

    #any notes or scene directions
    show eileen at left
    eileen "This is a line of dialogue."
    e "You could also write using character tags instead of names."

Screenplay:

INT. EILEEN'S HOUSE - NIGHT
 
Narration lines aren't indented, like this.
    EILEEN "Hey."
    (Scene direction like this.)
    EILEEN "This is another line of dialogue."
More narration would be back out here.

Novel/Prose:

Eileen ran into frame from the left. “Hey,” she said. “This is a line of dialogue!”
She held her hand to her forehead, relieved. “I’m glad I caught you before you got to the end of this article, because this is a valid way of writing too! But it might take you a while to convert this into something usable for a game,” she continued, “because of all the dialogue tags and stuff.”

You may end up incorporating elements from each method into your own writing style over time, depending on what works best for you.

See Also

Guide:Tools for Drafting a VN for planning & writing software recommendations (though you can always write straight into your code editor)

Regex Guide for using Regex to convert different scripting styles into actionable code (Ren'Py used in example)