* Fixed SetUnitOpacity can't be called in storyboard Initialize function

* Added `LoadDEPLS2Image` storyboard function

* Moved `DEPLS.LoadConfig` function to global namespace

Author: MikuAuahDark

docs/Storyboard.md

@@ -6,6 +6,30 @@ Please note that Lua script running as Lua storyboard is sandboxed, which means
 functions doesn't exist in here or modified to prevent alteration of the rendering state, and
 to prevent malicious Lua storyboard script writing anywhere.
 
+Storyboard Entry Points
+=======================
+
+Lua storyboard needs to create this function in global namespace. Although there's way to use
+it without this entry points by using coroutines, but it's usage is discouraged and only
+provided for legacy DEPLS storyboard lua script.
+
+*************************************************
+
+### `void Initialize()`
+
+Storyboard initialization. This function is called everytime storyboard is loaded. Load your
+images here
+
+*************************************************
+
+### `void Update(number deltaT)`
+
+Storyboard frame update. Draw and calculate everything for the storyboard in here.
+
+Parameters:
+
+* deltaT - The delta-time, in milliseconds
+
 Storyboard Functions
 ====================
 
@@ -136,3 +160,15 @@ Parameters:
 Returns: Stereo audio sample with size `size` (index 1 is L channel, index 2 is R channel)
 
 > This function handles mono/stereo input and this function still works even if no audio is found, where in that case the sample is simply 0
+
+*************************************************
+
+### `Image|nil LoadDEPLS2Image(string path)`
+
+Loads game image (not relative to beatmap directory)
+
+Parameters:
+
+* `path` - The image path
+
+Returns: Image handle or `nil` on failure

livesim.lua

@@ -38,7 +38,11 @@ local DEPLS = {
 		{569, 465}, {416, 496}, {262, 465},
 		{133, 378}, {46 , 249}, {16 , 96 },
 	},
-	IdolImageData = {},	-- [idol positon] = {image handle, opacity}
+	IdolImageData = {	-- [idol positon] = {image handle, opacity}
+		{nil, 255}, {nil, 255}, {nil, 255},
+		{nil, 255}, {nil, 255}, {nil, 255},
+		{nil, 255}, {nil, 255}, {nil, 255}
+	},
 	NoteAccuracy = {{16, nil}, {40, nil}, {64, nil}, {112, nil}, {128, nil}},	-- Note accuracy
 	NoteManager = nil,
 	NoteLoader = nil,
@@ -647,26 +651,6 @@ function DEPLS.LoadImageSafe(path)
 	else return token_image end
 end
 
---! @brief Load configuration
---! @param config_name The configuration name
---! @param default_value The default value of the configuration
---! @returns Configuration value or `default_value` (and save it as `default_value`)
-function DEPLS.LoadConfig(config_name, default_value)
-	local file = love.filesystem.newFile(config_name..".txt", "r")
-	
-	if file == nil then
-		file = io.open(DEPLS.SaveDirectory.."/"..config_name..".txt", "wb")
-		file:write(tostring(default_value))
-		file:close()
-		
-		return default_value
-	end
-	
-	local data = file:read()
-	
-	return tonumber(data) or data
-end
-
 --! @brief Load audio
 --! @param path The audio path
 --! @param noorder Force existing extension?
@@ -899,6 +883,19 @@ do
 	end
 end
 
+--! @brief Loads DEPLS2 image file
+--! @param path The image path
+--! @returns Image handle or nil on failure
+function DEPLS.StoryboardFunctions.LoadDEPLSImage(path)
+	local _, a = pcall(love.graphics.newImage, path)
+	
+	if _ then
+		return a
+	end
+	
+	return nil
+end
+
 -----------------------------
 -- The Live simuator logic --
 -----------------------------
@@ -944,14 +941,14 @@ function DEPLS.Start(argv)
 	love.filesystem.createDirectory("beatmap")
 
 	-- Load configuration
-	local BackgroundID = DEPLS.LoadConfig("BACKGROUND_IMAGE", 11)
-	local Keys = DEPLS.LoadConfig("IDOL_KEYS", "a\ts\td\tf\tspace\tj\tk\tl\t;")
-	local Auto = DEPLS.LoadConfig("AUTOPLAY", 0)
-	DEPLS.LiveDelay = DEPLS.LoadConfig("LIVESIM_DELAY", 1000)
+	local BackgroundID = LoadConfig("BACKGROUND_IMAGE", 11)
+	local Keys = LoadConfig("IDOL_KEYS", "a\ts\td\tf\tspace\tj\tk\tl\t;")
+	local Auto = LoadConfig("AUTOPLAY", 0)
+	DEPLS.LiveDelay = LoadConfig("LIVESIM_DELAY", 1000)
 	DEPLS.ElapsedTime = -DEPLS.LiveDelay
-	DEPLS.NotesSpeed = DEPLS.LoadConfig("NOTE_SPEED", 800)
-	DEPLS.Stamina = DEPLS.LoadConfig("STAMINA_DISPLAY", 32)
-	DEPLS.ScoreBase = DEPLS.LoadConfig("SCORE_ADD_NOTE", 1024)
+	DEPLS.NotesSpeed = LoadConfig("NOTE_SPEED", 800)
+	DEPLS.Stamina = LoadConfig("STAMINA_DISPLAY", 32)
+	DEPLS.ScoreBase = LoadConfig("SCORE_ADD_NOTE", 1024)
 	DEPLS.Keys = {}
 	do
 		local i = 9
@@ -1051,14 +1048,14 @@ function DEPLS.Start(argv)
 	noteloader_data.units = noteloader_data.units or {}
 	local IdolImagePath = {}
 	do
-		local idol_img = DEPLS.LoadConfig("IDOL_IMAGE", "a.png,a.png,a.png,a.png,a.png,a.png,a.png,a.png,a.png")
+		local idol_img = LoadConfig("IDOL_IMAGE", "a.png,a.png,a.png,a.png,a.png,a.png,a.png,a.png,a.png")
 
 		for w in idol_img:gmatch("[^,]+") do
 			IdolImagePath[#IdolImagePath + 1] = w
 		end
 	end
 	for i = 1, 9 do
-		DEPLS.IdolImageData[i] = {noteloader_data.units[i] or DEPLS.LoadUnitIcon(IdolImagePath[10 - i]), 255}
+		DEPLS.IdolImageData[i][1] = noteloader_data.units[i] or DEPLS.LoadUnitIcon(IdolImagePath[10 - i])
 	end
 
 	-- Load stamina image (bar and number)

luastoryboard.lua

@@ -197,7 +197,10 @@ function LuaStoryboard.Draw(deltaT)
 		status, msg = pcall(StoryboardLua[1], deltaT)
 	end
 
-	graphics.pop()
+	for i = 1, PushPopCount do
+		graphics.pop()
+	end
+	PushPopCount = 0
 
 	-- Cleanup
 	graphics.setCanvas()

main.lua

@@ -22,6 +22,26 @@ local loader = {
 local function error_printer(msg, layer)
 	print((debug.traceback("Error: " .. tostring(msg), 1+(layer or 1)):gsub("\n[^\n]+$", "")))
 end
+
+--! @brief Load configuration
+--! @param config_name The configuration name
+--! @param default_value The default value of the configuration
+--! @returns Configuration value or `default_value` (and save it as `default_value`)
+function LoadConfig(config_name, default_value)
+	local file = love.filesystem.newFile(config_name..".txt")
+	
+	if not(file:open("r")) then
+		assert(file:open("w"))
+		file:write(tostring(default_value))
+		file:close()
+		
+		return default_value
+	end
+	
+	local data = file:read()
+	
+	return tonumber(data) or data
+end
 
 function love.errhand(msg)
 	msg = tostring(msg)

noteloader/load_cbf.lua

@@ -58,7 +58,7 @@ function CBFBeatmap.Load(file)
 	end
 
 	local notes_data = {}
-	local desired_attribute = DEPLS.LoadConfig("LLP_SIFT_DEFATTR", 1)
+	local desired_attribute = LoadConfig("LLP_SIFT_DEFATTR", 1)
 
 	if cbf.SONG_ATTRIBUTE == "Pure" then
 		desired_attribute = 2

noteloader/load_llp.lua

@@ -20,7 +20,7 @@ local LLPBeatmap = {
 --! @note Modify `LLP_SIFT_DEFATTR` config to change default attribute
 function LLPBeatmap.Load(file)
 	local llp = JSON:decode(love.filesystem.newFileData(file[1]..".llp"):getString())
-	local attribute = DEPLS.LoadConfig("LLP_SIFT_DEFATTR", 1)	-- Smile is default
+	local attribute = LoadConfig("LLP_SIFT_DEFATTR", 1)	-- Smile is default
 	local sif_map = {}
 
 	for n, v in pairs(llp.lane) do

setting_view.lua

@@ -0,0 +1,3 @@
+-- DEPLS settings
+
+local Settings = {}