refactor!: repo cleanup (#2650)

- Move cmake files to dedicated cmake folder
- Move scattered python files to `scripts/` folder
- Update CMakeLists.txt to reflect changes
* feat(scripts): add README to folder

CMakeLists.txt

@@ -5,19 +5,19 @@ project(YimMenu CXX ASM_MASM)
 set(SRC_DIR "${PROJECT_SOURCE_DIR}/src")
 
 # Git commit embed
-include(scripts/git.cmake)
+include(cmake/git.cmake)
 
 # Fetch modules
 message("\nFetching modules")
-include(scripts/minhook.cmake)
-include(scripts/async-logger.cmake)
-include(scripts/pugixml.cmake)
-include(scripts/json.cmake)
-include(scripts/cpr.cmake)
-include(scripts/lua.cmake)
-include(scripts/imgui.cmake)
+include(cmake/minhook.cmake)
+include(cmake/async-logger.cmake)
+include(cmake/pugixml.cmake)
+include(cmake/json.cmake)
+include(cmake/cpr.cmake)
+include(cmake/lua.cmake)
+include(cmake/imgui.cmake)
 message("\nFetching custom modules")
-include(scripts/gtav-classes.cmake)
+include(cmake/gtav-classes.cmake)
 
 
 # YimMenu

cmake/async-logger.cmake

@@ -1,12 +1,12 @@
-include(FetchContent)
-
-message("AsyncLogger")
-FetchContent_Declare(
-    AsyncLogger
-    GIT_REPOSITORY https://github.com/Yimura/AsyncLogger.git
-    GIT_TAG v0.0.6
-    GIT_PROGRESS TRUE
-)
-FetchContent_MakeAvailable(AsyncLogger)
-
-set_property(TARGET AsyncLogger PROPERTY CXX_STANDARD 23)
+include(FetchContent)
+
+message("AsyncLogger")
+FetchContent_Declare(
+    AsyncLogger
+    GIT_REPOSITORY https://github.com/Yimura/AsyncLogger.git
+    GIT_TAG v0.0.6
+    GIT_PROGRESS TRUE
+)
+FetchContent_MakeAvailable(AsyncLogger)
+
+set_property(TARGET AsyncLogger PROPERTY CXX_STANDARD 23)

scripts/README.md

@@ -0,0 +1,39 @@
+# Scripts
+
+This directory contains a collection of scripts used to generate certain parts of the code base.
+
+## Doc Gen
+
+`doc_gen.py` is used to generate the Lua documentation that's provided by YimMenu.
+It relies on specifically formatted code comments to generate Lua documentation.
+
+## Generate Natives
+
+`generate_natives.py` is responsible for generating the `src/natives.hpp` and `src/invoker/crossmap.hpp` files.
+
+It takes a `natives.json` from [here](https://github.com/alloc8or/gta5-nativedb-data) and a `crossmap.txt` file which needs follow a certain format of:
+```csv
+[first_seen_native_hash]<comma>[current_native_hash]
+```
+
+Example:
+```csv
+0xE1A0450ED46A7812,0x11FD21BA1B765FE2
+0x39BE7CEA8D9CC8E6,0x5F7C6361179DFFC4
+0x3C5FD37B5499582E,0x54BC5E0B6A29AE8A
+0xE2A99A9B524BEFFF,0x1FDE21A286357401
+0x51F1A8E48C3D2F6D,0xD1BAD83E70275AEB
+0x0A6D923DFFC9BD89,0x93693D93BD53ACB1
+0x112CEF1615A1139F,0x203607236413B185
+0xD47A2C1BA117471D,0x4F3198DEED415E95
+0xC2F7FE5309181C7D,0xCFE92984BF3486D5
+0x23789E777D14CE44,0x2B3725FC402B94A8
+0x350AA5EBC03D3BD2,0x606408352C7741AD
+0x498C1E05CE5F7877,0x59E8FA762FB527C5
+...
+```
+
+## Natives Gen
+
+`natives_gen.py` is used to generate the Lua bindings for all the natives currently present in the menu.
+It'll read through the `src/natives.hpp` file and generate the appropriate bindings under `src/lua/natives/`.

scripts/generate_natives.py

@@ -1,123 +1,123 @@
-import json
-
-crossmap = {}
-natives = {}
-current_idx = 0
-crossmap_hash_list = []
-
-class Arg:
-    def __init__(self, name: str, type: str):
-        self.name = name
-        self.type = type#.replace("BOOL", "bool")# .replace("Any*", "void*")
-
-    def __str__(self) -> str:
-        return str(self.type) + " " + str(self.name)
-
-class NativeFunc:
-    def __init__(self, namespace: str, name: str, hash: int, args: list[dict], return_type: str):
-        self.namespace = namespace
-        self.name = name
-        self.hash = hash
-        self.args: list[Arg] = []
-        self.return_type = return_type#.replace("BOOL", "bool")# .replace("Any*", "void*")
-        self.native_index = -1
-        self.fix_vectors = "false"
-
-        for arg in args:
-            self.args.append(Arg(arg["name"], arg["type"]))
-            if arg["type"] == "Vector3*":
-                self.fix_vectors = "true"
-    
-    def get_native_def_str(self) -> str:
-        assert self.native_index != -1
-
-        param_decl = ""
-        param_pass = ""
-        if len(self.args) > 0:
-            for arg in self.args:
-                param_decl += str(arg) + ", "
-                param_pass += arg.name + ", "
-            param_decl = param_decl[:-2]
-            param_pass = param_pass[:-2]
-        
-        return f"FORCEINLINE constexpr {self.return_type} {self.name}({param_decl}) {{ return big::native_invoker::invoke<{self.native_index}, {self.fix_vectors}, {self.return_type}>({param_pass}); }}"
-
-class CrossmapEntry:
-    def __init__(self, translated_hash: int):
-        self.hash = translated_hash
-        self.native_index = -1
-
-def load_crossmap_data():
-    global crossmap
-
-    data = open("crossmap.txt").readlines()
-    for item in data:
-        translation = item.split(",")
-        crossmap[int(translation[0], 16)] = CrossmapEntry(int(translation[1], 16))
-
-def load_natives_data():
-    global natives
-
-    data = json.load(open("natives.json"))
-    for ns, natives_list in data.items():
-        natives[ns] = []
-        for hash_str, native_data in natives_list.items():
-            natives[ns].append(NativeFunc(ns, native_data["name"], int(hash_str, 16), native_data["params"], native_data["return_type"]))
-
-def allocate_indices():
-    global current_idx, crossmap_hash_list
-
-    for _, n in natives.items():
-        for native in n:
-            hash = native.hash
-            if hash in crossmap:
-                crossmap[hash].native_index = current_idx
-                native.native_index = current_idx
-                crossmap_hash_list.append(crossmap[hash].hash)
-                current_idx += 1
-
-
-def write_crossmap_header():
-        open("crossmap.hpp", "w+").write(f"""#pragma once
-#include <script/scrNativeHandler.hpp>
-
-namespace big
-{{
-	constexpr std::array<rage::scrNativeHash, {len(crossmap_hash_list)}> g_crossmap = {{{",".join([f"0x{x:X}" for x in crossmap_hash_list])}}};
-}}
-""")
-
-def write_natives_header():
-    natives_buf = ""
-    natives_index_buf = ""
-
-    for ns, nvs in natives.items():
-        natives_buf += f"namespace {ns}\n{{\n"
-        for nat_data in nvs:
-            if nat_data.native_index == -1:
-                continue
-
-            natives_buf += f"\t{nat_data.get_native_def_str()}\n"
-            natives_index_buf += f"\t{nat_data.name} = {nat_data.native_index},\n"
-        natives_buf += "}\n\n"
-    
-    natives_buf = natives_buf[:-2]
-
-    open("../natives.hpp", "w+").write(f"""#pragma once
-#include "invoker/invoker.hpp"
-
-// clang-format off
-enum class NativeIndex
-{{
-{natives_index_buf}}};
-
-{natives_buf}
-// clang-format on
-""")
-    
-if __name__ == "__main__":
-    load_crossmap_data()
-    load_natives_data()
-    allocate_indices()
-    write_crossmap_header()
+import json
+
+crossmap = {}
+natives = {}
+current_idx = 0
+crossmap_hash_list = []
+
+class Arg:
+    def __init__(self, name: str, type: str):
+        self.name = name
+        self.type = type#.replace("BOOL", "bool")# .replace("Any*", "void*")
+
+    def __str__(self) -> str:
+        return str(self.type) + " " + str(self.name)
+
+class NativeFunc:
+    def __init__(self, namespace: str, name: str, hash: int, args: list[dict], return_type: str):
+        self.namespace = namespace
+        self.name = name
+        self.hash = hash
+        self.args: list[Arg] = []
+        self.return_type = return_type#.replace("BOOL", "bool")# .replace("Any*", "void*")
+        self.native_index = -1
+        self.fix_vectors = "false"
+
+        for arg in args:
+            self.args.append(Arg(arg["name"], arg["type"]))
+            if arg["type"] == "Vector3*":
+                self.fix_vectors = "true"
+    
+    def get_native_def_str(self) -> str:
+        assert self.native_index != -1
+
+        param_decl = ""
+        param_pass = ""
+        if len(self.args) > 0:
+            for arg in self.args:
+                param_decl += str(arg) + ", "
+                param_pass += arg.name + ", "
+            param_decl = param_decl[:-2]
+            param_pass = param_pass[:-2]
+        
+        return f"FORCEINLINE constexpr {self.return_type} {self.name}({param_decl}) {{ return big::native_invoker::invoke<{self.native_index}, {self.fix_vectors}, {self.return_type}>({param_pass}); }}"
+
+class CrossmapEntry:
+    def __init__(self, translated_hash: int):
+        self.hash = translated_hash
+        self.native_index = -1
+
+def load_crossmap_data():
+    global crossmap
+
+    data = open("crossmap.txt").readlines()
+    for item in data:
+        translation = item.split(",")
+        crossmap[int(translation[0], 16)] = CrossmapEntry(int(translation[1], 16))
+
+def load_natives_data():
+    global natives
+
+    data = json.load(open("natives.json"))
+    for ns, natives_list in data.items():
+        natives[ns] = []
+        for hash_str, native_data in natives_list.items():
+            natives[ns].append(NativeFunc(ns, native_data["name"], int(hash_str, 16), native_data["params"], native_data["return_type"]))
+
+def allocate_indices():
+    global current_idx, crossmap_hash_list
+
+    for _, n in natives.items():
+        for native in n:
+            hash = native.hash
+            if hash in crossmap:
+                crossmap[hash].native_index = current_idx
+                native.native_index = current_idx
+                crossmap_hash_list.append(crossmap[hash].hash)
+                current_idx += 1
+
+
+def write_crossmap_header():
+        open("crossmap.hpp", "w+").write(f"""#pragma once
+#include <script/scrNativeHandler.hpp>
+
+namespace big
+{{
+	constexpr std::array<rage::scrNativeHash, {len(crossmap_hash_list)}> g_crossmap = {{{",".join([f"0x{x:X}" for x in crossmap_hash_list])}}};
+}}
+""")
+
+def write_natives_header():
+    natives_buf = ""
+    natives_index_buf = ""
+
+    for ns, nvs in natives.items():
+        natives_buf += f"namespace {ns}\n{{\n"
+        for nat_data in nvs:
+            if nat_data.native_index == -1:
+                continue
+
+            natives_buf += f"\t{nat_data.get_native_def_str()}\n"
+            natives_index_buf += f"\t{nat_data.name} = {nat_data.native_index},\n"
+        natives_buf += "}\n\n"
+    
+    natives_buf = natives_buf[:-2]
+
+    open("../natives.hpp", "w+").write(f"""#pragma once
+#include "invoker/invoker.hpp"
+
+// clang-format off
+enum class NativeIndex
+{{
+{natives_index_buf}}};
+
+{natives_buf}
+// clang-format on
+""")
+    
+if __name__ == "__main__":
+    load_crossmap_data()
+    load_natives_data()
+    allocate_indices()
+    write_crossmap_header()
     write_natives_header()