Skip to content

Creating A Scene Config

Logodaedalus edited this page Nov 26, 2018 · 26 revisions

Summary

The scene config file is where you put all the information that tells StoryAssembler the details of how to use your content file to tell a story. Characters, goals, content libraries, even how characters are displayed is all set here.

If you're trying this for the first time, your best bet is to open up the example.json file in js/StoryAssembler/data/scene-configs and see how it works, and even just duplicate it and change the values (but be careful you step through each one and update it for your scene, as forgetting to change one may result in strange bugs that are hard to trace).

Because we use HanSON to parse it, you can use // to comment the file (as in example.json).

File Components

Id

This is the id your scene has in the game, and the value you'll put into Coordinator to hook it up

Characters

A character is a collection of custom template values and avatar states, packaged together under an id #Id The unique identifier for your character #AvatarStates This tells StoryAssembler when to display a particular avatar for your character.

Wishlist

DataFiles

StartState

SceneBackground

UIvars

Mode

FallbackText

IntroText

DescriptionText

Clone this wiki locally