YimMenu/README.md

YimMenu

A mod menu base for Grand Theft Auto V. Strictly for educational purposes.

YimMenu is originally based of off BigBaseV2 which was an amazing base at the time but nowadays is a bit dated. So here I am with an up-to-date menu focusses on protecting the user from toxic modders.

Table of contents

• How to build
  • Git
  • Premake5
  • Cloning and generating project files
• Staying Up To Date
• Project Structure
• Features
• Contributing

How to build

Requirements:

• Git
• CMake

If you have both of the above requirements you can skip to cloning the git repo and generating the project files.

Git

If you haven't installed git on your system go and do so it is REQUIRED for setting up a working build environment.

Download Link

CMake

CMake is used to generate our project files, if you haven't used it before we will need to download and install it.

Download Link

Cloning and generating project files

Clone the repository including submodules:

git clone https://github.com/YimMenu/YimMenu.git || echo "You don't have git installed, install it from https://git-scm.com/download/win"

Go into the directory you just cloned:

cd YimMenu

Generate project files:

mkdir build && cd build
cmake ..

Now, you will be able to open the solution, and simply build it in Visual Studio.

Staying Up To Date

git pull https://github.com/YimMenu/YimMenu.git
cd build
cmake ..

Project Structure

• 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
• 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

Below is an incomplete list of feature that I believe are notable to this "base" or menu.

• Return Native spoofing
• Custom settings 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.spyral.dev
• ReClass.NET structures implemented, accessible from a global called g_local_player defined in common.hpp

Contributing

You're free to contribute to YimMenu as long as the feature are useful, non-toxic and do not contain anything money related that might get the menu targetted by Take2.

Make sure to read the CONTRIBUTING.md file.