Kitsu Template v3.1.0

Author: Sudospective

CHANGES.md

@@ -0,0 +1,16 @@
+# Kitsu Template v3.1.0
+
+## Changes
+- Reformatted `mods.lua` to streamline mod implementation
+- Added `bg.lua` and `fg.lua` for background and foreground actors
+- Added `using` function to allow for scoping of namespaces (useful for repeated use of a library such as `mirin-syntax`)
+- Fixed environment behavior to support `using`
+- Reimplemented `mirin-syntax` as a built-in library (you may remove this if you wish)
+- Configured `mods.lua` with `using 'mirin'` to streamline mod implementation (you may remove this if you wish)
+- Edited `print` to support tables
+- Edited chart to have appropriate BPM and time signatures
+- Fixed broken functions in `konko-node` getting variables in wrong environment
+- Fixed `run` and `import` using default `sudo` environment to load files
+- Moved player proxies to `fg.lua`
+- Created background for `bg.lua`
+- Added default mods in `mods.lua`

lib/konko-node.lua

@@ -24,6 +24,8 @@ local Node = {}
 -- Version number
 local VERSION = '1.1'
 
+local env = getfenv(2)
+
 local ease_table = {}
 local func_table = {}
 local msg_table = {}
@@ -36,7 +38,7 @@ local function UpdateEases()
 	for i, v in ipairs(ease_table) do
 		local actor
 		if type(v[1]) == 'string' then
-			actor = _G.sudo[v[1]]
+			actor = env[v[1]]
 		else
 			actor = v[1]
 		end
@@ -61,7 +63,7 @@ local function UpdateFuncs()
 	for i, v in ipairs(func_table) do
 		local actor
 		if type(v[1]) == 'string' then
-			actor = _G.sudo[v[1]]
+			actor = env[v[1]]
 		else
 			actor = v[1]
 		end
@@ -88,6 +90,11 @@ local function UpdateSignals()
 	end
 end
 
+local function GetActor(this)
+	for i, v in ipairs(Node.GetTree()) do
+		if v.Name == this then return v end
+	end
+end
 local NodeTree = Def.ActorFrame {
 	InitCommand = function(self)
 		local s = self
@@ -96,7 +103,7 @@ local NodeTree = Def.ActorFrame {
 		local function NameActors(actor)
 			for i = 1, actor:GetNumChildren() do
 				local this = actor:GetChildAt(i)
-				_G.sudo[this:GetName()] = this
+				env[this:GetName()] = this
 				if this.GetChildren then NameActors(this) end
 			end
 		end
@@ -213,7 +220,7 @@ end
 local function SetName(self, name)
 	--print('Node:SetName')
 	self.Name = name
-	--_G.sudo[name] = self
+	--env[name] = self
 	return self
 end
 local function SetTexture(self, path)
@@ -328,9 +335,9 @@ local function AddChild(self, child, idx, name)
 	return self
 end
 local function GetChildIndex(self, name)
-	--print('Node:GetChildIndex')
+	print('Node:GetChildIndex')
 	if self.Type ~= 'ActorFrame' and self.Type ~= 'ActorFrameTexture' then
-		printerr('Node.AddChild: Cannot add child to type '..self.Type)
+		printerr('Node.GetChildIndex: Cannot add child to type '..self.Type)
 		return
 	end
 	for i, v in ipairs(self) do
@@ -339,6 +346,19 @@ local function GetChildIndex(self, name)
 		end
 	end
 end
+local function HideOverlay(b)
+	if not std.SCREEN.HideGameplayElements then return end
+	if b == nil then
+		printerr('Node.HideOverlay: Must have boolean argument')
+		return
+	elseif type(b) ~= 'boolean' then
+		printerr('Node.HideOverlay: Argument must be boolean')
+		return
+	end
+	if b then
+		std.SCREEN:HideGameplayElements()
+	end
+end
 local function AddToTree(self, idx, name)
 	--print('Node:AddToTree')
 	if type(idx) == 'string' then
@@ -355,26 +375,6 @@ local function AddToTree(self, idx, name)
 	end
 	return self
 end
-local function GetOverlay()
-	local ret = {}
-	ret[#ret + 1] = std.SCREEN:GetChild('Underlay')
-	for i = 1, #std.PL do
-		ret[#ret + 1] = std.PL[i].Life
-		ret[#ret + 1] = std.PL[i].Score
-	end
-	ret[#ret + 1] = std.SCREEN:GetChild('Overlay')
-	return ret
-end
-local function HideOverlay(b)
-	--print('Node.HideOverlay')
-	if type(b) == 'boolean' then
-		for _, v in ipairs(GetOverlay()) do
-			v:visible(tobool(not b))
-		end
-	else
-		printerr('Node.HideOverlay: argument must be boolean value')
-	end
-end
 local function GetTree()
 	--print('Node.GetTree')
 	return NodeTree
@@ -404,11 +404,10 @@ Node = {
 	SetDraw = SetDraw,
 	AddChild = AddChild,
 	GetChildIndex = GetChildIndex,
-	AddToTree = AddToTree,
-	GetOverlay = GetOverlay,
 	HideOverlay = HideOverlay,
+	AddToTree = AddToTree,
 	GetTree = GetTree,
-	GetActor = function(this) printerr('Node.GetActor: Function not available before ready()') end,
+	GetActor = GetActor,
 }
 Node.__index = Node
 

lib/mirin-syntax.lua

@@ -0,0 +1,59 @@
+-- mirin-syntax.lua --
+
+--[[
+	Available commands:
+	- set {start, percent, mod, ...}
+	- ease {start, length, ease, percent, mod, ...}
+	- definemod {name, funtion, return}
+	- setdefault {percent, mod, ...}
+	
+	Mirin documentation available at https://xerool.github.io/notitg-mirin
+--]]
+
+local Mods = import 'konko-mods'
+
+local mirin = {}
+
+local function set(t)
+	table.insert(t, 2, 0)
+	table.insert(t, 3, Tweens.instant)
+	local pn = (type(t.plr) ~= 'table' and t.plr) or nil
+	t.plr = nil
+	Mods:Mirin(t, 0, pn)
+	return set
+end
+
+local function ease(t)
+	local pn = (type(t.plr) ~= 'table' and t.plr) or nil
+	t.plr = nil
+	Mods:Mirin(t, 0, pn)
+	return ease
+end
+
+-- WIP: Not a one-to-one implementation, define mods one at a time
+local function definemod(t)
+	Mods:Define(table.unpack(t))
+	return definemod
+end
+
+local function setdefault(t)
+	local t2 = {}
+	for i = 1, #t, 2 do
+		table.insert(t2, {t[i], t[i + 1]})
+	end
+	Mods:Default(t2)
+	return setdefault
+end
+
+mirin = {
+	VERSION = '1.1',
+	ease = ease,
+	set = set,
+	definemod = definemod,
+	setdefault = setdefault
+}
+mirin.__index = mirin
+
+print('Loaded Mirin Syntax v'..mirin.VERSION)
+
+return mirin

lib/stdlib.lua

@@ -21,6 +21,7 @@ std.BEAT = std.POS:GetSongBeat() -- current beat
 std.BPS = std.POS:GetCurBPS() -- current beats per second
 std.BPM = std.BPS * 60 -- beats per minute
 std.SPB = 1 / std.BPS -- seconds per beat
+
 std.PL = {}
 
 -- A bit of work to get the true start of our FG changes.
@@ -39,19 +40,22 @@ fgfirst = nil
 chart = nil
 f = nil
 
+local env = getfenv(2)
+
 -- This might not be added on the engine side yet.
 if not Tweens.instant then
 	Tweens.instant = function(x) return 1 end
 end
 
 
 local InputHandler = function(event)
-	if sudo.input then
-		sudo.input(event)
+	if env.input then
+		env.input(event)
 	end
 	MESSAGEMAN:Broadcast('Input', {event})
 end
 
+
 -- Our foreground to put everything in. If FG is not set, this will take its place.
 if FG.stdlib then
 	--print('We have stdlib already, loading mini-actor instead')
@@ -106,8 +110,8 @@ else
 	FG[#FG + 1] = Def.ActorFrame {
 		Name = 'stdlib',
 		InitCommand = function(self)
-			if sudo.init then
-				sudo.init()
+			if init then
+				init()
 			end
 		end,
 		ReadyCommand = function(self)
@@ -156,11 +160,11 @@ else
 			std.BPM = std.BPS * 60 -- beats per minute
 			std.SPB = 1 / std.BPS -- seconds per beat
 			std.DT = self:GetEffectDelta() -- time since last frame in seconds
-			if sudo.ready then
-				sudo.ready()
+			if ready then
+				ready()
 			end
-			if sudo.draw then
-				self:SetDrawFunction(sudo.draw)
+			if draw then
+				self:SetDrawFunction(draw)
 			end
 		end,
 		UpdateCommand = function(self)
@@ -169,15 +173,14 @@ else
 			std.BPM = std.BPS * 60
 			std.SPB = 1 / std.BPS
 			std.DT = self:GetEffectDelta()
-			if sudo.update then
-				sudo.update(std.DT)
+			if update then
+				update(std.DT)
 			end
 		end,
 		OffCommand = function(self)
 			std.SCREEN:RemoveInputCallback(InputHandler)
 		end,
 	}
-	print('Loaded Kitsu Standard Library v'..std.VERSION)
 end
 
 
@@ -248,4 +251,6 @@ end
 
 std.__index = std
 
+print('Loaded Kitsu Standard Library v'..std.VERSION)
+
 return std

lua/bg.lua

@@ -0,0 +1,54 @@
+-- Libraries
+local std = import 'stdlib'
+local Node = import 'konko-node'
+
+
+-- Variables
+local SW, SH = std.SW, std.SH
+local SCX, SCY = std.SCX, std.SCY
+
+-- Nodes
+Node.new('Quad'):AddToTree(1, 'HideEvent')
+	:SetInit(function(self)
+		self
+			:FullScreen()
+			:diffuse(color('#000000'))
+	end)
+
+
+-- Called on InitCommand
+function init()
+
+end
+
+-- Called on ReadyCommand
+function ready()
+	HideEvent
+		:sleep(math.abs(std.POS:GetMusicSeconds()))
+		:easeoutexpo(1)
+		:diffusebottomedge(color('#101010'))
+		:diffuserightedge(color('#202020'))
+end
+
+-- Called on InputMessageCommand
+function input(event)
+	
+end
+
+-- Called on UpdateCommand
+function update(dt)
+
+end
+
+-- Called on FG.Draw
+function draw()
+
+end
+
+
+-- Actors
+table.insert(FG, Def.ActorFrame {
+
+	Node.GetTree()
+
+})