GMR Lua API

A Visual Studio Code extension that provides Lua library definitions for GMR, enabling IntelliSense, autocompletion, and type checking for GMR-specific APIs.

This plugin is community driven, so it would not automatically get updates when GMR add new function, please add them by yourself, create an issue send a message to discord channel and describe what should be added

Join Discord to discuss and participate.

Features

• added all methods from official API doc
• added docs to method according to author's experience while using GMR
• added methods from my old lua definitions file
• added methods from free form file from discord

Instructions

• Press CTRL + SHIFT + P to open the command palette
• type Activate GMR API extension and press enter

Example

Here’s an example of how to use GMR APIs with autocompletion and type checking:

GMR.AmmoExists()

-- or 

---@type GMR
local gmr = GMR

-- Use GMR APIs with IntelliSense support
gmr.AmmoExists() -- Autocompletion and type checking will work here

Requirements

• Lua VSCode extension must be installed for this extension to work.
• WoW Lua API LUA definitions for WoW API.

Contributing

Contributions are welcome! If you have any ideas, suggestions, or issues, please open an issue or submit a pull request.

1. Fork the repository.
2. Create a new branch (git checkout -b feature/YourFeatureName).
3. Commit your changes (git commit -m 'Add some feature').
4. Push to the branch (git push origin feature/YourFeatureName).
5. Open a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Enjoy using GMR Lua API! If you have any questions or feedback, feel free to open an issue.