ENHANCEMENTS:

- Plugin "debug" added as an event debugger that you can use to see which events are being fired by DCS

Author: karel26

.gitignore

@@ -12,7 +12,6 @@ Scripts/net/DCSServerBot/DCSServerBotConfig.lua
 /export/
 /plugins/test/
 /plugins/community/
-/plugins/debug/
 /build/
 /fonts/
 /Music/

plugins/debug/README.md

@@ -0,0 +1,18 @@
+# Plugin "Debug"
+Simple event debugger for DCS callbacks and DCS mission events. It dumps the whole event structure for debug purposes.
+
+## Configuration
+As Debug is an optional plugin, you need to activate it in main.yaml first like so:
+```yaml
+opt_plugins:
+  - debug
+```
+> Please keep in mind that additional logging can cost some performance, where I don't expect this plugin to take much.
+
+To separate the debug events from your dcs.log, I would recommend to add this to your autoexec.cfg:
+```lua
+log.set_output('events', 'EVENT DEBUGGER', log.ALL, log.FULL)
+```
+
+## Credits
+Thanks to MisterOutOfTime (Moots) for helping me building that.

plugins/debug/commands.py

@@ -0,0 +1,13 @@
+import discord
+
+from core import Plugin, command, utils
+from discord import app_commands
+from services.bot import DCSServerBot
+
+
+class Debug(Plugin):
+    ...
+
+
+async def setup(bot: DCSServerBot):
+    await bot.add_cog(Debug(bot))

plugins/debug/lua/callbacks.lua

@@ -0,0 +1,76 @@
+local base 	= _G
+local utils = base.require("DCSServerBotUtils")
+local JSON  = loadfile(lfs.currentdir() .. "Scripts\\JSON.lua")()
+local debug = debug or {}
+
+
+local function sanitizer(t)
+    local visitedTable = {}
+    local function sanitizeTable(ta)
+        local t = {}
+        for k, v in pairs(ta) do
+            if type(v) == "number" then
+                if v == math.huge or v == -math.huge then
+                    v = nil
+                end
+                if v ~= v then
+                    v = "NAN"
+                end
+            end
+            if type(k) == "string" then
+            else
+                k = tostring(k)
+            end
+            t[k] = k
+            if type(v) == "function" then
+                t[k] = "function"
+            elseif type(v) == "userdata" then
+                t[k] = "userdata"
+            elseif type(v) == "table" then
+                if not visitedTable[tostring(v)] then
+                    visitedTable[tostring(v)] = 1
+                    t[k] = sanitizeTable(v)
+                else
+                    t[k] = "visited " .. tostring(v)
+                end
+            else
+                t[k] = v
+            end
+        end
+        return t
+    end
+
+    return sanitizeTable(t)
+end
+
+debug.mt = {
+    __index = function(t, key)
+        if rawget(t,"killed") ~= nil or key == 'onSimulationFrame' or key == 'RPC' then
+            return
+        end
+        if key == 'onMissionLoadEnd' then
+            utils.loadScript('DCSServerBot.lua')
+            utils.loadScript('debug/mission.lua')
+        end
+        return function(...)
+            js = JSON:encode(sanitizer(arg))
+            log.write('EVENT DEBUGGER', log.DEBUG, key .. '(' .. js .. ')')
+            visitedTable = {}
+        end
+    end
+}
+
+debug.kill = function(o)
+    rawset(o,"killed", true)
+    setmetatable(o,{})
+    return o
+end
+
+debug.new = function(o)
+    setmetatable(o, debug.mt)
+    return o
+end
+
+local h = debug.new({})
+
+DCS.setUserCallbacks(h)

plugins/debug/lua/mission.lua

@@ -0,0 +1,70 @@
+local base	= _G
+dcsbot 		= base.dcsbot
+local JSON 	= loadfile(lfs.currentdir() .. "Scripts\\JSON.lua")()
+
+
+local event_by_id = {}
+local function sanitizer(t)
+    local visitedTable = {}
+    local function sanitizeTable(ta)
+        local t = {}
+        for k, v in pairs(ta) do
+            if type(v) == "number" then
+                if v == math.huge or v == -math.huge then
+                    v = nil
+                end
+                if v ~= v then
+                    v = "NAN"
+                end
+            end
+            if type(k) == "string" then
+            else
+                k = tostring(k)
+            end
+            t[k] = k
+            if type(v) == "function" then
+                t[k] = "function"
+            elseif type(v) == "userdata" then
+                t[k] = "userdata"
+            elseif type(v) == "table" then
+                if not visitedTable[tostring(v)] then
+                    visitedTable[tostring(v)] = 1
+                    t[k] = sanitizeTable(v)
+                else
+                    t[k] = "visited " .. tostring(v)
+                end
+            else
+                t[k] = v
+            end
+        end
+        return t
+    end
+
+    return sanitizeTable(t)
+end
+
+dcsbot.debugEventHandler = {}
+function dcsbot.debugEventHandler:onEvent(event)
+	status, err = pcall(onEvent, event)
+	if not status then
+		env.warning("DCSServerBot - Error during Debug:onEvent(): " .. err)
+	end
+end
+
+function onEvent(event)
+    if not event then
+        return
+    end
+    log.write('EVENT DEBUGGER', log.DEBUG, event_by_id[event.id] .. '(' .. JSON:encode(sanitizer(event)) .. ')')
+end
+
+
+if not dcsbot.debug_enabled then
+    for k, v in pairs(world.event) do
+        event_by_id[v] = k
+    end
+
+    world.addEventHandler(dcsbot.debugEventHandler)
+    env.info('DCSServerBot - Event-Debugger enabled.')
+    dcsbot.debug_enabled = true
+end

plugins/debug/version.py

@@ -0,0 +1 @@
+__version__ = "3.0"