From 646f0996545382e8d64c8bac030677c3625e922f Mon Sep 17 00:00:00 2001 From: Yimura Date: Tue, 9 Nov 2021 01:43:19 +0100 Subject: [PATCH] feat(README): Updated --- README.md | 28 ++++++++++++++++++++-------- 1 file changed, 20 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index aab44ae9..617d7be3 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,32 @@ -# BigBaseV2 +# YimMenu made possible by BigBaseV2 A mod menu base for Grand Theft Auto V. Strictly for educational purposes. +I can't confirm if all hooks are correct as the report myself event hook probably is incorrect. All the other hooks should be correct and server their purpose. + +## Structure + +- `api/` contains some basic example of how I'd make REST api calls +- `backend/` all features that should be ran in a loop are in here sorted by category +- `gui/` includes everything related to UI elements +- `hooks/` function hooks +- `native_hooks/` hooks to natives, currently not implemented +- `services/` service files to interact and maintain stuff +- `util/` general utility functions to keep code as compact and as much in one place as possible + ## Features - Return Native spoofing - -## Protections - - - Event Registry RETURN opcode byte patching - - NOP Incompatible Version check from net array - - Freemode script recovery (GTA Thread Tick/Kill) + - Custom [settings](BigBaseV2/src/core/globals.hpp) with deep compare if changes were made include auto saving + - Clear and well structured source code + - Includes a thread pool to queue tasks that shouldn't block the game thread, very similar to fiber pool + - Updated natives.hpp from https://nativedb.pieceof.art/natives + - Includes basic code samples to interact with an api + - ReClass.NET structures implemented, accessible from a global called g_local_player defined in `common.hpp` To set up the build environment, run the following commands in a terminal: ```dos -git clone git@github.com:Yimura/YimMenu.git --recurse-submodules +git clone git@github.com:Yimura/YimMenu.git --recursive cd YimMenu GenerateProjects.bat ```