FEZLVL format

Overview

.fezlvl.json files contain level data stored in a JSON format. This documentation presents a structure and purpose to each property in this file format. Descriptions are incomplete in some cases, and they might be incorrect due to lack of proper testing in the game itself, but that'll improve over time. Who doesn't love to experiment?

Format differences

This format differs a little bit from how the level data is arranged in the game's structure in order to eliminate redundant and unnecessary data arrangement. Here's a list of all differences:

• Level's Triles property is a list of TrileInstances instead of a dictionary with TrileEmplacement keys, which are now stored within TrileInstance as Position property.
• OverlappedTriles property of TrileInstance has been removed. All overlapped triles are stored in Level's Triles list.
• TrileGroup stores a list of TrileEmplacements instead of an exact replica of a TrileInstance structure.
• Scripts have been completely changed to be stored in a more efficient syntax.

Property definitions

Level

Top-level object stored in .fezlvl.json JSON file.

Enum

All enums are stored as PascalCamelCase string parameters.

LevelNodeType

Enum specifying how level should appear in the map. It can take one of three values:

• Node
• Hub
• Lesser

Vector3

Geometry structure containing X, Y and Z coordinates. It's stored as an array of three floating point numbers, simirarly to how GeoJSON does it.

TrileFace

Structure identifying location of a trile and facing direction. In FEZLVL data, it's used only to determine a default starting position.

TrileEmplacement

Geometry structure containing X, Y, and Z coordinates of a trile in the map. It's stored as an array of three integer numbers.

FaceOrientation

Enum specifying one of six possible trile face orientations - Left, Down, Back, Right, Top or Front.

LiquidType

Enum specifying one possible water types used in levels - None, Water, Blood, Lava, Sewer, Purple or Green.

AmbienceTrack

Structure specifying the name of ambience track to play and when it's played.

TrileInstance

Structure containing information about a single trile - a level tile in 3D space. Multiple triles may be present in the same position.

TrileInstanceActorSettings

Structure containing additional information of a trile instance.

TrileGroup

Structure containing a list of trile instances grouped together and parameters of this group.

MovementPath

Structure defining the path of movement and its properties. It's used by Trile groups and occasionally by functions available through Scripts.

PathSegment

Structure defining properties of a path segment.

Quaternion

Geometry structure containing X, Y, Z and W coordinates. It's stored as an array of four floating point numbers, simirarly to how GeoJSON does it.

CameraNodeData

Structure containing custom information about camera movement along path.

PathEndBehaviour

Enum specifying how path segment should end - Bounce, Loop or Stop.

ActorType

Enum specifying a type of actor used by TrileGroup, Art Object or Background Plane. Depending on a type of actor, specified object can be treated differently. A list of all actor types along with their behaviours can be found on the ActorType Enum reference page.

Volume

Structure defining a cuboid zone with custom properties. These zones can also be used by Scripts for custom conditions or triggers.

VolumeActorSettings

Structure defining settings for a volume instance.

DotDialogueLine

Structure defining Dot dialogue.

CodeInput

Enum specifying in-game input - None, Up, Down, Left, Right, SpinLeft, SpinRight or Jump.

Vector2

Geometry structure containing X and Y coordinates. It's stored as an array of two floating point numbers, simirarly to how GeoJSON does it.

Script

Structure defining custom behaviour which can await certain triggers, react to specified conditions and execute defined actions with given parameters.

Script Operation

ScriptTrigger, ScriptCondition and ScriptAction are using string-encoded operations. Their syntax may vary, but they will always start with entity identifier followed by a dot. Entity identifier is simply its class name. If an entity is not static (like Level or Camera), it's followed by a square brackets [] operator containing an ID of an object (like Volume or ArtObject).

A full list of entities and their exposed triggers, properties and actions is available at the "Scripting Reference" page.

ScriptTrigger

String-encoded operation starting with entity identifier, followed by the name of the trigger, like so:

[EntityIdentifier].[TriggerName]

As an example:

Level.Start

ScriptCondition

String-encoded operation starting with entity identifier, followed by the name of the property, one of the valid comparison operator (==, >=, <=, >, < or !=) and value literal, like so:

[EntityIdentifier].[Property] [ComparisonOperator] [ValueLiteral]

As an example:

Gomez.CollectedCubes >= 1

Game.GetLevelState == INTRO_COMPLETE

ScriptAction

String-encoded operation starting with entity identifier, followed by the name of the action and a list of parameters enclosed by parentheses and separated by commas. Additionally, operation string can be preceded by two control characters:

• # - blocks execution of following actions until this one is completed.
• ! - terminates the entire script once the action is executed.

Script action has following syntax:

[ControlCharacters][EntityIdentifier].[ActionName]([Property1], [Property2], ...)

As an example:

Game.Wait(1)

#Dot.Say(DOT_CUBES_GET_A, False, False)

ArtObjectInstance

Structure defining art object instance, its location and settings.

ArtObjectActorSettings

Structure defining settings for art object instance.

VibrationMotor

Enum specifying controller vibration - None, LeftLow or RightHigh.

Viewpoint

Enum specifying viewport - None, Front, Right, Back, Left, Up, Down or Perspective.

BackgroundPlane

Structure defining background plane, its location and properties.

Color

Structure containing information about R, G, B and A components of the color. It's stored in CSS/HTML-style eight-digit hexadecimal color syntax (#rrggbbaa) in a string.

NpcInstance

Structure defining an instance of a non-playable character in the level.

SpeechLine

Structure defining a speech line and its additional attributes.

NpcActionContent

NpcAction Dictionary

A dictionary of NpcActionContents assigned to specific NpcAction as a key.

NpcAction

Enum specifying NPC's action - None, Idle, Idle2, Idle3, Walk, Turn, Talk, Burrow, Hide, ComeOut, TakeOff, Fly or Land.