61 lines
2.7 KiB
Markdown
61 lines
2.7 KiB
Markdown
# YimMenu
|
|
|
|
 
|
|
|
|
A mod menu base for Grand Theft Auto V.
|
|
Strictly for educational purposes.
|
|
|
|
YimMenu is originally based of off [BigBaseV2](https://github.com/Pocakking/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 focusing on protecting the user from toxic modders.
|
|
|
|
## Table of contents
|
|
|
|
* [How to build](#how-to-build)
|
|
* [Make your own flavour of YimMenu](#make-your-own-flavour-of-yimmenu)
|
|
* [Staying Up To Date](#staying-up-to-date)
|
|
* [Project Structure](#project-structure)
|
|
* [Features](#features)
|
|
* [Contributing](#contributing)
|
|
|
|
## How to compile YimMenu
|
|
|
|
Read the [SETUP](https://github.com/YimMenu/YimMenu/wiki/Setup-your-PC-for-YimMenu-Development) guide.
|
|
|
|
## Make your own flavour of YimMenu
|
|
|
|
Fork YimMenu and git clone that repository instead of https://github.com/YimMenu/YimMenu.git
|
|
|
|
Click the below link to make your own fork of YimMenu:
|
|
https://github.com/YimMenu/YimMenu/fork
|
|
|
|
## Staying Up To Date
|
|
|
|
Pull the latest changes from this repository.
|
|
|
|
With a command line it is as easy as:
|
|
|
|
```bash
|
|
git pull
|
|
```
|
|
|
|
CMake should be handling removed / added files automatically without any user input.
|
|
|
|
If this is not the case for some reason you'll have to redo the steps in the [Making changes to the source code section of the SETUP](https://github.com/YimMenu/YimMenu/wiki/Setup-your-PC-for-YimMenu-Development#making-changes-to-the-source-code).
|
|
|
|
If you are doing custom modifications to the codebase and have a fork you are on your own for staying up to date with upstream (this repository), google stuff like "merge from upstream" and learn how to use Git.
|
|
|
|
## 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
|
|
|
|
## Contributing
|
|
|
|
You're free to contribute to YimMenu as long as the features are useful, not overly toxic and do not contain anything money related that might get the menu targeted by Take2.
|
|
|
|
Make sure to read the [CONTRIBUTING.md](CONTRIBUTING.md) file.
|