Skip to main content

World (Root) Element

info

World is shorthand and synonymous with Storyworld.

Management

Add World

  1. From the dashboard, create or select a studio.
  2. Click the Add World button.

Select World

  1. Click the world's title in the World Outline to select.

Alternatively, click the Preview tab in the composer to select.

Rename World

  1. Select the world.
  2. Rename from the element properties panel.

Remove World

  1. From the dashboard, in the World Box, click the Remove World button.
  2. Click remove in the confirmation modal.
caution

Removing a world will permanently remove all associated elements.

Properties

When the World element is selected, the following properties are editable from the Element Properties panel:

Selected Storyworld

Jump On Start

Metadata

Storyworld Preview

The World element is represented as the Preview tab in the composer.

In the Preview tab, test your live storyworld using the bundled, hot-reload supporting Storyteller and accompanying devtools.

Devtools

Schema

World (root) properties make up the world's _ object.

children

Ordered array of element child references represented as tuples with child element type at index 0 and child element UUID at index 1.

The world element supports unique FOLDER and SCENE element child references.

Property Type

Array<['FOLDER' | 'SCENE', string]>

JSON Example

"children": [
  ["SCENE", "ca122de2-5736-43cc-86fd-5f23c575e7a1"],
  ["FOLDER", "58ee805c-2f58-4614-bfbc-d7d123272517"]
]

The world's copyright information.

Property Type

string

JSON Example

"copyright": "(c) 2021 Elm Story Games"

description

A description or summary of the world's content.

Property Type

string

JSON Example

"description": "You wake in a dusty, frigid and dimly lit room..."

designer

Property Type

string

JSON Example

"designer": "ritsuke"

engine

The Elm Story app and Storyteller version.

Property Type

string

JSON Example

"engine": "0.7.0"

id

World UUID.

Property Type

string

JSON Example

"id": "701b0e45-1afa-4755-97d3-b600a52efaf3"

jump

UUID of jump component used for Jump On Start.

Property Type

string

JSON Example

"jump": "0a300279-034a-4b78-88ac-822afec0480c"

schema

URL of the current engine's hosted schema for use in validating storyworld data.

Property Type

string

JSON Example

"schema": "https://gitlab.com/elmstorygames/schemas/-/raw/master/0.7.0.json"

studioId

The world's studio UUID.

Property Type

string

JSON Example

"studioId": "131415d0-0684-50f6-a474-9797968cd850"

studioTitle

The world's studio title.

Property Type

string

JSON Example

"studioTitle": "Elm Story Games"

tags

Property Type

string[]

JSON Example

"tags": ["mystery", "thriller", "choice", "parser"]

title

World title.

Property Type

string

JSON Example

"title": "Amber Shores"

updated

Last time world element changed, represented as the milliseconds elapsed since the UNIX epoch.

Property Type

number

JSON Example

"updated": 1636121968781

version

World version using semver format.

Property Type

string

JSON Example

"version": "0.0.45"

website

URL of the storyworld's marketing website.

Property Type

string

JSON Example

"website": "https://elmstory.com"