Getting Started

This page is a work in progress.

Navigate to the /src folder. There are three files that you will most likely use:

• main.lua: The entry point for user code.

• layout.lua: The user-defined Actors and Gizmos go here.

• gimmicks.lua: The user-defined gimmicks reside here.

Let's create a simple gimmick. In gimmicks.lua, write the following:

gimmick {0, 2, Tweens.easeLinear, 0, 100, 'flip'}

This will ease the flip gimmick for 2 beats, starting at beat 0.

Let's create a black background. Open layout.lua and type:

actor { InitCommand = function(self) BG = self end }

Now, in main.lua, type:

function ready()
    -- ...
    BG:FullScreen():diffuse(0, 0, 0, 1)
    -- ...
end

There's another way to create Actors provided with Ichigo. It requires including the gizmos file in the include folder. Let's call these "headers". You can include them at the top of a file like so:

include "gizmos"

Now that we've included the Gizmo header in layout.lua, replace the Actor we created with this:

BG = Rect:new()
AddGizmo(BG)

Gizmos have different names than Actors, but are similar in function. For example, this Rect Gizmo will create a Quad Actor. You can treat this Rect like any other Quad.

A list of Gizmos and their related Actors can be found here.