Preflight V1 (#1186)

Author: WilsontheWolf

libs/https/smods-https.lua

@@ -240,7 +240,7 @@ if not isThread then -- In main thread
 		if threadContent then
 			return threadContent
 		end
-		local file = assert(NFS.read(SMODS.path.."/libs/https/smods-https.lua"))
+		local file = assert(SMODS.NFS.read(SMODS.path.."/libs/https/smods-https.lua"))
 		local data = love.filesystem.newFileData(file, '=[SMODS _ "smods-https-thread.lua"]') -- name is a silly hack to get lovely to register the curl module
 		threadContent = data
 		return data

libs/nativefs/nativefs.lua

@@ -492,4 +492,61 @@ else
     end
 end
 
+local redirects = {}
+
+function nativefs.smodsAddRedirect(realPath, lfsPath)
+    if redirects[realPath] then return false, 'A redirect with path "' .. realPath .. '" already exists' end
+    redirects[realPath] = lfsPath
+    return true
+end
+
+local function getRedirectPath(realPath)
+    for p, r in pairs(redirects) do
+        local len = #p
+        local sub = realPath:sub(0, len + 1)
+        if sub == p then return r end
+        if sub == p .. "/" then return r .. "/" .. realPath:sub(len + 2) end
+    end
+    return false
+end
+
+local function patchSimple(n, l) -- Simple funcions always have the path as the first argument
+    return function (path, ...)
+        local red = getRedirectPath(path)
+        if red then return l(red, ...) end
+        return n(path, ...)
+    end
+end
+
+for _, v in ipairs{"newFile", "unmount", "write", "append", "lines", "load", "getDirectoryItems", "getInfo", "createDirectory", "remove", "mount", "newFileData"} do
+    nativefs[v] = patchSimple(nativefs[v], love.filesystem[v])
+end
+nativefs.getDirectoryItemsInfo = patchSimple(nativefs.getDirectoryItemsInfo, getDirectoryItemsInfo)
+
+do
+    local nRead = nativefs.read
+    local lRead = love.filesystem.read
+    function nativefs.read(containerOrName, nameOrSize, sizeOrNil)
+        if sizeOrNil then -- Container defined
+            local red = getRedirectPath(nameOrSize)
+            if red then return lRead(containerOrName, red, sizeOrNil) end
+            return nRead(containerOrName, nameOrSize, sizeOrNil)
+        elseif not nameOrSize then
+            local red = getRedirectPath(containerOrName)
+            if red then return lRead(red, nameOrSize, sizeOrNil) end
+            return nRead(containerOrName, nameOrSize, sizeOrNil)
+        else
+            if type(nameOrSize) == 'number' or nameOrSize == 'all' then
+            local red = getRedirectPath(containerOrName)
+            if red then return lRead(red, nameOrSize, sizeOrNil) end
+            return nRead(containerOrName, nameOrSize, sizeOrNil)
+            else
+                local red = getRedirectPath(nameOrSize)
+                if red then return lRead(containerOrName, red, sizeOrNil) end
+                return nRead(containerOrName, nameOrSize, sizeOrNil)
+            end
+        end
+    end
+end
+
 return nativefs

lovely/core.toml

@@ -8,7 +8,7 @@ priority = -5
 target = "game.lua"
 pattern = "self.SPEEDFACTOR = 1"
 position = "after"
-payload = "initSteamodded()"
+payload = 'require "SMODS.preflight.loader".initSteamodded()'
 match_indent = true
 
 [[patches]]
@@ -19,12 +19,10 @@ sources = ["src/core.lua"]
 
 [[patches]]
 [patches.module]
-before = "main.lua"
 source = "version.lua"
 name = "SMODS.version"
 
 [[patches]]
 [patches.module]
-before = "main.lua"
 source = "release.lua"
 name = "SMODS.release"

lovely/fixes.toml

@@ -613,8 +613,8 @@ target = 'main.lua'
 match_indent = true
 position = 'after'
 pattern = '--To control when steam communication happens, make sure to send updates to steam as little as possible'
-payload = '''local cwd = NFS.getWorkingDirectory()
-NFS.setWorkingDirectory(love.filesystem.getSourceBaseDirectory())
+payload = '''local cwd = SMODS.NFS.getWorkingDirectory()
+SMODS.NFS.setWorkingDirectory(love.filesystem.getSourceBaseDirectory())
 '''
 
 [[patches]]
@@ -623,7 +623,7 @@ target = 'main.lua'
 match_indent = true
 position = 'before'
 pattern = '--Set up the render window and the stage for the splash screen, then enter the gameloop with :update'
-payload = '''NFS.setWorkingDirectory(cwd)
+payload = '''SMODS.NFS.setWorkingDirectory(cwd)
 '''
 
 [[patches]]
@@ -850,4 +850,4 @@ local card = Card(_area.T.x, _area.T.y, G.CARD_W, G.CARD_H, card_init.front, car
 '''
 payload = '''
 card:add_to_deck()
-'''
+'''

lovely/libs.toml

@@ -6,29 +6,27 @@ priority = -5
 [[patches]]
 [patches.module]
 source = "libs/json/json.lua"
-before = "main.lua"
 name = "json" 
 
 [[patches]]
 [patches.module]
 source = "libs/nativefs/nativefs.lua"
-before = "main.lua"
 name = "nativefs"
 
+# We use our own module because we modifed it
+# and other mods may vendor their own which doesn't
+# have our patches
 [[patches]]
 [patches.module]
-source = "libs/https/luajit-curl.lua"
-before = "main.lua"
-name = "luajit-curl"
+source = "libs/nativefs/nativefs.lua"
+name = "SMODS.nativefs"
 
-[[patches]] # Ensure the thread can also load this
+[[patches]]
 [patches.module]
 source = "libs/https/luajit-curl.lua"
-before = '=[SMODS _ "smods-https-thread.lua"]'
 name = "luajit-curl"
 
 [[patches]]
 [patches.module]
 source = "libs/https/smods-https.lua"
-before = "main.lua"
 name = "SMODS.https"

lovely/preflight.toml

@@ -0,0 +1,47 @@
+[manifest]
+version = "1.0.0"
+dump_lua = true
+priority = -11
+
+[[patches]]
+[patches.module]
+source = "src/preflight/sharedUtil.lua"
+name = "SMODS.preflight.sharedUtil" 
+
+[[patches]]
+[patches.module]
+source = "src/preflight/logging.lua"
+name = "SMODS.preflight.logging" 
+
+[[patches]]
+[patches.module]
+source = "src/preflight/loader.lua"
+name = "SMODS.preflight.loader" 
+
+[[patches]]
+[patches.module]
+source = "src/preflight/sharedUI.lua"
+name = "SMODS.preflight.sharedUI" 
+
+[[patches]]
+[patches.module]
+source = "src/preflight/core.lua"
+before = "main.lua"
+load_now = true
+name = "SMODS.preflight.core" 
+
+[[patches]]
+[patches.pattern]
+target = '=[lovely SMODS.preflight.core "src/preflight/core.lua"]'
+pattern = "local lovely_path = false -- This line is patched, don't edit it"
+position = "at"
+payload = """local lovely_path = [[{{lovely_hack:patch_dir}}/]]"""
+match_indent = true
+
+[[patches]]
+[patches.pattern]
+target = "main.lua"
+pattern = "if (love.system.getOS() == 'OS X' ) and (jit.arch == 'arm64' or jit.arch == 'arm') then jit.off() end"
+position = "before"
+payload = """if SMODS and SMODS.preflight_force_quit then if SMODS.preflight_quit_before then SMODS.preflight_quit_before() end return end"""
+match_indent = true

lovely/shaders.toml

@@ -11,10 +11,8 @@ pattern = '''self.SHADERS[shader_name] = love.graphics.newShader("resources/shad
 position = "at"
 payload = '''
 local shader = "resources/shaders/"..filename
-local lovely_success, lovely = pcall(require, "lovely")
-if lovely_success and lovely.apply_patches then
-    shader = assert(lovely.apply_patches(filename, love.filesystem.read(shader)))
-end
+local lovely = require "lovely"
+shader = assert(lovely.apply_patches(filename, love.filesystem.read(shader)))
 self.SHADERS[shader_name] = love.graphics.newShader(shader)
 '''
-match_indent = true
+match_indent = true

src/core.lua

@@ -1,82 +1,45 @@
---- STEAMODDED CORE
---- MODULE CORE
-
-SMODS = {}
-MODDED_VERSION = require'SMODS.version'
-RELEASE_VERSION = require'SMODS.release'
-SMODS.id = 'Steamodded'
-SMODS.version = MODDED_VERSION:gsub('%-STEAMODDED', '')
-SMODS.can_load = true
-SMODS.meta_mod = true
-SMODS.config_file = 'config.lua'
-
--- Include lovely and nativefs modules
-local nativefs = require "nativefs"
-local lovely = require "lovely"
-local json = require "json"
-
-local lovely_mod_dir = lovely.mod_dir:gsub("/$", "")
-NFS = nativefs
--- make lovely_mod_dir an absolute path.
--- respects symlink/.. combos
-NFS.setWorkingDirectory(lovely_mod_dir)
-lovely_mod_dir = NFS.getWorkingDirectory()
--- make sure NFS behaves the same as love.filesystem
-NFS.setWorkingDirectory(love.filesystem.getSaveDirectory())
-
-JSON = json
-
-local function set_mods_dir()
-    local love_dirs = {
-        love.filesystem.getSaveDirectory(),
-        love.filesystem.getSourceBaseDirectory()
-    }
-    for _, love_dir in ipairs(love_dirs) do
-        if lovely_mod_dir:sub(1, #love_dir) == love_dir then
-            -- relative path from love_dir
-            SMODS.MODS_DIR = lovely_mod_dir:sub(#love_dir+2)
-            NFS.setWorkingDirectory(love_dir)
-            return
-        end
-    end
-    SMODS.MODS_DIR = lovely_mod_dir
-end
-set_mods_dir()
-
-local function find_self(directory, target_filename, target_line, depth)
-    depth = depth or 1
-    if depth > 3 then return end
-    for _, filename in ipairs(NFS.getDirectoryItems(directory)) do
-        local file_path = directory .. "/" .. filename
-        local file_type = NFS.getInfo(file_path).type
-        if file_type == 'directory' or file_type == 'symlink' then
-            if not NFS.getInfo(file_path.."/.lovelyignore") then
-                local f = find_self(file_path, target_filename, target_line, depth+1)
-                if f then return f end
-            end
-        elseif filename == target_filename then
-            local first_line = NFS.read(file_path):match('^(.-)\n')
-            if first_line == target_line then
-                -- use parent directory
-                return directory:match('^(.+/)')
-            end
-        end
-    end
-end
-
-SMODS.path = find_self(SMODS.MODS_DIR, 'core.lua', '--- STEAMODDED CORE')
-
+assert(SMODS.path, "SMODS was not properly setup.\n\n!!!!!!!!!!!!!!\nPlease make sure your lovely is up to date (Minimum lovely v0.9.0)\n!!!!!!!!!!!!!!")
 for _, path in ipairs {
     "src/ui.lua",
     "src/index.lua",
     "src/utils.lua",
     "src/overrides.lua",
     "src/game_object.lua",
-    "src/logging.lua",
     "src/compat_0_9_8.lua",
-    "src/loader.lua",
 } do
-    assert(load(NFS.read(SMODS.path..path), ('=[SMODS _ "%s"]'):format(path)))()
+    assert(load(SMODS.NFS.read(SMODS.path..path), ('=[SMODS _ "%s"]'):format(path)))()
 end
 
+function boot_print_stage(stage)
+    if not SMODS.booted then
+        boot_timer(nil, "STEAMODDED - " .. stage, 0.95)
+    end
+end
+
+local catimg = NFS.getInfo(SMODS.path.."assets/cat.png") and love.graphics.newImage(love.filesystem.newFileData(NFS.read(SMODS.path.."assets/cat.png")))
+function boot_timer(_label, _next, progress)
+    progress = progress or 0
+    G.LOADING = G.LOADING or {
+        font = love.graphics.setNewFont("resources/fonts/m6x11plus.ttf", 20),
+        love.graphics.dis
+    }
+    local realw, realh = love.window.getMode()
+    love.graphics.setCanvas()
+    love.graphics.push()
+    love.graphics.setShader()
+    love.graphics.clear(0, 0, 0, 1)
+    love.graphics.setColor(0.6, 0.8, 0.9, 1)
+    if progress > 0 then love.graphics.rectangle('fill', realw / 2 - 150, realh / 2 - 15, progress * 300, 30, 5) end
+    love.graphics.setColor(1, 1, 1, 1)
+    love.graphics.setLineWidth(3)
+    love.graphics.rectangle('line', realw / 2 - 150, realh / 2 - 15, 300, 30, 5)
+    if catimg then love.graphics.draw(catimg, realw/2 - 264, realh/2 - 27, 0, 1, 1); love.graphics.rectangle('line', realw/2 - 264, realh/2 - 27, 96, 96, 5) end
+    love.graphics.print("LOADING: " .. _next, realw / 2 - 150, realh / 2 + 40)
+    love.graphics.pop()
+    love.graphics.present()
+
+    G.ARGS.bt = G.ARGS.bt or love.timer.getTime()
+    G.ARGS.bt = love.timer.getTime()
+end
 sendInfoMessage("Steamodded v" .. SMODS.version, "SMODS")
+

src/crash_handler.lua

@@ -492,6 +492,18 @@ end
 -- Note: The below code is not from the original StackTracePlus.lua
 local stackTraceAlreadyInjected = false
 
+local function doRestart()
+    if SMODS and SMODS.restart_game then
+        SMODS.restart_game()
+    else
+        local test, msg = pcall(function()
+            require"lovely".reload_patches()
+        end)
+        if not test then sendErrorMessage("Failed to reload patches... " .. tostring(msg), "StackTrace") end
+        love.event.quit("restart")
+    end
+end
+
 function getDebugInfoForCrash()
     local version = VERSION
     if not version or type(version) ~= "string" then
@@ -803,13 +815,13 @@ function injectStackTrace()
 
             for e, a, b, c in love.event.poll() do
                 if e == "quit" then
-                    return 1
+                    return a or 0
                 elseif e == "keypressed" and a == "escape" then
                     return 1
                 elseif e == "keypressed" and a == "c" and love.keyboard.isDown("lctrl", "rctrl") then
                     copyToClipboard()
                 elseif e == "keypressed" and a == "r" then
-                    SMODS.restart_game()
+                    doRestart()
                 elseif e == "keypressed" and a == "down" then
                     scrollDown()
                 elseif e == "keypressed" and a == "up" then
@@ -829,7 +841,7 @@ function injectStackTrace()
                 elseif e == "gamepadpressed" and b == "dpup" then
                     scrollUp()
                 elseif e == "gamepadpressed" and b == "a" then
-                    return "restart"
+                    doRestart()
                 elseif e == "gamepadpressed" and b == "x" then
                     copyToClipboard()
                 elseif e == "gamepadpressed" and (b == "b" or b == "back" or b == "start") then
@@ -847,7 +859,7 @@ function injectStackTrace()
                     if pressed == 1 then
                         return 1
                     elseif pressed == 3 then
-                        return "restart"
+                        doRestart()
                     elseif pressed == 4 then
                         copyToClipboard()
                     end

src/game_object.lua

@@ -1,6 +1,8 @@
 --- STEAMODDED CORE
 --- MODULE API
 
+local NFS = SMODS.NFS
+
 function loadAPIs()
     -------------------------------------------------------------------------------------------------
     --- API CODE GameObject