Reference

To look things up: every built-in component and its fields, every timeline clip, the files a project is made of, the settings, the shortcuts.

Components (behaviours)

Attached from the inspector's Add Behaviour. Flags are written group:index, ! for off, spaces between several: 0:14 !0:11. Radius is in world units - two villagers side by side are about 8 apart, a doorway 3.

Talk

Someone to talk to. Lines said one after another in the message window.

Chest

Exit

Mesh

A glTF model on the object. Added for you when the object's model is a glTF.

Roam

A glTF model that walks about its spot (a fox). Radius 10, Speed 4 units/s, Pause up to 3 s, WalkClip Walk, IdleClip Idle, OnGround on, AvoidHero on.

Wander

A game character that wanders (Ai: Still, Wander, Follow) with a Gait (Man, Woman, Boy, Girl, Uncle, Aunt, OldMan, OldWoman). Needs a model marked as a character.

Motion

A motion set bound to a character model and the motion played from the start: Set (w_light_man, w_light_old…), Index (1001 is the idle), Loop.

Music, Sound

Music: Bgm number, Volume 0-127, FadeIn frames; starts as the map is entered. Sound: Archive and Number (SE001_36 is the chest's; the mod's own archives start at 300), Volume 0-255, Radius (0 plays as the map is entered), Once.

MapSettings

One per map, on any object. Background the sky colour; CameraOffset where the camera hangs off the hero (the game's maps: 0, 110, 110 - keep Z positive or the controls turn round); LookOffset where it looks (0, 10, 0); ZoomRange how far the zoom button goes (60; 0 for none).

Encounter

A monster on the map: walk into it and a battle begins. Formation (the game's or the mod's), BattleMap, Once (gone for good when won), CanEscape, Radius 10, OnWalkIn on.

Cutscene

Timeline (the dock), Begins OnTalk / OnEnterMap / Manual, If and Then flags, Once, FreezeHero on, Skippable on (B), CameraBack on, and Radius / OnWalkIn for an object without a model. See timeline clips.

Trigger, WhenFlags, Removed, GameCast, CastScript

Trigger: the hero within Radius fires Entered / Left for code (Once). WhenFlags: the object exists only while When holds (Live follows changes). Removed: takes the game's own character off the map so a stand-in of the mod's takes its place (HideOnly, StandIn). GameCast and CastScript: a converted villager's original script logic, kept 1:1 or as editable lines - what Convert to OpenFF leaves on a game character.

Timeline clips

Times in seconds. ease is smooth (default), linear, in, out. A point is { "x", "y", "z" } in world units.

Files

A project lives in %LocalAppData%\OpenFF\Crystal\projects\<name>\:

Export to OpenFF writes the mod as mods\<name>\ beside OpenFF.exe: mod.json, ff3\files\, scenes\, defs\, assets\, the assemblies. mods\loadorder.json (and the title's MODS entry) orders and enables mods. A mod with no code and no changed files - scenes, definitions and assets alone - is a complete mod.

Definitions

Items - defs/items/<id>.json

{ "id": "rune-blade", "number": 20501, "base": 1107,
  "name": "Rune Blade", "caption": "A blade with a light of its own.",
  "buy": 4800, "sell": 2400,
  "fields": { "aggressivity": 34 },
  "model": "assets/rune-blade.glb", "modelScale": 1, "modelClip": "Glow",
  "modelRotation": [0, 0, 0], "modelOffset": [0, 0, 0] }

number from 20001 (Crystal gives it); base the game's item it starts from; fields the record's fields by the game's names; model and the rest the weapon's look on the OpenFF target.

Monsters and formations

{ "id": "goblin-chief", "number": 1001, "base": 1, "name": "Goblin Chief", "look": 1,
  "fields": { "maxHp": 60, "level": 4, "exp": 30, "gil": 80, "strength": 12 } }

{ "id": "chief-and-goblins", "number": 1001, "name": "Goblin Chief and two Goblins",
  "slots": [ { "monster": 1001, "min": 1, "max": 1 }, { "monster": 1, "min": 2, "max": 2 } ] }

A monster's battle model is its family's; look is which family member's texture it wears.

Characters - defs/characters/<id>.json

{ "id": "luneth", "slot": 0, "name": "Luneth", "job": "knight", "level": 5, "fixedJob": true, "look": 2 }

Models - defs/models/<name>.json

{ "model": "j101", "gltf": "assets/luneth-hd.glb" }

A model of the game's (a character, a monster's family model) drawn as the glTF on OpenFF, the game's skeleton and motions driving it; the joints match the model's nodes by name. Remake from glTF writes it. Steam gets the game-format remake instead.

Text - defs/text/<name>.json

{ "40000001": "Hello there, traveller!",
  "40000002": { "en": "Welcome!", "de": "Willkommen!" } }

Ids from 40000000 are clear of the game's. @40000001 in a Talk, a Chest or a say clip says the line through the game's own window.

Settings and command line

%LocalAppData%\OpenFF\settings.json, also the client's Esc menu:

OpenFF.exe switches: --game=ff3|ff4, --map=t01_01, --pos=x,y,z, --rot=degrees, --cutscene=<object path> (play it as the map is up), --size=WxH, --fullscreen / --borderless / --windowed, --msaa=off|2|4|8, --novsync, --log=general,file, --log-file=<path>, --drive=<file> (a scripted run), --screenshot-dir and --screenshot-every=<s>.

crystal.exe: editor --project=<name> --port=5050 --no-browser; the converters mdl, mdl-import file.glb w300 [--scale=n], tex, msd, script, pak, lz, sample-assets, api-docs, projects, installs.

Shortcuts