#38 Add synchronisation for client and server mods

.vscode/settings.json

@@ -26,11 +26,14 @@
   ],
   "lua.targetVersion": "5.1",
   "editor.defaultFormatter": "esbenp.prettier-vscode",
-  "editor.formatOnSave": true,
-  "editor.formatOnPaste": true,
+  "editor.formatOnSave": false,
+  "editor.formatOnPaste": false,
   "[xml]": {
     "editor.defaultFormatter": "DotJoshJohnson.xml"
   },
   "Lua.runtime.version": "LuaJIT",
-  "Lua.workspace.checkThirdParty": false
+  "Lua.workspace.checkThirdParty": false,
+  "[lua]": {
+    "editor.defaultFormatter": "sumneko.lua"
+  }
 }

README.md

@@ -100,3 +100,11 @@ Also, special thanks to the people, who share their libraries, frameworks and ot
 
 I had to build the network library by my own, because Noita provides its own lua51.dll. I struggled to build it, if you are interested in,
 I've added all the necessary build files inside of .building/dll_building.7z and here you can see the [stackoverflow question](https://stackoverflow.com/questions/70048918/lua-5-1-package-loadlib-and-require-gcc-building-windows-dll) I've created.
+
+## Roadmap
+
+<div align="center">
+
+![NoitaMP-Roadmap](.github/NoitaMP-Roadmap.svg)
+
+</div>

mods/noita-mp/files/scripts/Ui.lua

@@ -18,7 +18,9 @@ Ui = {}
 ----------------------------------------
 -- Global private variables:
 ----------------------------------------
-
+local missingModGuiButton1Hovered = false
+local missingModGuiButton2Hovered = false
+local missingModGuiDismissed = false
 ----------------------------------------
 -- Global private methods:
 ----------------------------------------
@@ -237,18 +239,104 @@ function Ui.new()
         menuWidth, menuHeight = renderEzgui(x, y, "mods/noita-mp/files/data/ezgui/PlayerList.xml", self.ezguiMenuData)
     end
 
+    local function drawModConflictWarning()
+        if _G.whoAmI() == Client.iAm and Client.missingMods ~= nil and not missingModGuiDismissed then
+            gui = gui or GuiCreate()
+            GuiStartFrame(gui)
+            GuiIdPushString(gui, "missingModGUI")
+            local warningMsg = "Warning: Server has mods that you don't have enabled/installed. Missing mods are:"
+            local npID = 1
+            local button1ID = 2
+            local button2ID = 3
+            local y = 75
+            GuiZSet(gui, 100)
+            GuiText(gui, 75, y, warningMsg)
+            do
+                local msgW, msgH = GuiGetTextDimensions(gui, warningMsg)
+                y = y + msgH
+            end
+            for _, v in ipairs(Client.missingMods) do
+                GuiText(gui, 75, y, v)
+                local msgW, msgH = GuiGetTextDimensions(gui, v)
+                y = y + msgH
+            end
+            GuiZSetForNextWidget(gui, 110)
+            GuiImageNinePiece(gui, npID, 73, 73, 297, (y - 71) + 15)
+            if missingModGuiButton1Hovered then
+                GuiColorSetForNextWidget(gui, 1, 1, 0.69, 1)
+            else
+                GuiColorSetForNextWidget(gui, 1, 1, 1, 0.7)
+            end
+            GuiText(gui, 100, y + 5, "Install missing mods")
+            GuiImageNinePiece(gui, button1ID, 100, y + 5, 75, 11, 0)
+            local clicked, _, hovered = GuiGetPreviousWidgetInfo(gui)
+            if clicked then
+                missingModGuiDismissed = true
+                Client:send(NetworkUtils.events.needModContent.name,
+                    { NetworkUtils.getNextNetworkMessageId(), Client.missingMods })
+            end
+            if hovered then
+                missingModGuiButton1Hovered = true
+            else
+                missingModGuiButton1Hovered = false
+            end
+            if missingModGuiButton2Hovered then
+                GuiColorSetForNextWidget(gui, 1, 0, 0, 1)
+            else
+                GuiColorSetForNextWidget(gui, 1, 1, 1, 0.7)
+            end
+            GuiText(gui, 185, y + 5, "Continue without syncing (may cause issues)")
+            GuiImageNinePiece(gui, button2ID, 185, y + 5, 169, 11, 0)
+            clicked, _, hovered = GuiGetPreviousWidgetInfo(gui)
+            if clicked then
+                missingModGuiDismissed = true
+            end
+            if hovered then
+                missingModGuiButton2Hovered = true
+            else
+                missingModGuiButton2Hovered = false
+            end
+        end
+        if Client.syncedMods == true then
+            gui = gui or GuiCreate()
+            GuiStartFrame(gui)
+            GuiIdPushString(gui, "missingModGUI")
+            local warningMsg = "Mods synced. Enable the following mods and restart the game:"
+            local npID = 1
+            local y = 75
+            local w = nil
+            GuiZSet(gui, 100)
+            GuiText(gui, 75, y, warningMsg)
+            do
+                local msgW, msgH = GuiGetTextDimensions(gui, warningMsg)
+                w = msgW
+                y = y + msgH
+            end
+            for _, v in ipairs(Client.missingMods) do
+                GuiText(gui, 75, y, v)
+                local _, msgH = GuiGetTextDimensions(gui, v)
+                y = y + msgH
+            end
+            GuiZSetForNextWidget(gui, 110)
+            GuiImageNinePiece(gui, npID, 73, 73, w + 3, y - 71)
+        end
+
+    end
+
     ------------------------------------
     -- Public methods:
     ------------------------------------
     function self.update()
         drawFolding()
         drawMenu()
+        drawModConflictWarning()
     end
 
     ------------------------------------
     -- Apply some private methods
     ------------------------------------
 
+
     return self
 end
 

mods/noita-mp/files/scripts/net/Client.lua

@@ -15,7 +15,6 @@ local messagePack = require("MessagePack")
 --- Client
 ----------------------------------------------------------------------------------------------------
 Client            = {}
-
 ----------------------------------------
 -- Global private variables:
 ----------------------------------------
@@ -60,6 +59,9 @@ function Client.new(sockClient)
     self.serverInfo   = {}
     self.otherClients = {}
     self.entityCache  = {}
+    self.missingMods  = nil
+    self.requiredMods = nil
+    self.syncedMods   = false
 
     ------------------------------------
     --- Private methods:
@@ -159,8 +161,8 @@ function Client.new(sockClient)
 
         if not data.networkMessageId then
             logger:error(logger.channels.network,
-                         ("Unable to get acknowledgement with networkMessageId = %s, data = %s, peer = %s")
-                                 :format(networkMessageId, util.pformat(data), util.pformat(peer)))
+                ("Unable to get acknowledgement with networkMessageId = %s, data = %s, peer = %s")
+                :format(networkMessageId, util.pformat(data), util.pformat(peer)))
             return
         end
 
@@ -184,7 +186,7 @@ function Client.new(sockClient)
         if util.IsEmpty(data) then
             error(("onConnect data is empty: %s"):format(data), 3)
         end
-
+        self:send(NetworkUtils.events.needModList.name, {NetworkUtils.getNextNetworkMessageId()})
         -- sendAck(data.networkMessageId)
         CustomProfiler.stop("Client.onConnect", cpc4)
     end
@@ -306,15 +308,15 @@ function Client.new(sockClient)
 
         if data.guid == self.guid then
             logger:error(logger.channels.network,
-                         "onPlayerInfo: Clients GUID isn't unique! Server will fix this!")
+                "onPlayerInfo: Clients GUID isn't unique! Server will fix this!")
             --self.guid = Guid:getGuid({ self.guid })
             --logger:info(logger.channels.network, "onPlayerInfo: New clients GUID: %s", self.guid)
             self:disconnect()
         end
 
         if _G.NoitaMPVersion ~= tostring(data.version) then
             error(("Version mismatch: NoitaMP version of Server: %s and your version: %s")
-                          :format(data.version, _G.NoitaMPVersion), 3)
+                :format(data.version, _G.NoitaMPVersion), 3)
             self:disconnect()
         end
 
@@ -394,7 +396,7 @@ function Client.new(sockClient)
 
         local serversSeed = tonumber(data.seed)
         logger:info(logger.channels.network,
-                    "Client received servers seed (%s) and stored it. Reloading map with that seed!", serversSeed)
+            "Client received servers seed (%s) and stored it. Reloading map with that seed!", serversSeed)
 
         local localSeed = tonumber(StatsGetValue("world_seed"))
         if localSeed ~= serversSeed then
@@ -408,7 +410,7 @@ function Client.new(sockClient)
         local entityId        = localPlayerInfo.entityId
 
         self:send(NetworkUtils.events.playerInfo.name,
-                  { NetworkUtils.getNextNetworkMessageId(), name, guid, nuid, _G.NoitaMPVersion })
+            { NetworkUtils.getNextNetworkMessageId(), name, guid, nuid, _G.NoitaMPVersion })
 
         if not NetworkVscUtils.hasNetworkLuaComponents(entityId) then
             NetworkVscUtils.addOrUpdateAllVscs(entityId, name, guid, nil)
@@ -494,14 +496,14 @@ function Client.new(sockClient)
         end
 
         EntityUtils.SpawnEntity(owner, newNuid, x, y, rotation, velocity, filename, localEntityId, health,
-                                isPolymorphed)
+            isPolymorphed)
         CustomProfiler.stop("Client.onNewNuid", cpc11)
     end
 
     local function onEntityData(data)
         local cpc12 = CustomProfiler.start("Client.onEntityData")
         logger:debug(logger.channels.network, ("Received entityData for nuid = %s! data = %s")
-                :format(data.nuid, util.pformat(data)))
+            :format(data.nuid, util.pformat(data)))
 
         if util.IsEmpty(data.networkMessageId) then
             error(("onNewNuid data.networkMessageId is empty: %s"):format(data.networkMessageId), 3)
@@ -554,7 +556,7 @@ function Client.new(sockClient)
             NoitaComponentUtils.setEntityData(localEntityId, x, y, rotation, velocity, health)
         else
             logger:warn(logger.channels.network, ("Received entityData for self.nuid = %s! data = %s")
-                    :format(data.nuid, util.pformat(data)))
+                :format(data.nuid, util.pformat(data)))
         end
         CustomProfiler.stop("Client.onEntityData", cpc12)
     end
@@ -574,6 +576,67 @@ function Client.new(sockClient)
         CustomProfiler.stop("Client.onDeadNuids", cpc13)
     end
 
+    local function onNeedModList(data)
+        local cpc        = CustomProfiler.start("Client.onNeedModList")
+        local activeMods = ModGetActiveModIDs()
+        local function contains(elem)
+            for _, value in pairs(activeMods) do
+                if value == elem then
+                    return true
+                end
+            end
+            return false
+        end
+
+        self.requiredMods = data.workshop
+        local conflicts = {}
+        for _, v in ipairs(data.workshop) do
+            if not contains(v.name) then
+                table.insert(conflicts, v)
+            end
+        end
+        for _, v in ipairs(data.external) do
+            table.insert(self.requiredMods, v)
+            if not contains(v.name) then
+                table.insert(conflicts, v)
+            end
+        end
+
+        -- Display a prompt if mod conflicts are detected
+        if #conflicts > 0 then
+            self.missingMods = conflicts
+            logger:info("Mod conflicts detected: Missing " .. table.concat(conflicts, ", "))
+        end
+        CustomProfiler.stop("Client.onNeedModList", cpc)
+    end
+
+    local function onNeedModContent(data)
+        local cpc = CustomProfiler.start("Client.onNeedModContent")
+        for _, v in ipairs(data.items) do
+            local modName = v.name
+            local modID = v.workshopID
+            local modData = v.data
+            if modID == "0" then
+                if not fu.IsDirectory((fu.GetAbsolutePathOfNoitaRootDirectory() .. "/mods/%s/"):format(modName)) then
+                    local fileName = ("%s_%s_mod_sync.7z"):format(tostring(os.date("!")), modName)
+                    fu.WriteBinaryFile(fu.GetAbsoluteDirectoryPathOfMods() .. "/" .. fileName, modData)
+                    fu.Extract7zipArchive(fu.GetAbsoluteDirectoryPathOfMods(), fileName,
+                        (fu.GetAbsolutePathOfNoitaRootDirectory() .. "/mods/%s/"):format(modName))
+                end
+            else
+                if not fu.IsDirectory(("C:/Program Files (x86)/Steam/steamapps/workshop/content/881100/%s/"):format(modID)) then
+                    if not fu.IsDirectory((fu.GetAbsolutePathOfNoitaRootDirectory() .. "/mods/%s/"):format(modName)) then
+                        local fileName = ("%s_%s_mod_sync.7z"):format(tostring(os.date("!")), modName)
+                        fu.WriteBinaryFile(fu.GetAbsoluteDirectoryPathOfMods() .. "/" .. fileName, modData)
+                        fu.Extract7zipArchive(fu.GetAbsoluteDirectoryPathOfMods(), fileName,
+                            (fu.GetAbsolutePathOfNoitaRootDirectory() .. "/mods/%s/"):format(modName))
+                    end
+                end
+            end
+        end
+        CustomProfiler.stop("Client.onNeedModContent", cpc)
+    end
+
     -- self:on(
     --     "entityAlive",
     --     function(data)
@@ -649,6 +712,11 @@ function Client.new(sockClient)
         self:setSchema(NetworkUtils.events.deadNuids.name, NetworkUtils.events.deadNuids.schema)
         self:on(NetworkUtils.events.deadNuids.name, onDeadNuids)
 
+        self:setSchema(NetworkUtils.events.needModList.name, NetworkUtils.events.needModList.schema)
+        self:on(NetworkUtils.events.needModList.name, onNeedModList)
+
+        self:setSchema(NetworkUtils.events.needModContent.name, NetworkUtils.events.needModContent.schema)
+        self:on(NetworkUtils.events.needModContent.name, onNeedModContent)
         -- self:setSchema("duplicatedGuid", { "newGuid" })
         -- self:setSchema("worldFiles", { "relDirPath", "fileName", "fileContent", "fileIndex", "amountOfFiles" })
         -- self:setSchema("worldFilesFinished", { "progress" })
@@ -694,7 +762,7 @@ function Client.new(sockClient)
 
         if self:isConnecting() or self:isConnected() then
             logger:warn(logger.channels.network, "Client is still connected to %s:%s. Disconnecting!",
-                        self:getAddress(), self:getPort())
+                self:getAddress(), self:getPort())
             self:disconnect()
         end
 
@@ -721,8 +789,8 @@ function Client.new(sockClient)
         end
 
         GamePrintImportant("Client is connecting..",
-                           "You are trying to connect to " .. self:getAddress() .. ":" .. self:getPort() .. "!",
-                           ""
+            "You are trying to connect to " .. self:getAddress() .. ":" .. self:getPort() .. "!",
+            ""
         )
 
         sockClientConnect(self, code)
@@ -798,7 +866,7 @@ function Client.new(sockClient)
 
         if NetworkUtils.alreadySent(event, data) then
             logger:debug(logger.channels.network, ("Network message for %s for data %s already was acknowledged.")
-                    :format(event, util.pformat(data)))
+                :format(event, util.pformat(data)))
             return
         end