Installation

Step-by-step guide to install the language module and set up the necessary environment to start using it.

The Lua Language Module can be installed in two ways: manually downloading the release or using the Plugify package manager. This guide explains both methods and provides step-by-step instructions.

Method 1: Manual Installation

Download the Release

  1. Go to the Lua Language Module repository.
  2. Navigate to the Releases section.
  3. Download the archive for your platform: plugify-module-lua-<version>-linux_64.tar.bz2, win_64 or osx_arm64.

Extract the Package

  1. Create a new folder inside addons/plugify/envs, for example envs/lua.
  2. Extract the archive into it. The manifest plugify-module-lua.pmodule must end up in the root of that folder.

Verify Installation

  1. Run plg load in the server console, or restart the server.
  2. Run plg modules: the module is listed as lua_module.

Method 2: Installation via Package Manager

Open the Server Console

The mamba command is built into the server console, so nothing has to be installed first. Package operations run while Plugify is unloaded: plg unload before them and plg load after. See Commands.

Install the Module

  1. Run the following commands in the server console: 
    plg unload
mamba install -n modules -c "https://untrustedmodders.github.io/plugify-module-lua/" plugify-module-lua
plg load
    Enter the commands one at a time, as described in Commands.

Verify Installation

  1. Run plg modules: the module is listed as lua_module.

Folder Structure

After installation, the Lua Language Module should have the following folder structure:

Explanation

  • addons/plugify/envs/modules: The root folder for the Lua Language Module.
  • bin: Contains the compiled module binaries (.dll for Windows, .so for Linux and .dylib for macOS).
  • lib: Lua files of the module; plugify.lua provides the plugify module (Plugin, Vector2, Vector3, Vector4, Matrix4x4).
  • plugify-module-lua.pmodule: The module manifest file that describes the module and its language.

Troubleshooting

Module Not Found

  • Ensure the repository URL is correct and accessible.

Installation Fails

  • Check your internet connection.
  • Ensure you have the latest version of Plugify installed.
Edit this page on GitHub
Quick start
Quick start with Lua language module.
First Plugin
Learn how to create your first plugin with the language module, including basic syntax and setup.