Skip to content

lnx00/Lmaobox-Annotations

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

133 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Lmaobox Lua Annotations

The Lmaobox Lua Annotations allow you to get static code analysis, type checking and autocompletion for the Lmaobox Lua API in your favorite IDE. It is based on the Lua Language Server and Lmaobox Lua API.

Lmaobox development just got a whole lot better 🧠 - LewdDeveloper

Installation guide

Prerequisites

  1. Install the LUA Extenstion for Visual Studio Code
  2. Clone or download and extract this repository
  3. Continue with one of the following installation methods:

Enable annotations locally (Recommended)

  1. Create a .luarc.json file in the root of your Lua project (View Template)
  2. Add the library folder inside this repository (not the root) to the workspace.library field, using forward slashes.

Enable annotations globally

  1. Run Visual Studio Code and open the settings (File -> Preferences -> Settings)
  2. On the left side, navigate to the Lua extension settings (Extensions -> Lua)
  3. Find "Workspace: User Third Party" (under Lua extension settings) and click on "Add Item"
  4. Select the library folder inside this repository (using forward slashes)

You should now see autocomplete suggestions for all the functions, methods, types, and libraries of the Lmaobox API. It should look like this:

Preview

Updating

To update the annotations, simply pull the latest changes from this repo and restart your IDE.
If you've manually downloaded the repo, you can also just download the latest version and replace the old folder.

How to use annotations

For more information refer to the official Lua Language Server Wiki. It has comprehensive documentation on how to use the annotations.

Console commands

Command Description
lua_tc Toggle lua evaluation mode
lua_load {file path} Load a lua script in localappdata folder
lua_exec {code} Evaluate lua code

About

Lua-Language-Server annotations for Lmaobox

Topics

Resources

License

Stars

Watchers

Forks

Contributors

Languages