Installation

lua-annotations has two installation steps - one for the core python CLI tool (lua-annotations), allowing you to create custom annitations, and optionally, default-framework, which provides a set of annotations that use the build tool's API to create a Roblox game framework.

Note

This guide assumes that you already have a Rojo project set up and you are familiar with the tool. If not, you may follow the tool's official documentation.

Installing with pip

Build Tool

Install the python tool

pip install lua-annotations

Create a config file for your project.

annotations.config.json

{
    "outDirName": "Generated",
    "workspaces": [
        {
            "client": {"src/client": ":"},
            "server": {"src/server": ":"},
            "shared": {"src/shared": ":"}
        }
    ],
}

If you wish to add a Wally package to be processed, you may add it like this:

annotations.config.json

"workspaces": [
    "shared": {..., "wally@my-package": ":Packages"}
]

Framework Extension

This provides a Roblox game framework you could optionally use. It is automatically installed with the python package but not automatically imported - add it as an extension to your config.

Tip

You may follow these steps to install any other third-party python extension or even create your own! (more info in the lua-annotations API guide)

annotations.config.json

"extensions": [
    ["library", "lua-annotations.extensions.game_framework.main"]
]

Lua runtime code is added to your project automatically.

Installing from source

Clone the git repository:

git clone https://github.com/pigxity-games/lua-annotations

Install via pip:

pip install -e ./lua-annotations