Skip to content

Getting Started

Install

sh
luarocks install mods
sh
# clone repo
git clone https://github.com/luamod/mods.git

# enter project folder
cd mods

# create target path (replace 5.x with your Lua version, e.g. 5.4)
mkdir -p /usr/local/share/lua/5.x/

# copy modules
cp -r src/mods /usr/local/share/lua/5.x/
md
Copy all files from src/mods/ to C:\Program Files\Lua\5.x\lua\mods\

> Replace 5.x with your Lua version (e.g. 5.4).

NOTE

LLS type stubs are available in types/.

Basic Usage

example.lua
lua
local mods = require("mods")

local l = mods.List({ "a", "b", "a" })
local s = mods.Set({ "a", "b" })

local u = l:uniq()
local keys = mods.tbl.keys({ a = 1, b = 2 })

NOTE

Direct module imports such as require("mods.str") remain supported for compatibility.