xackery / eqemu-definitions

MQ Definitions

EQEMU Lua Definitions

Installation

Create a folder in a global, generic path, for example: c:\lua-definitions\

git clone this repo under this generic path, so it ends up like: c:\lua-definitions\eqemu-definitions (this will be used in the settings.json noted below)

Get vscode

Under extensions, find the sumneko 'lua' extension

NOTE: Be sure to disable the spire extension, it will clash with this extension

Open your quests folder as a workspace by dragging the quests folder into your vscode window.

Create a .gitignore if one doesn't already exist, and add .vscode/ if it doesn't already have it

Create a new folder called .vscode/

Inside .vscode/ create a file called settings.json

Inside it, add these settings, changing the c:\lua-definitions\eqemu-definitions path to where you cloned this repository

{
    "Lua.runtime.version": "Lua 5.1",
    "Lua.workspace.library": [
        "c:\\lua-definitions\\eqemu-definitions"
    ],
    "Lua.diagnostics.disable": [
        "lowercase-global"
    ],
}

Inside an existing NPC lua script, add a param comment

---@param e NPCEventSay
function event_say(e)

This will give context on the e argument

That's it!

If you find errors you can report them in issues or ping Xackery on discord