luals / lls-addons

Addons for use with Sumneko's Lua Language Server

Lua Language Server Addons

Welcome to the repository of addons for the Lua Language Server by sumneko!

This repository is a highly collaborative project, with the community contributing addons through pull requests. The goal is to provide a central location where the community can collaborate on creating addons. Addons are added to this repository as a git submodule, allowing each project to have its own issues, pull requests, and fork-able repo - they can even live on GitLab. The addons in this repository can be fetched by the addon manager in the VS Code extension that communicates with the Lua Language Server in VS Code.

What is an Addon?

An addon, simply put, is something that extends the functionality of the Lua Language Server. An addon could, for example, include definitions for an API, and apply settings. Definition files are written in Lua using the Lua Language Server's LuaCATS annotation system.

What should be an Addon?

• An addon for a popular library/framework.
• Definitions for an API

What should NOT be an Addon?

• Definitions for a personal project (use workspace.library).
• Definitions for proprietary software.

Anatomy of an Addon

Here is an example of what an addon could look like:

📂 MySnazzyAddon/
    ├──📜 info.json
    └── 📁 module/
        ├── 📁 library/
        └── 📜 config.lua

info.json

The info.json file contains some details about the addon such as the name and description. It also contains some additional metadata such as size and hasPlugin, but these values are generated automatically by the LLS-Addons-Action. This file is used by the addon manager to retrieve some data about each addon without having to install them all first.

module

The module folder is the submodule that contains the addon's definition files and config.json.

Get Involved

As already said, this is a very collaborative project, so anyone is welcome to help out! To get started, please review the contribution guidelines. Your contributions are greatly appreciated and will help to make this project a valuable resource for the Lua community ❤️.

lls-addons's Issues

Add LÖVE Nuklear Definitions

What is the Addon for?

Add definitions for keharriso/love-nuklear, a UI and window management adapter library for Love2D.

Additional Notes

The definitions are stored at goldenstein64/love-nuklear-definitions. I'm open to making a new branch to remove any miscellaneous config files.

TIC-80 Lua functions language definition

What is the Addon for?

Add definitions for TIC-80

Additional Notes

PR with the addon will follow.

Add LuaLogging definitions

What is the Addon for?

Adds definitions for LuaLogging, a library used for logging stuff.

LuaLogging provides a simple API to use logging features in Lua. Its design was based on log4j. LuaLogging currently supports, through the use of appenders, console, file, rolling file, email, socket and sql outputs.

Additional Notes

The definitions are at goldenstein64/lualogging-definitions.

Update moonloader

repo

Add definitions for ao

What is the Addon for?

Definitions for the Lua environment of ao-repl

Additional Notes

No response

Unbound API definitions

What is the Addon for?

Adds definitions for the Lua API of Unbound, a game engine currently in development and in a (very) early-access phase.

Additional Notes

The engine and it’s API are closed source. Having these definitions in an easy to access space (via the addon manager in VS Code) would provide a quick setup for current testers, and later on any developer using Unbound for developing their games.

Add Garry's Mod definitions

What is the Addon for?

Add definitions for the game Garry's Mod. The definitions are automatically generated and based on the official wiki

Additional Notes

The repository for the addon is located here. A GitHub workflow runs every month and updates the definitions based on the Garry's Mod wiki content.

The LLS addon is published to this lua-language-server-addon branch.

I'm in the process of finishing up refactoring and testing today. When I'm done I'll make a PR here and add that branch as a sub repository.

A broken link

The link to cc-tweaked/module is broken.
module @ 143e735

Add NodeMCU esp8266 definitions

What is the Addon for?

Add definitions for theNodeMCU, a Lua based firmware for the ESP8266 WiFi SoC from Espressif, to use with Lua Language Server.

Additional Notes

No response

Add NodeMCU esp32 definitions

What is the Addon for?

Add definitions for the NodeMCU, Lua based firmware for the ESP32 WiFi SoC from Espressif, to use with Lua Language Server.

Additional Notes

No response

How about plugin

I've noticed that there doesn't seem to be an example that provides how to handle plugin files in the codebase

Add definitions for Tabletop Simulator

What is the Addon for?

Add definitions for Tabletop Simulator's Lua API.

This gives first-class linting support and up-to-date documentation for all of the methods supported by Tabletop Simulator's Lua api.

I painstakingly went through the entire documentation, and used tools like rawget and moonsharp's inspect to exhaustively get all functions that can be called.

I added the documentation from the official API, but included grammar fixes, and rewrote confusing parts in many places.

Additional Notes

One thing to note is that the actual runtime used for Tabletop Simulator is MoonSharp version 2.0.0.0.
While I have put the appropriate settings in [config.json] to override the default libraries (and copied the definitions of the libraries inside), there is one custom syntax provided by moonsharp that I have not been able to figure out how to support: Closures.

Not sure if the best way of doing this is with a plugin for custom syntax or maybe even trying to add moonsharp as a lua runtime supported by Lua LS itself. Some feedback on this would be appreciated.

Final disclaimer, I did not know the best way of exposing the event api, as these are functions the programmer writes themselves. I took a look at what @emmericp did for his plugin but couldn't wrap my head around it.

HALion

What is the Addon for?

Add definitions for HALion scripting language.
https://developer.steinberg.help/display/HSD

Additional Notes

No response

Add argparse Definitions

What is the Addon for?

Adds definitions for luarocks/argparse, a library for parsing command-line arguments.

Additional Notes

The definitions are located at goldenstein64/argparse-definitions. I'm open to making a branch to remove the LICENSE and other config files.

The Powder Toy Lua API Addon

What is the Addon for?

Add definitions for The Powder Toy Lua API.

The Powder Toy Lua API is a set of objects and functions that allow control over most aspects of the game, including graphics, element interactions, and interfaces.

Additional Notes

The repo for the addon is here: https://github.com/Maticzpl/TPT-LuaAPI-Addon

adding Luvit addon

What is the Addon for?

This addon adds definitions for the Luvit framework, a Lua framework that mimics the Node.js API making use of the Libuv backend bindings, Luv.

Additional Notes

The meta definitions for this are at https://github.com/Bilal2453/luvit-meta, is it fine for the root directory to contain more than just the library and config.json? like the README.md, or should I create a branch that contains just those two library/config.json?

Add Penlight Definitions

What is the Addon for?

Adds definitions for lunarmodules/Penlight, a general-purpose library.

Penlight brings together a set of generally useful pure Lua modules, focusing on input data handling (such as reading configuration files), functional programming (such as map, reduce, placeholder expressions, etc), and OS path management. Much of the functionality is inspired by the Python standard libraries.

Additional Notes

The definitions are at goldenstein64/pl-definitions. I'm open to making a branch to remove the LICENSE and other config files.

Add stylua check action

StyLua formatting should be enforced before fetching the data for addons or merging pull requests

Add FiveM API definitions

What is the Addon for?

Add definitions for the FiveM API.

These definitions are used to develop FiveM scripts using Lua.

Additional Notes

This addon is generate by fivem-lls-addon

The distribution of the addon is located at dist branch of this repo.

Add Stormworks Addon editor Lua support

What is the Addon for?

Add definitions for the Stormworks addon editor for usage with external editors, as the in-game one has not much besides basic interpretation error checks.

Additional Notes

No response

Add Xmake Definitions

What is the Addon for?

xmake is a cross-platform build utility based on Lua. Its major configuration (xmake.lua) is written in Lua. And it would be great if it can rely on Lua-LS for type checks, intellisense, etc.

The initial version of xmak definitions is in this repo/branch: https://github.com/LelouchHe/xmake-luals-addon/tree/publish, which covers the most important part of xmake.lua

Additional Notes

The definitions are not complete yet, but it should cover majority of daily uses for now. I'm planning to keep working on this.

Is it ok to publish an addon in such status? I think it's better for xmake users to access this early, even though it's not 100% complete.

Question: How to make my type definitions an addon?

What is the Addon for?

Add definitions for the Mirai Project.

Additional Notes

No response

DCS World Scripting Definitions

What is the Addon for?

Add definitions for flight simulator DCS World

Additional Notes

Actual definitions are pulled from Hoggit Wiki Simulator Scripting Engine Documentation with permissions granted by the author.

The addon is still WIP with some of the environments usable. I will start a PR once it is more complete.
Here is the repo

Only run addon metadata fetching action on push to main

It currently runs on pull requests when it should only run on main

Link in the ”About” section is outdated

The link to the main Lua Language Server repository is outdated.

https://github.com/LuaLS/lua-language-server

not

https://github.com/sumneko/lua-language-server

Add definitions for the Local Lua Debugger

What is the Addon for?

Add definitions for Local Lua Debugger's Lua interface library, lldebugger.
Local Lua Debugger is a VSCode extension that provides debugging support for Lua.

Additional Notes

The lldebugger library isn't fully formally documented, from what I could find, maybe apart from lldebugger.start() and lldebugger.requestBreak().
I have inspected the source code for the library and found out the definitions for the functions that I could find in the lldebugger table.