Pre-release preparations

Docs/SCRIPTING.md

@@ -7,6 +7,17 @@ Each script must contain two function: `on_load` and `on_frame`. Other than that
 `on_load` function is being executed once the script is loaded.  
 `on_frame` function is executed on each frame the target game outputs.
 
+## LUA
+To ensure scripting safety, the script is running inside a safe LUA sandbox that has a lot of features disabled. Whitelist approach is used.  
+Lua version used is 5.4  
+Standard library functions available:
+* All of the `string` module
+* All of the `math` module
+* Some of the `table` module
+* Coroutines
+* `os.clock`, `os.difftime`, `os.time` from os module
+* `tonumber`, `tostring`, and some other
+
 ## Sample script
 Below you can find a sample script file written for Need for Speed: Underground 2
 ```lua

InjectedTimer/ScriptEngine.cs

@@ -47,6 +47,7 @@ public void Dispose()
 
         Lua luaState;
 
+        // Original LUA sandbox code is taken from here https://stackoverflow.com/questions/1224708/how-can-i-create-a-secure-lua-sandbox
         private const string SANDBOX =
 """
 -- save a pointer to globals that would be unreachable in sandbox

SpeedTool/ImGuiCodeEditor/README.md

@@ -0,0 +1,13 @@
+## ImGuiCodeEditor
+
+Code editor for ImGui in C#!
+
+This is a direct by-hand translation of [ImGuiColorTextEditor](https://github.com/BalazsJako/ImGuiColorTextEdit) to C#
+
+I tried keeping it as close to original as possible, though a few lines are missing here and there, and some logic has been rewritten.
+
+There shouldn't be any missing functionality (besides broken UTF-8 as of now), though any bugreports are welcome.
+
+Plese notice that this code **is not very well teseted** and might fail here and there
+
+I am unsure if I will be improving this project any time soon

SpeedTool/ImGuiCodeEditor/TextEditor.cs

@@ -2034,11 +2034,18 @@ void HandleKeyboardInputs()
             io.WantTextInput = true;
 
             if (!IsReadOnly && ctrl && !shift && !alt && ImGui.IsKeyPressed(ImGui.GetKeyIndex(ImGuiKey.Z)))
-                Undo();
+            {
+                // Because of some issues in the code, undo and redo are temporarily disabled
+                // Undo();
+            }
             else if (!IsReadOnly && !ctrl && !shift && alt && ImGui.IsKeyPressed(ImGui.GetKeyIndex(ImGuiKey.Backspace)))
-                Undo();
+            {
+                // Undo();
+            }
             else if (!IsReadOnly && ctrl && !shift && !alt && ImGui.IsKeyPressed(ImGui.GetKeyIndex(ImGuiKey.Y)))
-                Redo();
+            {
+                // Redo();
+            }
             else if (!ctrl && !alt && ImGui.IsKeyPressed(ImGui.GetKeyIndex(ImGuiKey.UpArrow)))
                 MoveUp(1, shift);
             else if (!ctrl && !alt && ImGui.IsKeyPressed(ImGui.GetKeyIndex(ImGuiKey.DownArrow)))
@@ -2082,7 +2089,10 @@ void HandleKeyboardInputs()
             else if (!IsReadOnly && !ctrl && !shift && !alt && ImGui.IsKeyPressed(ImGui.GetKeyIndex(ImGuiKey.Enter)))
                 EnterCharacter('\n', false);
             else if (!IsReadOnly && !ctrl && !alt && ImGui.IsKeyPressed(ImGui.GetKeyIndex(ImGuiKey.Tab)))
-                EnterCharacter('\t', shift);
+            {
+                for(int i = 0; i < 4; i++)
+                    EnterCharacter(' ', shift);
+            }
 
             if (!IsReadOnly && io.InputQueueCharacters.Size != 0)
             {

SpeedTool/Windows/GameEditorWindow.cs

@@ -65,6 +65,7 @@ protected override void OnUI(double dt)
             {
                 ImGui.InputText("Game Name", ref Name, 255);
                 ImGui.InputText("Exe Name", ref ExeName, 255);
+                ImGuiExtensions.TooltipHint("Exe name should include .exe");
                 if(ExeName != "")
                 {
                     if(ImGui.Button("Edit script"))
@@ -313,6 +314,27 @@ function on_load()
 
 function on_frame()
     -- this function will be executed on each frame
+
+    --[[
+        Try hovering over those highlighted functions to see what they do :)
+        read_int(0xDEADBEEF)
+        read_float(0xDEADBEEF)
+        read_long(0xDEADBEEF)
+        read_double(0xDEADBEEF)
+        read_bytes(0xDEADBEEF, 16)
+        read_ascii(0xDEADBEEF, 16)
+        pointer_path(0xDEADBEEF, 0xC, 0x10, 0xCC)
+        module_base_address('kernel32.dll')
+
+        timer_set_loading()
+        timer_set_not_loading()
+
+        timer_start()
+        timer_split()
+
+        debug_message('Hello, world!')
+        debug_message(string.format('%d %d', 10, 20))
+    ]]
 end
 ";