About

A modular GTA V Lua framework focused on enhancing the player's experience through fun features, online business options, and unpopular opinions.

Getting Started

Setup

• Download the latest zip archive from the releases section.

• Extract the archive and place the SSV2 folder in YimMenu's scripts folder:

   %AppData%\YimMenu\scripts
  

• Once in-game, press [F5] to toggle the script's UI.

Commands Console

• Use [F4] to toggle the console window.
• Type !ls or !dump to dump all available commands.
• All default commands are prefixed with an exclamation mark <!>.

Important

Do not use this in YimMenuV2. It will not work.

Contributing

Contributions are what make the open source community a great place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this project better, please fork the repo and create a pull request. You can also simply open a feature request.

Don't forget to give the project a star!

1. Fork the repo
2. Create your feature branch.
3. Commit your changes.
4. Open a Pull Request.

Refer to the Contribution Guidelines for more details on the project's structure and conventions.

Documentation

This project was rewritten from scratch using SmallBase. For API documentation, please refer to the docs.

Note

Some parts of the API were refactored or extended but nothing has drastically changed. All changes introduced in this project are documented in the source.

FAQ

• Q: Does this support Enhanced?

• A: Prtially. You can use YimLuaAPI to test it but stability is not guaranteed as of now.

• Q: What is YimLuaAPI and how do I use it?

• A:

  • What is it: YimLuaAPI is a universal Lua API that works for both Legacy and Enhanced.
  • How to use it: Right now there is no release because it's still in development. If you want to try it, you have to compile it yourself. Once you have YimLuaAPI.dll, inject it into any GTA branch (Legacy/Enhanced), it will create a folder on first injection: %AppData%\YimLuaAPI. Simply place the script there and you're done. You can still use YimMenu/YimMenuV2 but the script has to only exist in YimLuaAPI.

• Q: Why can't-I run this in YimMenuV2?

• A: There are several reasons why:

  • YimMenuV2 doesn't have a finished Lua API. require isn't even present, let alone custom bindings.
  • There are several versions and flavors of the Lua programming language. This project is written in Lua 5.4 and YimMenuV2's API uses LuaJIT. Explaining the difference here is not ideal but it's not only the language difference, it's also how they are embedded in each menu.

• Q: Can this be made compatible with YimMenuV2 once its API is finished?

• Short Answer: No.

• Long Answer: Yes, a compatibility layer can be added to accomodate for all language and API differences but is it worth the trouble and code bloat? Absolutely not. We would be better off rewriting this for V2's API.

Acknowledgments

Name	Contribution
Harmless	Shift-Drift
NiiV3AU	German translations
gir489returns	Casino Pacino
tupoy-ya	Several contributions and shared knowledge. Owner of YimLuaAPI
szalikdev	Revived the project and joined the cause. Owner of Acid Labs
ShinyWasabi	scrDbg and other foundational community contributions frequently used as reference
Alexander Schmid	GTA V data dumps
Andreas Maerten	GTA V classes (archived/removed)
UnknownCheats	A treasure trove of information

Contact