Skip to main content

Getting started

A project​

File › New Project › Sakin Editor: choose the project's name and folder. The project opens in that folder, with one module covering it. Everything the project holds is a file in that folder, so it lives in version control as it is.

New documents​

Right-click in the Project tree → New › Sakin: World, Environment, Event, Component, Kalem Script, Building, Character, Object, Animation, Scene. The name you type becomes the document's label, and the file's name is made from it:

You typeYou get
Uhren Disko (Building)uhren-disko.building/object.json
Door bell (Kalem Script)door-bell.kalem, script DoorBell
Door opened (Event)door-opened.event, id object.doorOpened

New JSON documents carry a version, a uid and the name (label for events and worlds).

Opening a document​

A document opens on its Design tab, with the IDE's text tab beside it. A package (a building, a character, an object, an animation, a scene) is a folder, but the Project tree shows it as one item with its kind's icon; opening it opens its document, and the tab is titled with the package's name (Documents).

The editor's side panels are under Sakin › Tool Windows: Node Tree on the left, Inspector and Environment Preview on the right, Animation at the bottom. Like every tool window of the IDE, each can be docked, floated or moved to a window of its own, and the IDE keeps the layout.

A first world​

  1. New › Sakin › World. A new world starts on 1 March of year 1 (the first day of spring, a Monday) at 08:00, with no fields (World).
  2. New › Sakin › Building, then Import Model… on its Design tab to bring in a .glb (Buildings, characters and objects).
  3. New › Sakin › Scene, drag the building from the Project tree onto the scene's Design tab, and choose the scene in the world's form (Scenes).
  4. Right-click the world → Run: Play opens the world in its scene (Play).

Behaviour comes next: a Kalem script attached to the building as a component (Scripts, and Kalem's Getting started).