TomGrobbe / MenuAPI

FiveM C# Menu API. Designed specifically as a replacement of NativeUI for vMenu. Full safezone scaling supported, both left and right aligned menus supported.
https://docs.vespura.com/mapi
62 stars 45 forks source link

MenuAPI

FiveM & RedM C# Menu API

Discord CodeFactor Build status Patreon

Designed specifically as a replacement of NativeUI, MenuAPI features performance improvements, RedM and FiveM support, improved stability, better features, less bugs, full safezone alignment support for both left and right algined menus (FiveM only) and less (in my opinion) unnecessary features.

This has been coded from the ground up. Using decompiled scripts from GTA V & RedM to figure out what some undocumented natives were used for.

Installation

Note, this is only for resource developers, don't install this on your server manually if you're not making a resource with it.

You have 2 options:

  1. Download the latest release zip and use the correct version (FiveM/RedM) for your resource. Simply include the DLL as a reference in your C# project and add using MenuAPI; to each file where you need to use MenuAPI.
  2. Use the NuGet package, which can be found here for FiveM, and here for RedM.

After doing either of the above and you're ready to build and publish your resource, add files {'MenuAPI.dll'} to your fxmanifest.lua file, and make sure that you include the MenuAPI.dll file in the folder of your resource.

Documentation

Limited documentation is available here.

Feel like contributing to the documentation? The repository for the documentation site can be found here, thanks!

Copyright / License

Copyright © Tom Grobbe 2018-2021.

MenuAPI is a free resource, using a custom license. Conditions are listed below.

You are allowed to

You are NOT allowed to

You must

In short

It's very simple, don't steal my stuff, don't try to take credit for code that isn't yours and don't try to make money using my work. That's all I ask.

If you'd like to do something that's not allowed per this license, contact me and we might be able to figure something out.

Nothing is guaranteed to work, I do not take responsibility for any bugs or damages caused by this code. Use at your own risk.