Sprint 1 (#10)

* feat(FileMgr/BaseObj): Added implicit path conversion

Closes #9

* feat(Game/GTA): implemented script globals

Closes #2

* fix(ScriptGlobal): code style

* feat(Game/GTA): implement script locals

Closes #3

* refactor: update namespace name

Closes #8

.vscode/settings.json

@@ -75,7 +75,20 @@
         "span": "cpp",
         "unordered_map": "cpp",
         "xhash": "cpp",
-        "filesystem": "cpp"
+        "filesystem": "cpp",
+        "any": "cpp",
+        "csignal": "cpp",
+        "cstdarg": "cpp",
+        "future": "cpp",
+        "map": "cpp",
+        "numeric": "cpp",
+        "random": "cpp",
+        "regex": "cpp",
+        "set": "cpp",
+        "unordered_set": "cpp",
+        "valarray": "cpp",
+        "variant": "cpp",
+        "xtree": "cpp"
     },
     "C_Cpp.default.configurationProvider": "maxmitti.cmake-tools-fork"
 }

src/common.cpp

@@ -1,6 +1,6 @@
 #include "common.hpp"
 
-namespace NewBase
+namespace YimMenu
 {
 	std::atomic<bool> g_Running{true};
 	HINSTANCE g_DllInstance{nullptr};

src/common.hpp

@@ -24,7 +24,7 @@
 using namespace al;
 #include "core/logger/LogHelper.hpp"
 
-namespace NewBase
+namespace YimMenu
 {
 	using namespace std::chrono_literals;
 

src/core/filemgr/BaseObj.cpp

@@ -1,6 +1,6 @@
 #include "BaseObj.hpp"
 
-namespace NewBase
+namespace YimMenu
 {
     BaseObj::BaseObj(const std::filesystem::path& path) :
         m_Path(path)

src/core/filemgr/BaseObj.hpp

@@ -1,7 +1,7 @@
 #pragma once
 #include <filesystem>
 
-namespace NewBase
+namespace YimMenu
 {
     class BaseObj
     {
@@ -11,6 +11,11 @@ namespace NewBase
         [[nodiscard]] bool Exists() const;
         const std::filesystem::path& Path() const;
 
+        operator std::filesystem::path() const
+        {
+            return m_Path;
+        }
+
     protected:
         const std::filesystem::path m_Path;
 

src/core/filemgr/File.cpp

@@ -1,7 +1,7 @@
 #include "File.hpp"
 #include "FileMgr.hpp"
 
-namespace NewBase
+namespace YimMenu
 {
     File::File(const std::filesystem::path& path) :
         BaseObj(path)

src/core/filemgr/File.hpp

@@ -1,7 +1,7 @@
 #pragma once
 #include "BaseObj.hpp"
 
-namespace NewBase
+namespace YimMenu
 {
     class File final : public BaseObj
     {

src/core/filemgr/FileMgr.cpp

@@ -2,7 +2,7 @@
 #include "File.hpp"
 #include "Folder.hpp"
 
-namespace NewBase
+namespace YimMenu
 {
     void FileMgr::Init(const std::filesystem::path& rootFolder)
     {

src/core/filemgr/FileMgr.hpp

@@ -3,7 +3,7 @@
 #include "File.hpp"
 #include "Folder.hpp"
 
-namespace NewBase
+namespace YimMenu
 {
     class FileMgr final
     {

src/core/filemgr/Folder.cpp

@@ -1,7 +1,7 @@
 #include "Folder.hpp"
 #include "FileMgr.hpp"
 
-namespace NewBase
+namespace YimMenu
 {
     Folder::Folder(const std::filesystem::path& path) :
         BaseObj(path)

src/core/filemgr/Folder.hpp

@@ -1,7 +1,7 @@
 #pragma once
 #include "BaseObj.hpp"
 
-namespace NewBase
+namespace YimMenu
 {
     class Folder final : public BaseObj
     {

src/core/hooking/BaseHook.cpp

@@ -2,7 +2,7 @@
 
 #include <MinHook.h>
 
-namespace NewBase
+namespace YimMenu
 {
 	BaseHook::BaseHook(const std::string_view name) :
 	    m_Name(name),

src/core/hooking/BaseHook.hpp

@@ -1,7 +1,7 @@
 #pragma once
 #include <string_view>
 
-namespace NewBase
+namespace YimMenu
 {
 	class BaseHook
 	{

src/core/hooking/DetourHook.hpp

@@ -5,7 +5,7 @@
 #include <MinHook.h>
 #include <string_view>
 
-namespace NewBase
+namespace YimMenu
 {
 	template<typename T = int*>
 	class DetourHook : public BaseHook

src/core/hooking/Hooking.cpp

@@ -6,7 +6,7 @@
 #include "game/hooks/Hooks.hpp"
 #include "game/pointers/Pointers.hpp"
 
-namespace NewBase
+namespace YimMenu
 {
 	Hooking::Hooking()
 	{

src/core/hooking/Hooking.hpp

@@ -1,7 +1,7 @@
 #pragma once
 #include "MinHook.hpp"
 
-namespace NewBase
+namespace YimMenu
 {
 	class Hooking
 	{

src/core/hooking/IATHook.hpp

@@ -3,7 +3,7 @@
 #include "memory/Module.hpp"
 #include "memory/PointerCalculator.hpp"
 
-namespace NewBase
+namespace YimMenu
 {
 	template<typename T = int*>
 	class IATHook : public BaseHook

src/core/hooking/MinHook.hpp

@@ -1,7 +1,7 @@
 #pragma once
 #include <MinHook.h>
 
-namespace NewBase
+namespace YimMenu
 {
 	class MinHook
 	{

src/core/hooking/VMTHook.hpp

@@ -5,7 +5,7 @@
 #include <cstddef>
 #include <string_view>
 
-namespace NewBase
+namespace YimMenu
 {
 	template<std::size_t N>
 	class VMTHook : public BaseHook

src/core/logger/LogColor.hpp

@@ -1,6 +1,6 @@
 #pragma once
 
-namespace NewBase
+namespace YimMenu
 {
 	enum class LogColor
 	{

src/core/logger/LogHelper.cpp

@@ -2,7 +2,7 @@
 
 #include "LogSink.hpp"
 
-namespace NewBase
+namespace YimMenu
 {
 	void LogHelper::Destroy()
 	{

src/core/logger/LogHelper.hpp

@@ -3,7 +3,7 @@
 #include <fstream>
 #include <iostream>
 
-namespace NewBase
+namespace YimMenu
 {
 #define ADD_COLOR_TO_STREAM(color) "\x1b[" << int(color) << "m"
 #define RESET_STREAM_COLOR "\x1b[0m"

src/core/logger/LogSink.cpp

@@ -2,7 +2,7 @@
 
 #include "LogColor.hpp"
 
-namespace NewBase
+namespace YimMenu
 {
 	LogColor LogSink::GetColor(const eLogLevel level)
 	{

src/core/logger/LogSink.hpp

@@ -4,7 +4,7 @@
 #include <string>
 
 
-namespace NewBase
+namespace YimMenu
 {
 	using namespace al;
 	enum class LogColor;

src/core/memory/BytePatch.cpp

@@ -1,6 +1,6 @@
 #include "BytePatch.hpp"
 
-namespace NewBase
+namespace YimMenu
 {
     BytePatch::~BytePatch()
     {

src/core/memory/BytePatch.hpp

@@ -3,7 +3,7 @@
 #include <span>
 #include <vector>
 
-namespace NewBase
+namespace YimMenu
 {
     template<typename T>
     concept SpanCompatibleType = requires(T a)

src/core/memory/Module.cpp

@@ -1,6 +1,6 @@
 #include "Module.hpp"
 
-namespace NewBase
+namespace YimMenu
 {
 	Module::Module(LDR_DATA_TABLE_ENTRY* dllEntry) :
 	    m_Path(dllEntry->FullDllName.Buffer),

src/core/memory/Module.hpp

@@ -4,7 +4,7 @@
 
 #include <winternl.h>
 
-namespace NewBase
+namespace YimMenu
 {
 	class Module
 	{

src/core/memory/ModuleMgr.cpp

@@ -2,7 +2,7 @@
 
 #include "util/Joaat.hpp"
 
-namespace NewBase
+namespace YimMenu
 {
 	Module* ModuleMgr::Get(const std::string_view name)
 	{

src/core/memory/ModuleMgr.hpp

@@ -2,7 +2,7 @@
 #include "Module.hpp"
 #include "common.hpp"
 
-namespace NewBase
+namespace YimMenu
 {
 	using joaat_t = std::uint32_t;
 
@@ -31,5 +31,5 @@ namespace NewBase
 		std::unordered_map<std::uint32_t, std::unique_ptr<Module>> m_CachedModules;
 	};
 
-	inline NewBase::ModuleMgr ModuleMgr;
+	inline YimMenu::ModuleMgr ModuleMgr;
 }

src/core/memory/Pattern.hpp

@@ -3,7 +3,7 @@
 
 #include <string_view>
 
-namespace NewBase
+namespace YimMenu
 {
 	template<std::size_t N>
 	struct Signature

src/core/memory/PatternScanner.cpp

@@ -4,7 +4,7 @@
 
 #include <future>
 
-namespace NewBase
+namespace YimMenu
 {
 	PatternScanner::PatternScanner(const Module* module) :
 	    m_Module(module),

src/core/memory/PatternScanner.hpp

@@ -5,7 +5,7 @@
 #include <functional>
 #include <vector>
 
-namespace NewBase
+namespace YimMenu
 {
 	class Module;
 	using PatternFunc = std::function<void(PointerCalculator)>;

src/core/memory/PointerCalculator.hpp

@@ -2,7 +2,7 @@
 #include <cstdint>
 #include <type_traits>
 
-namespace NewBase
+namespace YimMenu
 {
 	class PointerCalculator final
 	{

src/core/renderer/Renderer.cpp

@@ -6,7 +6,7 @@
 #include <backends/imgui_impl_win32.h>
 #include <imgui.h>
 
-namespace NewBase
+namespace YimMenu
 {
 	Renderer::Renderer()
 	{

src/core/renderer/Renderer.hpp

@@ -6,7 +6,7 @@
 #include <map>
 #include <windows.h>
 
-namespace NewBase
+namespace YimMenu
 {
 	using DXCallback              = std::function<void()>;
 	using WindowProcedureCallback = std::function<void(HWND, UINT, WPARAM, LPARAM)>;

src/game/frontend/GUI.cpp

@@ -3,7 +3,7 @@
 #include "menu/Menu.hpp"
 #include "core/renderer/Renderer.hpp"
 
-namespace NewBase
+namespace YimMenu
 {
 	GUI::GUI() :
 		m_IsOpen(false)

src/game/frontend/GUI.hpp

@@ -1,7 +1,7 @@
 #pragma once
 #include <windows.h>
 
-namespace NewBase
+namespace YimMenu
 {
 	class GUI final
 	{

src/game/frontend/menu/Menu.cpp

@@ -1,6 +1,6 @@
 #include "Menu.hpp"
 
-namespace NewBase
+namespace YimMenu
 {
 	void Menu::Main()
 	{

src/game/frontend/menu/Menu.hpp

@@ -1,7 +1,7 @@
 #pragma once
 #include "game/frontend/GUI.hpp"
 
-namespace NewBase::Menu
+namespace YimMenu::Menu
 {
 	extern void Main();
 }

src/game/gta/ScriptGlobal.cpp

@@ -0,0 +1,10 @@
+#include "game/pointers/Pointers.hpp"
+#include "ScriptGlobal.hpp"
+
+namespace YimMenu
+{
+    void* ScriptGlobal::Get() const
+    {
+        return Pointers.ScriptGlobals[m_Index >> 0x12 & 0x3F] + (m_Index & 0x3FFFF);
+    }
+}

src/game/gta/ScriptGlobal.hpp

@@ -0,0 +1,44 @@
+#pragma once
+#include <cstddef>
+#include <type_traits>
+
+namespace YimMenu
+{
+    class ScriptGlobal
+    {
+    private:
+        std::size_t m_Index;
+
+    public:
+        constexpr ScriptGlobal(std::size_t idx) :
+            m_Index(idx)
+        {}
+        
+        constexpr ScriptGlobal At(std::ptrdiff_t offset) const
+        {
+            return m_Index + offset;
+        }
+
+        constexpr ScriptGlobal At(std::ptrdiff_t offset, std::size_t size) const
+        {
+            return m_Index + 1 + offset * size;
+        }
+        
+        template<typename T>
+		inline std::enable_if_t<std::is_pointer_v<T>, T> As() const
+		{
+			return static_cast<T>(Get());
+		}
+
+		template<typename T>
+		inline std::enable_if_t<std::is_lvalue_reference_v<T>, T> As() const
+		{
+			return *static_cast<std::add_pointer_t<std::remove_reference_t<T>>>(Get());
+		}
+
+    private:
+        void* Get() const;
+
+    };
+    
+}

src/game/gta/ScriptLocal.cpp

@@ -0,0 +1,9 @@
+#include "ScriptLocal.hpp"
+
+namespace YimMenu
+{
+	void* ScriptLocal::Get() const
+	{
+		return reinterpret_cast<uintptr_t*>((uintptr_t)m_StackPtr + (m_Index * sizeof(uintptr_t)));
+	}
+}

src/game/gta/ScriptLocal.hpp

@@ -0,0 +1,72 @@
+#pragma once
+#include <cstddef>
+#include <type_traits>
+
+namespace YimMenu
+{
+    class ScriptLocal
+    {
+    private:
+        std::size_t m_Index;
+        void* m_StackPtr;
+
+    public:
+        constexpr ScriptLocal(std::size_t index) :
+            m_Index(index),
+            m_StackPtr(nullptr)
+        {
+
+        }
+
+        constexpr ScriptLocal(void* stackPtr, std::size_t index) :
+            m_Index(index),
+            m_StackPtr(stackPtr)
+        {
+
+        }
+
+        // TODO: Uncomment when GTAV-Classes have been added
+        // constexpr ScriptLocal(rage::scrThread* thread, std::size_t index) :
+        //     ScriptLocal(thread->m_stack, index)
+        // {
+
+        // }
+
+        constexpr ScriptLocal At(std::ptrdiff_t offset) const
+        {
+            return { m_StackPtr, m_Index + offset };
+        }
+
+        constexpr ScriptLocal At(std::ptrdiff_t offset, std::size_t size) const
+        {
+            return { m_StackPtr, m_Index + 1 + offset * size };
+        }
+
+        constexpr ScriptLocal Set(void* stackPtr)
+        {
+            return { stackPtr, m_Index };
+        }
+
+        // TODO: Uncomment when GTAV-Classes have been added
+        // constexpr ScriptLocal Set(rage::scrThread* thread)
+        // {
+        //     return { thread, m_Index };
+        // }
+
+        template<typename T>
+		std::enable_if_t<std::is_pointer_v<T>, T> As()
+		{
+			return static_cast<T>(Get());
+		}
+
+		template<typename T>
+		std::enable_if_t<std::is_lvalue_reference_v<T>, T> As()
+		{
+			return *static_cast<std::add_pointer_t<std::remove_reference_t<T>>>(Get());
+		}
+
+    private:
+        void* Get() const;
+
+    };
+}

src/game/hooks/GUI/SwapChain.cpp

@@ -2,7 +2,7 @@
 #include "core/renderer/Renderer.hpp"
 #include "game/hooks/Hooks.hpp"
 
-namespace NewBase
+namespace YimMenu
 {
 	HRESULT SwapChain::Present(IDXGISwapChain* that, UINT syncInterval, UINT flags)
 	{

src/game/hooks/GUI/Window.cpp

@@ -3,7 +3,7 @@
 #include "game/hooks/Hooks.hpp"
 
 
-namespace NewBase
+namespace YimMenu
 {
 	LRESULT Window::WndProc(HWND hwnd, UINT umsg, WPARAM wparam, LPARAM lparam)
 	{

src/game/hooks/Hooks.hpp

@@ -1,7 +1,7 @@
 #pragma once
 #include <d3d11.h>
 
-namespace NewBase
+namespace YimMenu
 {
 	namespace SwapChain
 	{

src/game/pointers/Pointers.cpp

@@ -5,7 +5,7 @@
 #include "core/memory/PatternScanner.hpp"
 #include "util/Joaat.hpp"
 
-namespace NewBase
+namespace YimMenu
 {
 	bool Pointers::Init()
 	{

src/game/pointers/Pointers.hpp

@@ -2,13 +2,14 @@
 #include <d3d11.h>
 #include <windows.h>
 
-namespace NewBase
+namespace YimMenu
 {
 	struct PointerData
 	{
 		IDXGISwapChain** SwapChain;
 		HWND Hwnd;
 		WNDPROC WndProc;
+		std::int64_t** ScriptGlobals;
 	};
 
 	struct Pointers : PointerData
@@ -16,5 +17,5 @@ namespace NewBase
 		bool Init();
 	};
 
-	inline NewBase::Pointers Pointers;
+	inline YimMenu::Pointers Pointers;
 }

src/main.cpp

@@ -7,14 +7,14 @@
 #include "game/pointers/Pointers.hpp"
 
 
-namespace NewBase
+namespace YimMenu
 {
 	DWORD Main(void*)
 	{
 		const auto documents = std::filesystem::path(std::getenv("USERPROFILE")) / "Documents";
 		FileMgr::Init(documents / "HellBase");
 
-		LogHelper::Init("henlo", FileMgr::GetProjectFile("./cout.log").Path());
+		LogHelper::Init("henlo", FileMgr::GetProjectFile("./cout.log"));
 
 		if (!ModuleMgr.LoadModules())
 			goto unload;
@@ -44,7 +44,7 @@ namespace NewBase
 
 BOOL WINAPI DllMain(HINSTANCE dllInstance, DWORD reason, void*)
 {
-	using namespace NewBase;
+	using namespace YimMenu;
 
 	DisableThreadLibraryCalls(dllInstance);
 

src/util/Joaat.cpp

@@ -1,6 +1,6 @@
 #include "Joaat.hpp"
 
-namespace NewBase
+namespace YimMenu
 {
 	constexpr joaat_t Joaat(const std::string_view str)
 	{

src/util/Joaat.hpp

@@ -2,7 +2,7 @@
 #include <cstdint>
 #include <string_view>
 
-namespace NewBase
+namespace YimMenu
 {
 	using joaat_t = std::uint32_t;
 

src/util/StrToHex.hpp

@@ -1,7 +1,7 @@
 #pragma once
 #include <cstdint>
 
-namespace NewBase
+namespace YimMenu
 {
 	inline constexpr std::uint8_t StrToHex(const char& ch) noexcept
 	{