splatshop / kitsu-template

Kitsu Template for Project OutFox

Kitsu Template

For Outfox

The Kitsu Template is a template designed to make modcharting feel more friendly to the object-oriented mindset. It also aims to make minigame creation fun, easy, and accessible to those used to making games in Love2D or most other high-level languaged, update-loop focused game engines.

You can view the docs here.

Getting Started

Creating a Node

Nodes are Kitsu's form of actors with embedded scripts or functions. To create one, simply call the Node.new function.

local MyNode = Node.new('Quad') -- You can optionally pass in a string for the type, or an entire Outfox-style actor for convenience.

Once you've created your node, you can attach a script with AttachScript.

MyNode:AttachScript('lua/script/empty.lua') -- You can use the empty script here for an example of setup

If you don't want to create a script, you can directly set the ready, update, and input functions instead.

MyNode:SetReady(function(self)
  self:Center()
  self:SetWidth(64)
  self:SetHeight(64)
end)
MyNode:SetUpdate(function(self, dt)
  self:addrotationz(360 * dt) -- dt stands for "delta time" - the amount of seconds since last frame.
end)
MyNode:SetInput(function(self, event)
  if event.type == "InputEventType_FirstPress" then
    SCREENMAN:SystemMessage(event.button)
  end
end)

Finally, you can add your node to the node tree.

MyNode:AddToNodeTree()

More documentation avaiable in nodes.lua.

Creating a Mod

Mods are done quite differently in the Kitsu template in the sense that even the mods are objects.

local MyMods = Mods.new()

You can insert mods into a mod branch using three different functions.

-- In-house method
MyMods:InsertMod(0, 4, Tweens.outelastic, {
  {20, 'drunk'},
  {20, 'tipsy'}
})
-- Mirin Method
MyMods:MirinMod({4, 4, Tweens.inoutcircle, 100, 'invert'})
-- Exschwasion Method
MyMods:ExschMod(8, 4, 100, 0, 'invert', 'len', Tweens.inoutback)

And just like with nodes, you can add your mod branches to the mod tree.

MyMods:AddToModTree()

More documentation available in mods.lua.