FAQs & Tutorials / Tutorial
Tutorial · Getting started

Getting Started with Incisor®.

From download to a published page in about half an hour. You'll sign in, play a game from the Project Gallery, take a lap around the editor, write a few lines of code, edit the result in the GUI, and publish it to the web.

TutorialFirst projectJavaScriptTypeScriptPublishing
New here?

If you want the short version of what Incisor® is before you install anything, read What is Incisor®? first. This tutorial is written for JavaScript projects. TypeScript projects work the same way, and the few places they differ are called out in TypeScript notes.

1 · Before you start

You need three things, and two of them you may already have.

A Mac or a Windows PC

Incisor® runs on macOS (Apple Silicon and Intel) and 64-bit Windows. Windows ARM is not supported yet.

A code editor

Any editor works. This tutorial uses Visual Studio Code, which is free and is the editor the debugging and TypeScript integrations are built for.

An Incisor® account

Free, created from inside the app in section 2. Incisor® Free includes nearly the whole feature set with daily usage limits. No card is needed.

A little JavaScript

You'll write about ten lines. If you can read a function, you can follow along. Nothing here needs Node, npm or a build step.

2 · Install and sign in

  1. Download Incisor® from the downloads page. The Mac build is a notarized disk image; the Windows build is an installer that needs no admin rights.
  2. Open it. On a Mac, drag Incisor® to Applications and launch it. On Windows, run the installer and launch it from the Start menu.
  3. The window that opens is the Control Center, with a login box in the middle. Press Sign Up.
  4. Fill in the form. Your email address is your username. Passwords need 8 to 32 characters with an uppercase letter, a lowercase letter, a number and a special character.
  5. Check your inbox and confirm the email. Then log in.
The Incisor Control Center on first launch, showing the Incisor Login box with Username and Password fields and Sign Up and Login buttons
First launch: the Control Center with the login box. Sign Up is on the left of Login.
The Incisor Signup form with fields for name, phone, industry, organization, job title, email and password
The sign-up form. The email address becomes your username.

Already have an account from Incisor® Red? It works in Crimson as it is. Log in and carry on.

3 · The Control Center

Every Incisor® window starts on the Control Center. It is the tab furthest to the left, and it stays there while you work, one click away from any project. From here you can open the Project Gallery, start a New Project, Browse for a project folder on disk, or get back to a recent project.

The Project Gallery popup over the Control Center, with categories Blank New, Recents, Demos, Casino and Tutorials down the left and rows of project thumbnails
The Project Gallery. Blank New starts an empty project; Recents are yours; Demos, Casino and Tutorials are finished projects you can open and read.

Two things to know about where projects live:

  • Gallery projects open in a scratch folder. Opening an example or a blank project puts a copy in Incisor®'s Project Scratch directory, so there is nothing to answer before you can try it.
  • The first save is a Save As. When you save a scratch project for the first time, Incisor® asks where to put your copy. After that it saves in place. Anything left in scratch is cleared out after about a week.

4 · Open something that already works

Before writing anything, open one of the games or game vignettes in the Gallery. It shows you what a project looks like when it is done, and every panel you meet in the next section will have real content in it.

  1. In the Control Center, open the Project Gallery and choose Demos.
  2. Double-click Total Destruction. A new tab opens next to the Control Center and the project loads.
  3. Projects open paused. In the Live View panel, press the big Run button in the middle (or the small one in the panel's toolbar).
  4. Play. Aim with the mouse, hold to charge, release to launch. Knock the structure down.
  5. Press the square Stop button in the Live View toolbar when you're done. The project stops; the tab and the editor stay.
Total Destruction running in the Live View panel of the Incisor editor on the Ritual Stones level, with the Object panel and the expanded Hierarchy panel on the left and the Control Center, Untitled Project and Total Destruction tabs along the top
Total Destruction running inside the editor. The game on the right is live; the panels on the left are looking at it, and each open project is a tab along the top.

Everything you just played is an ordinary project folder: code in ProjectCode, images and sounds in Assets. You can read any of it, and the demos are written to be read.

5 · A lap around the editor

The editor (Incisor® calls it the inspector) is a set of panels around a running project. Each panel has a type, chosen from the small menu at the left of its header, and you can add panels with the + in a header, close them with ×, and drag the dividers. Arrange them however you like; a new project opens with the three on the left below.

PanelWhat it's for
Live ViewThe project itself, running. Run, Stop and zoom live in its toolbar. Click an object here to select it.
HierarchyEvery object in the scene as a tree. Click a row to select it, drag it by its handle to reparent, search by name.
ObjectEverything about the selected object: name, position, scale, rotation, the graphic it shows, its material, its effects. Edit a value and the running project changes.
AssetsEvery file in the project's Assets folder, with a preview and the import settings for each one.
ConstructA visual editor for Constructs: groups of objects that artists and designers build, arrange and animate here, no code needed. Coders then drop a finished Construct into the game with one line.
TimelineKeyframe animation for the open Construct. Position, scale, rotation, color, text, sound triggers, events and much more, with curves you can shape and a playhead you can scrub.
LogThe strip along the bottom of the window. Errors appear here in red and link to the line in your source.
The Assets panel with the project's asset tree on the left, a preview of the selected image at the top right and its trimming, texture and resolution settings below
The Assets panel: tree, preview, settings. Select several files and change their settings together.
A character Construct open in the Construct panel with its parts listed in the Hierarchy and a Timeline panel full of keyframes along the bottom
A Construct and its Timeline. This is where art and animation happen without code.

There are more panel types (Layers, Sounds, Data, Particle System, Flows, Loading Tier Testing and others) and you'll meet them as you need them. The seven above are enough for everything in this tutorial.

6 · Your first project

  1. Go back to the Control Center tab and open the Project Gallery.
  2. Under Blank New, double-click Blank New 2D Project JS. (Every Incisor® project is 3D underneath; the 2D option just starts with an orthographic camera.)
  3. A tab called Untitled Project opens. Press Run in the Live View. You should see the word Hello!
  4. Save it now (Project → Save, or Cmd+S / Ctrl+S). Because the project started in the scratch folder, this first save is a Save As: pick a folder and give the project a name. From here on it saves in place.
A new blank project running in the editor: Object panel, Hierarchy panel and a Live View showing the word Hello
A blank project, running. One text object, one camera, nothing else.

What's in the folder

The project path is shown at the top right of the window. Open that folder in your code editor (in VS Code, File → Open Folder…). This is all of it:

ItemWhat it is
ProjectCode/Your code. ProjectMain.js is the entry point: Incisor® calls its init() when the project starts.
Assets/Images, fonts, sounds, models. Anything you drop in here becomes an asset. A new project comes with a SampleAssets folder to play with.
Utilities/Files Incisor® maintains for you, including IncisorAPI.js, which gives your editor autocomplete for the whole API.
ProjectSettings.jsonCanvas size, publishing configurations, fonts, loading tiers. Edited from Project → Settings in the editor.
jsconfig.jsonTells your editor which folders to index.
ProjectCode/ProjectMain.js, as created
// This is the main entry point for this Incisor® project.
// Throughout the project, this object can be referenced as 'pr'.
class ProjectMain
{
    init()
    {
        this.text = new TextAssembly();
        this.text.string = "Hello!";
    }
}

Two names you will see everywhere: nc is Incisor® itself (the engine, the scene, the assets, the API), and pr is this object, your project's main class, reachable from any file.

TypeScript. Pick Blank New 2D Project TS instead. Your code goes in TypescriptProjectCode/ProjectMain.ts, Incisor® compiles it into ProjectCode itself (no Node, no npm, no package.json) and recompiles whenever a file changes. A tsconfig.json and a .vscode folder are created for you, and type errors show up in the log and in VS Code's Problems panel.

7 · Change the code, see it live

Leave the project running. In your editor, replace the body of init() with this and save:

ProjectCode/ProjectMain.js
class ProjectMain
{
    init()
    {
        this.text = new TextAssembly();
        this.text.string = "Hello, Incisor!";
        this.text.position.y = 220;

        this.parrot = new GraphicObject(nc.graphicAssets.Parrot, nc.mainScene, "Parrot");
        this.parrot.position.y = -60;
        this.parrot.rotation.addMotion.z(-8, 8, 1);
    }
}

The moment you save, Incisor® notices the file change and reloads the project. The text moves up, and a parrot appears below it, rocking gently from side to side.

Save the file and this is what the Live View shows. No reload button, no build.

Line by line:

  • nc.graphicAssets.Parrot is the Parrot.png that ships in Assets/SampleAssets. Every file in Assets becomes a property like this, and your editor autocompletes them. To use your own image, drop a PNG into the Assets folder and it appears under nc.graphicAssets within a second or two.
  • new GraphicObject(asset, parent, name) puts a picture in the scene. nc.mainScene is the root of everything you see.
  • Positions are in pixels of the project's canvas (1920 × 1080 for a new project), with the origin in the center and y pointing up.
  • rotation.addMotion.z(-8, 8, 1) adds a continuous pendulum motion between −8 and 8 degrees at speed 1. Every numeric property has addMotion for continuous motion and swoop for a one-time move with easing.

Try the autocomplete. Type this.parrot. and pause. Everything a GraphicObject can do is in that list, and the documentation for each entry is one hover away. Dotting your way around the API is the fastest way to learn it.

8 · Tweak it live in the editor

Now look at the same objects from the editor's side, and nudge them while the project runs.

  1. In the Hierarchy, open MainScene. You'll see MainCamera, TextAssembly and Parrot: the objects your code made.
  2. Click Parrot. The Object panel fills with it: its transform, the graphic asset it shows, its layer, its material.
  3. In Transform, set scale x and y to 1.5. The parrot grows in the Live View as you type. The rotation field keeps changing on its own, because the motion you added is still running.
The editor with Parrot selected: the Hierarchy shows MainScene expanded to MainCamera, TextAssembly and Parrot, and the Object panel shows Parrot's transform with scale 1.5, its graphic asset and material
Parrot selected in the Hierarchy, edited in the Object panel, visible in the Live View. Code and GUI are looking at the same object.

This is the idea the whole platform is built on. Code populates and drives objects; the GUI inspects and adjusts the same objects while the project runs; and the people who do each job can be different people.

Live View edits are temporary; Construct edits are saved. The Object panel edits whatever is selected. When that is an object in the running game, like the parrot here, the change applies to the running project only and is gone when it reloads, which makes it a quick way to find the right value before putting it in code. When the selected object belongs to a Construct open in the Construct panel (next section), the same edit is saved with the project.

9 · Animate without code

A Construct is a group of objects you build in the editor and save with the project. Each Construct can carry Timelines, keyframe animations you edit in the Timeline panel. Code then populates the Construct by name and plays its timelines. Here is the shortest possible tour.

  1. Add a panel with the + in any panel header and set its type to Construct. Add another and set it to Timeline.
  2. In the Construct panel's Construct menu choose New Construct… and name it Bird.
  3. In the Assets panel, find SampleAssets/Parrot.png and drag it into the Construct panel. The parrot appears in the construct's own view and in the Hierarchy.
  4. In the Timeline menu choose Add Timeline… and name it Bob. Timelines end at 1 second by default, so set its end time to 2 seconds.
  5. Right-click the parrot in the Hierarchy, choose Animate Graphic Object, then position. Add a keyframe at 0 with y = 0, move the playhead to 1 second, add a keyframe with y = 60, then one at 2 seconds back at 0.
  6. Press play in the Timeline panel. The parrot bobs. Drag a keyframe or bend a curve handle and watch it change.
The editor with the Bird Construct open: the Hierarchy shows Bird containing Parrot, the Construct panel shows the parrot selected, the Live View shows the running project, and the Timeline panel at the bottom shows the Bob timeline with three keyframes on position.y and an end time of 2 seconds
The Bird Construct with its Bob timeline: three keyframes on the parrot's y position, playhead scrubbed to 0.92 seconds, and the Object panel editing the construct's parrot rather than the one in the running game.

To put it in the game, two lines in init():

Populating a Construct from code
this.bird = nc.constructDefs.Bird.add(nc.mainScene, "Bird");
this.bird.timelines.Bob.play();

Constructs are how artists and animators put finished work into an Incisor® game. The FlowControllers & FlowStates tutorial shows how a whole game sequences them.

10 · Publish

Publishing turns the project into a folder of static files that any web server can host. A new project comes with one publishing configuration, DevMode, and more can be added in Project → Settings.

  1. Choose Project → Publish… and pick DevMode.
  2. When the Publishing Complete popup appears, click the Launch link. Your project opens in the browser, served from your machine.
The Publishing Complete popup over the My First Project editor, naming the Publishing/Builds folder the build was written to and a Launch link to http://localhost:8000
Publishing Complete: the build folder and a Launch link that opens it.

Back in the project folder there is now a Publishing/Builds directory with a timestamped build inside it, and inside that a folder named after the project holding index.html, the compiled code and the assets. Upload that folder anywhere and the project runs there. Desktop apps for Mac and Windows come from the same menu once a desktop publishing package is enabled in Project Settings.

The published project open in a browser tab at localhost:8000: the parrot on a dark background
The same project in a browser tab, straight from the published folder.

11 · When something goes wrong

You will mistype something. Here is what that looks like and what to do about it.

  • Red lines in the log. When your code throws, the project stops, the log strip at the bottom of the window says so in red, and the Live View offers go to console. The console lists the error with the file and line in your original source, not in some generated bundle. Fix the typo, save, and the project reloads.
  • The project won't start. Projects open paused on purpose, so an error in your code can't take the editor down with it. Read the log, fix the file, press Run again.
  • Dev tools, right in the window. The dev tools button at the top right of the Incisor® window opens Chromium's developer tools for the running project: console, sources with your original files, breakpoints, network. You can debug in place without opening anything else.
  • Stop is always there. The square button in the Live View toolbar stops the project without closing the tab or losing your panel layout.
  • Breakpoints. Turn on editor debugging in Application Settings and VS Code can attach to the running project and stop on breakpoints in your own files. See Debugging from your code editor.
The editor with a red error line in the log strip at the bottom, naming the error and the file and line in ProjectMain.js where it happened
A misspelled method name stopped the project. The log says so in red, and go to console opens the error with the file and line in your source.

TypeScript. Type errors are reported before the project runs, in the log and in VS Code's Problems panel, so most mistakes never reach the Live View.

12 · Where to go next

The Template Library

Project → Import → From Template Library… opens a searchable library of ready-made code: buttons, text effects, lighting, shadows, counters and more. Each item has a description, an animated preview and example code that runs as pasted.

The API documentation

Open it from the Incisor® menu at the top left of any project tab, or from the Control Center. It is also what powers autocomplete, so the two always agree.

Your AI assistant

Point Claude, ChatGPT or any MCP-capable assistant at https://mcp.incisordev.com/mcp and it can look things up in the Incisor® Knowledge Base while it helps you write code.

Read the demos

Every project in the Gallery is meant to be opened and read. Total Destruction is a good first one; the Slot Template is the one to study for data, reels and flows.

Keep going