Luanti

https://docs.luanti.org
Admin
Luanti is an open-source voxel game engine that includes a client for players and a distribution...
Tokens:103,690
Snippets:1,690
Trust Score:9.5
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install and run via Node.js

Source: https://docs.luanti.org/about/contributing-to-docs

Commands to install dependencies and serve the site locally for testing.

```bash
npm install # Installs packages needed to build and test the site
npm start # Builds and serves the site on a localhost port for manual testing
```

--------------------------------

### Install Git on Linux distributions

Source: https://docs.luanti.org/for-engine-devs/compiling/linux-server

Commands to install the Git version control system.

```bash
sudo apt install git
```

```bash
sudo dnf install git
```

```bash
sudo pacman -S git
```

```bash
sudo apk add git
```

```bash
sudo xbps-install git
```

--------------------------------

### Example TR format template and translation

Source: https://docs.luanti.org/for-creators/translation/mods-and-games

Demonstrates the structure of a template.txt file and its corresponding .tr translation file for a mod named example.

```text
# textdomain:example
Apple=
Pickaxe=
#This is a comment, not a translation. You can ignore this line.
Welcome, @1!=
@1 has killed @2 and gained @3 EXP.=
E-mail: <somebody@@example.org>=
“@=” is the equals sign=
This text@nhas 2 lines.=Dieser Text@nhat 2 Zeilen.
```

```text
# textdomain:example
Apple=Apfel
Pickaxe=Spitzhacke
#This is a comment, not a translation. You can ignore this line.
Welcome, @1!=Willkommen, @1!
@1 has killed @2 and gained @3 EXP.=@1 hat @2 getötet und @3 EXP erhalten.
E-mail: <somebody@@example.org>=E-Mail: <somebody@@example.org>
“@=” is the equals sign.=»@=« ist das Gleichheitszeichen.
This text@nhas 2 lines.=Dieser Text@nhat 2 Zeilen.
```

--------------------------------

### Install a game via Git

Source: https://docs.luanti.org/for-server-hosts/setup/docker

Clone a game repository into the local games directory.

```bash
git clone https://git.minetest.land/VoxeLibre/VoxeLibre ./games/voxelibre/
```

--------------------------------

### Navigate to project directory

Source: https://docs.luanti.org/for-engine-devs/compiling/windows

Example command to change the working directory to the user's desktop.

```bash
cd /c/Users/$USER/Desktop
```

--------------------------------

### Install dependencies via vcpkg

Source: https://docs.luanti.org/for-engine-devs/compiling/windows-msvc

Use this command to install the necessary libraries for Luanti using the vcpkg package manager.

```bash
vcpkg install zlib zstd curl[ssl] openal-soft libvorbis libogg libjpeg-turbo sqlite3 freetype luajit gmp jsoncpp gettext[tools] sdl2 --triplet x64-windows
```

--------------------------------

### Install build dependencies

Source: https://docs.luanti.org/for-engine-devs/compiling/windows

Installs the required toolchain and libraries for compiling Luanti within the CLANG64 environment.

```bash
pacman -S git mingw-w64-clang-x86_64-{clang,cmake,ninja,curl-winssl,libpng,libjpeg-turbo,freetype,libogg,libvorbis,sqlite3,openal,zstd,gettext,luajit,SDL2}
```

--------------------------------

### Configure Keybindings in minetest.conf

Source: https://docs.luanti.org/for-players/minetest-conf

Examples of keybinding syntax for different versions and input types.

```text
keymap_forward = KEY_KEY_W
```

```text
keymap_forward = SYSTEM_SCANCODE_225
```

```text
keymap_forward = KEY_KEY_W|KEY_UP
```

```text
keymap_toggle_debug =
```

```text
keymap_attack = MOUSE_BUTTON_1
```

--------------------------------

### Install dependencies via Homebrew

Source: https://docs.luanti.org/for-engine-devs/compiling/macos

Install the required libraries and tools for building Luanti on macOS.

```bash
brew install cmake freetype gettext gmp hiredis jpeg-turbo jsoncpp leveldb libogg libpng libvorbis luajit zstd gettext sdl2 openal-soft
```

--------------------------------

### Start the container

Source: https://docs.luanti.org/for-server-hosts/setup/docker

Launch the Docker Compose services in detached mode.

```bash
docker compose up -d
```

--------------------------------

### Give Command Usage

Source: https://docs.luanti.org/for-players/itemstrings

Example of using an itemstring as an argument for the giveme command to spawn an item.

```text
/giveme default:torch
```

--------------------------------

### Install dependencies on Linux distributions

Source: https://docs.luanti.org/for-engine-devs/compiling/linux-server

Commands to install required build tools and libraries for various Linux package managers.

```bash
sudo apt install g++ make libc6-dev cmake libpng-dev libjpeg-dev libgl1-mesa-dev libsqlite3-dev libogg-dev libvorbis-dev libopenal-dev libcurl4-gnutls-dev libfreetype6-dev zlib1g-dev libgmp-dev libjsoncpp-dev libzstd-dev libluajit-5.1-dev gettext libsdl2-dev
```

```bash
sudo dnf install make automake gcc gcc-c++ kernel-devel cmake libcurl-devel openal-soft-devel libpng-devel libjpeg-devel libvorbis-devel libogg-devel freetype-devel mesa-libGL-devel zlib-devel jsoncpp-devel gmp-devel sqlite-devel luajit-devel leveldb-devel ncurses-devel spatialindex-devel libzstd-devel gettext SDL2-devel
```

```bash
sudo zypper install gcc gcc-c++ cmake libjpeg8-devel libpng16-devel openal-soft-devel libcurl-devel sqlite3-devel luajit-devel libzstd-devel Mesa-libGL-devel libvorbis-devel freetype2-devel SDL2-devel
```

```bash
sudo pacman -S --needed base-devel libcurl-gnutls cmake libpng libjpeg-turbo sqlite libogg libvorbis openal freetype2 jsoncpp gmp luajit leveldb ncurses zstd gettext sdl2
```

```bash
sudo apk add build-base cmake libpng-dev jpeg-dev mesa-dev sqlite-dev libogg-dev libvorbis-dev openal-soft-dev curl-dev freetype-dev zlib-dev gmp-dev jsoncpp-dev luajit-dev zstd-dev gettext sdl2-dev
```

```bash
sudo xbps-install cmake libpng-devel jpeg-devel mesa sqlite-devel libogg-devel libvorbis-devel libopenal-devel libcurl-devel freetype-devel zlib-devel gmp-devel jsoncpp-devel LuaJIT-devel zstd libzstd-devel gettext SDL2-devel
```

--------------------------------

### Build prometheus-cpp on Linux

Source: https://docs.luanti.org/for-server-hosts/prometheus-metrics

Commands to clone, build, and install the prometheus-cpp library from source.

```bash
cd /tmp
git clone --recursive https://github.com/jupp0r/prometheus-cpp
mkdir prometheus-cpp/build
cd prometheus-cpp/build
cmake .. -DCMAKE_INSTALL_PREFIX=/usr/local -DCMAKE_BUILD_TYPE=Release -DENABLE_TESTING=0
make -j$(nproc)
sudo make install
```

--------------------------------

### Run Hugo directly

Source: https://docs.luanti.org/about/contributing-to-docs

Command to start the Hugo server manually.

```bash
hugo server # This is the command internal to `npm start`
```

--------------------------------

### Object Properties Configuration Example

Source: https://docs.luanti.org/for-creators/api/object-properties

A standard configuration table defining various physical, visual, and metadata properties for an object.

```lua
{
    physical = true,
    collide_with_objects = true,
    collisionbox = {-0.3, -0.3, -0.3, 0.3, 0.3, 0.3},
    selectionbox = {-0.3, -0.3, -0.3, 0.3, 0.3, 0.3},
    pointable = true,
    visual = "mesh",
    mesh = "mesh.obj",
    visual_size = {x = 1, y = 1, z = 1},
    textures = {"texture.png", "texture.png"},
    initial_sprite_basepos = {x = 0, y = 0},
    is_visible = true,
    makes_footstep_sound = true,
    stepheight = 0.4,
    automatic_rotate = 0.0,
    automatic_face_movement_dir = 0,
    automatic_face_movement_max_rotation_per_sec = 0,
    backface_culling = true,
    glow = 0,
    nametag = "My object",
    nametag_color = {r = 255, g = 255, b = 255},
    nametag_bgcolor = {r = 0, g = 0, b = 0},
    infotext = "Hello there!",
    static_save = true,
    use_texture_alpha = true,
    shaded = true,
    show_on_minimap = true,
    damage_texture_modifier = "^[colorize:#FF0000:150",
}
```

--------------------------------

### Initialize HTTP API Access

Source: https://docs.luanti.org/for-creators/api/http-api

Example of how to safely request and store the HTTP API instance within a mod's init.lua file.

```lua
--inside mods init.lua file
local http = core.request_http_api and core.request_http_api()

if http then
    --call your http methods here
end
```

--------------------------------

### Configure HTTP Mod Permissions

Source: https://docs.luanti.org/for-creators/api/http-api

Example of the configuration setting required to enable HTTP access for specific mods.

```text
secure.http_mods = modname1, modname2, modname3
```

--------------------------------

### Format list-style tables

Source: https://docs.luanti.org/Lua_code_style_guidelines

Example of a list-style table with multiple elements per line.

```lua
local first_eight_letters = {
	"a", "b", "c", "d",
	"e", "f", "g", "h",
}
```

--------------------------------

### Comment Formatting Examples

Source: https://docs.luanti.org/Lua_code_style_guidelines

Demonstrates correct versus incorrect inline comment usage and proper grammar for documentation.

```lua
width = width - 2  -- Adjust for 1px border on each side
```

```lua
width = width - 2  -- Decrement width by two
```

```lua
-- This is a properly formatted comment.
-- This isnt.              (missing apostrophe)
-- neither is this.        (lowercase first letter)
```

```lua
--This is wrong.
-- This is right.
```

```lua
foo()  -- A proper comment.
```

```lua
--[[
Very long
multi-line comment.
--]]
```

--------------------------------

### Define a Namespace

Source: https://docs.luanti.org/for-creators/lua-conventions

Example of creating a namespace table to organize mod APIs and keep internal functions local.

```lua
mymath = {}

function mymath.clamp(x, min, max)
    return math.max(math.min(x, max), min)
end
```

--------------------------------

### Implement Persistent Mod Storage

Source: https://docs.luanti.org/for-creators/api/classes/modstorage

A basic example demonstrating how to retrieve mod storage, read values on player join, and update values via chat commands.

```lua
local storage = core.get_mod_storage()

-- Send the greeting to joining players
core.register_on_joinplayer(function(player)
	local greeting = storage:get("greeting")
	if greeting then
		core.chat_send_player(player:get_player_name(), greeting)
	end
end)

-- Allow moderators to change the greeting
core.register_chatcommand("/set_greeting", {
	params = "<greeting>",
	description = "Sets the greeting",
	privs = {server = true},
	func = function(name, param)
		param = param:trim() -- MT-provided string.trim
		storage:set_string("greeting", param)
		return true, param == "" and "Greeting cleared." or "Greeting set."
	end
})
```

--------------------------------

### Standard if statement formatting

Source: https://docs.luanti.org/for-engine-devs/code-style-guidelines

Examples of correct if statement formatting, including brace placement and else positioning.

```cpp
if (foobar < 3)
	foobar = 45;

if (foobar < 6) {
	foobar = 62;
	return;
}

if (foobar == 42) {
	bar();
} else {
	baz();
}
```

--------------------------------

### Define front matter

Source: https://docs.luanti.org/about/contributing-to-docs

Example of YAML front matter required at the top of every markdown file.

```yaml
---
title: Your Page Title
aliases:
  - /old/page/path
---
```

--------------------------------

### Format incorrect Lua tables

Source: https://docs.luanti.org/Lua_code_style_guidelines

Examples of discouraged table formatting styles that should be avoided.

```lua
foo = {bar = 0,
	biz = 1,
	baz = 2}
foo = {
	bar = 0, biz = 1,
	baz = 2
}
```

--------------------------------

### Analyze Traceroute Output

Source: https://docs.luanti.org/for-server-hosts/setup/ip-address

Example output of a traceroute showing a single hop, indicating the absence of CGNAT.

```text
traceroute to 78.71.XX.XX (78.71.XX.XX), 30 hops max, 60 byte packets
 1  78-71-XX-XX.example.org (78.71.XX.XX)  0.567 ms  0.643 ms  0.702 ms
```

--------------------------------

### Lua Indexing and API Errors

Source: https://docs.luanti.org/for-players/troubleshooting

Examples of common Lua runtime errors indicating outdated versions or deprecated API calls.

```text
init.lua:2: attempt to index field 'settings' (a nil value)
init.lua:18: attempt to call field 'register_lbm' (a nil value)
tools.lua:61: attempt to call global 'nodeupdate' (a nil value)
```

--------------------------------

### Build for personal usage

Source: https://docs.luanti.org/for-engine-devs/compiling/macos

Configure, build, and sign the application for local execution.

```bash
mkdir build
cd build

cmake .. \
    -DCMAKE_FIND_FRAMEWORK=LAST \
    -DCMAKE_INSTALL_PREFIX=../build/macos/ \
    -DRUN_IN_PLACE=FALSE -DENABLE_GETTEXT=TRUE

make -j$(sysctl -n hw.logicalcpu)
make install

# Apple Silicon (M1/M2) Macs w/ MacOS >= BigSur signature for local run
codesign --force --deep -s - --entitlements ../misc/macos/entitlements/debug.entitlements macos/luanti.app
```

--------------------------------

### Check Luanti Lua Runtime Version

Source: https://docs.luanti.org/for-creators/api/luajit

Commands to verify whether the current Luanti installation is using LuaJIT or PUC Lua.

```bash
$ ./luanti --version
[...]
Using LuaJIT 2.1.1702233742
```

```bash
$ ./luanti --version
[...]
Using Lua 5.1.5
```

--------------------------------

### View server help flags

Source: https://docs.luanti.org/for-server-hosts/setup/docker

Execute the server binary inside the container to list available command-line arguments.

```bash
docker exec -it luanti_server luantiserver --help
```

--------------------------------

### Define a 3x3x3 schematic table

Source: https://docs.luanti.org/for-creators/schematic

A minimal example of a schematic table structure, defining size and a flat list of MapNode data.

```lua
local my_schematic = {
	size = {x = 3, y = 3, z = 3},
	data = {
		-- The side of the bush, with the air on top
		{name = "default:bush_leaves"}, {name = "default:bush_leaves"}, {name = "default:bush_leaves"}, -- lower layer
		{name = "default:bush_leaves"}, {name = "default:bush_leaves"}, {name = "default:bush_leaves"}, -- middle layer
		{name = "air"}, {name = "air"}, {name = "air"}, -- top layer
		-- The center of the bush, with stem at the base and a pointy leave 2 nodes above
		{name = "default:bush_leaves"}, {name = "default:bush_stem"}, {name = "default:bush_leaves"}, -- lower layer
		{name = "default:bush_leaves"}, {name = "default:bush_leaves"}, {name = "default:bush_leaves"}, -- middle layer
		{name = "air"}, {name = "default:bush_leaves"}, {name = "air"}, -- top layer
		-- The other side of the bush, same as first side
		{name = "default:bush_leaves"}, {name = "default:bush_leaves"}, {name = "default:bush_leaves"}, -- lower layer
		{name = "default:bush_leaves"}, {name = "default:bush_leaves"}, {name = "default:bush_leaves"}, -- middle layer
		{name = "air"}, {name = "air"}, {name = "air"}, -- top layer
	}
}
```

--------------------------------

### Run the application

Source: https://docs.luanti.org/for-engine-devs/compiling/macos

Launch the built Luanti application.

```bash
open ./build/macos/luanti.app
```

--------------------------------

### Create server directories

Source: https://docs.luanti.org/for-server-hosts/setup/docker

Initialize the required local directory structure for the server container.

```bash
mkdir -p data/.minetest config games mods
```

--------------------------------

### Initialize and update submodules

Source: https://docs.luanti.org/about/contributing-to-docs

Use these commands if you have already cloned the repository and need to fetch submodules.

```bash
git submodule init
git submodule update --remote
```

--------------------------------

### Initialize Git repository

Source: https://docs.luanti.org/for-creators/development-setup

Initialize a new git repository in your project root.

```bash
git init
```

--------------------------------

### Simple Mesh Structure

Source: https://docs.luanti.org/for-creators/models/b3d-spec

Example of a basic, non-animating, non-textured mesh definition.

```text
BB3D
  1                           ; version
  NODE
    "root_node"               ; node name
    0,0,0                     ; position
    1,1,1                     ; scale
    1,0,0,0                   ; rotation
    MESH                      ; the mesh
      -1                      ; brush: no brush
      VRTS                    ; vertices in the mesh
        0                     ; no normal/color info in vertices
        0,0                   ; no texture coords in vertices
        {x,y,z...}            ; vertex coordinates
      TRIS                    ; triangles in the mesh
        -1                    ; no brush for this triangle
        {v0,v1,v2...}         ; vertices
```

--------------------------------

### Configure and Build Luanti with Optimized Settings

Source: https://docs.luanti.org/for-engine-devs/compiling/improving-build-times

A complete sequence for setting up a build directory with Clang, mold, and Ninja, followed by the build command.

```bash
mkdir build; cd build
cmake .. -DCMAKE_C_COMPILER=/usr/bin/clang -DCMAKE_CXX_COMPILER=/usr/bin/clang++ -DCMAKE_EXE_LINKER_FLAGS="-fuse-ld=mold" -DCMAKE_SHARED_LINKER_FLAGS="-fuse-ld=mold" -G Ninja
ninja
```

--------------------------------

### string.trim(self)

Source: https://docs.luanti.org/for-creators/api/lua-environment

Removes consecutive spacing characters from the start and end of a string.

```APIDOC
## string.trim(self)

### Description
Returns a string with consecutive spacing characters (as defined by the %s pattern) removed from the start and end of the string.
```

--------------------------------

### Emulate a globalstep with core.after

Source: https://docs.luanti.org/for-creators/api/timing-and-event-loop

Recursively schedule a function to run every server step by calling core.after within the function itself.

```lua
local function after_step()
	core.chat_send_all("Hello World!")
	core.after(0, after_step)
end
core.after(0, after_step)
```

--------------------------------

### Texture Modifiers

Source: https://docs.luanti.org/for-creators/api/texture-modifiers

Examples of applying texture modifiers to manipulate images for nodes and UI.

```APIDOC
## Texture Modifiers

### Description
Texture modifiers allow for dynamic manipulation of textures, such as adding cracks, cropping images, or creating progress bars.

### Modifiers

#### crack
- **Syntax**: `texture.png^[crack:tiles:frames:index`
- **Description**: Adds a crack overlay to a texture.
- **Example**: `default_stone.png^[crack:1:2`

#### combine
- **Syntax**: `[combine:widthxheight:x,y=texture.png`
- **Description**: Combines or crops textures into a new image.
- **Example**: `[combine:8x8:-8,-8=default_stone.png`

#### lowpart
- **Syntax**: `^[lowpart:percentage:texture.png`
- **Description**: Displays a percentage of a texture, often used for progress bars.
- **Example**: `progress_bar_bg.png^[transformR90^[lowpart:50:progress_bar.png\^[transformR90^[transformR270`
```

--------------------------------

### Initialize Git submodules

Source: https://docs.luanti.org/for-creators/development-setup

Initialize the submodules for your project.

```bash
git submodule init
```

--------------------------------

### Chat Log Message Types

Source: https://docs.luanti.org/for-players/chat

Examples of how various message types appear in the chat log.

```text
<player> message
```

```text
* player message
```

```text
DM from player: message
```

```text
Issued command: /privs
```

--------------------------------

### Run Luanti Server via Command Line

Source: https://docs.luanti.org/for-server-hosts/setup/windows

Standard command to launch the server binary. Use the worldname flag if multiple worlds are present.

```powershell
.\luanti.exe --server
```

```powershell
.\luanti.exe --server --worldname world_name
```

--------------------------------

### Configure PostgreSQL connection strings

Source: https://docs.luanti.org/database-backends

Format for defining database credentials in world.mt configuration files.

```text
host=<db_host> user=<db_user> password=<db_password> dbname=<db_name>
```

--------------------------------

### Lua Assertion Failure Error

Source: https://docs.luanti.org/for-players/troubleshooting

Example of an unhandled Lua exception identifying a specific mod path.

```text
 ERROR: An unhandled exception occurred: LuaError: error: mods/minetest/<modname>/init.lua:69: [...]
```

--------------------------------

### Database file error message

Source: https://docs.luanti.org/for-players/troubleshooting

Example of an error message caused by non-ASCII characters in the file path.

```text
AsyncErr: ServerThread::run Lua: Runtime error from mod '*builtin*' in callback on_prejoinplayer():
Failed to open SQLite3 database file C:\Users\ПЛАТЫ\Downloads\minetest-unzip\bin\..\worlds\newname
\auth.sqlite: unable to open database file
```

--------------------------------

### Initialize VoxelArea

Source: https://docs.luanti.org/for-creators/api/classes/voxelarea

Create a new VoxelArea instance using the emerged min and max positions from a VoxelManip object.

```lua
local voxelmanip = core.get_voxel_manip(pos_min, pos_max)
local emin, emax = voxelmanip:read_from_map(pos_min, pos_max)
local voxelarea = VoxelArea:new{ MinEdge = emin, MaxEdge = emax }
```

--------------------------------

### Build and run Luanti

Source: https://docs.luanti.org/for-engine-devs/compiling/linux-server

Commands to compile the project and execute the binary.

```bash
cmake . -DRUN_IN_PLACE=TRUE
make -j$(nproc)
```

```bash
./bin/luanti
```

```bash
./bin/luanti --run-unittests
```

--------------------------------

### Update MSYS2 environment

Source: https://docs.luanti.org/for-engine-devs/compiling/windows

Run this command immediately after installing MSYS2 to update the package database and system packages.

```bash
pacman -Syu
```

--------------------------------

### Complex Skinned Mesh Structure

Source: https://docs.luanti.org/for-creators/models/b3d-spec

Example of a hierarchical skinned mesh structure using bones and animation keys.

```text
BB3D
  TEXS                        ; texture list
  BRUS                        ; brush list
  NODE                        ; root node
    MESH                      ; mesh - the 'skin'
    ANIM                      ; anim
    NODE                      ; first child of root node -  eg: "pelvis"
      BONE                    ; vertex weights for pelvis
      KEYS                    ; anim keys for pelvis
      NODE                    ; first child of pelvis - eg: "left-thigh"
        BONE                  ; bone
        KEYS                  ; anim keys for left-thigh
      NODE                    ; second child of pelvis - eg: "right-thigh"
        BONE                  ; vertex weights for right-thigh
        KEYS                  ; anim keys for right-thigh
```

--------------------------------

### Configure local.properties

Source: https://docs.luanti.org/for-engine-devs/compiling/android

Commands to set the SDK path in the local.properties file within the project directory.

```bash
cd luanti/android
echo 'sdk.dir=/home/<YOUR USER>/android-sdk' >local.properties
```

--------------------------------

### Migrate player database backend

Source: https://docs.luanti.org/database-backends

Use the command-line interface to migrate the player database to a new backend by specifying the backend name and the target world directory.

```bash
luantiserver --migrate-players <name of new backend> --world <path to your world directory>
```

--------------------------------

### Download source code

Source: https://docs.luanti.org/for-engine-devs/compiling/macos

Clone the Luanti repository using Git.

```bash
git clone --depth 1 https://github.com/luanti-org/luanti luanti
cd luanti
```

--------------------------------

### Identify undeclared global variable access

Source: https://docs.luanti.org/for-creators/warnings

Example of a common bug where a typo leads to accessing a non-existent global variable.

```lua
local bar = 42
...
local foo = baz -- typo! meant bar!
print(foo) -- unexpected nil
```

--------------------------------

### Minimal theme re-implementation

Source: https://docs.luanti.org/for-creators/game-theme-re-implementation

Sets a static background and header while disabling clouds, intended for use within the init_globals function.

```lua
core.set_background('header', defaulttexturedir .. "menu_header.png")
core.set_background('background', defaulttexturedir .. "menu_bg.png")
core.set_clouds(false)
```

--------------------------------

### core.mkdir

Source: https://docs.luanti.org/for-creators/api/filesystem

Creates a new directory.

```APIDOC
## core.mkdir(path)

### Description
Creates a directory and any nonexistent parent directories.

### Arguments
- **path** (string) - The path to the directory to create.

### Returns
- **success** (bool) - Whether the operation succeeded.
```

--------------------------------

### Migrate depends.txt to mod.conf

Source: https://docs.luanti.org/for-creators/warnings

Replace legacy dependency files with a single mod.conf file containing name, dependencies, and description.

```text
my_dep_1
my_dep_2
my_opt_dep_1?
my_opt_dep_2?
```

```text
name = <folder name>
depends = my_dep_1, my_dep_2
optional_depends = my_opt_dep_1, my_opt_dep_2
description = <contents of description.txt>
```

--------------------------------

### Iterating with floating point indices

Source: https://docs.luanti.org/for-creators/development-troubleshooting

Example of code prone to array corruption due to floating point precision errors during index calculation.

```lua
x1,y1,z1 = get_start_pos()
x2,y2,z2 = get_end_pos()
for z = z1, z2 - 1 do
for y = y1, y2 - 1 do
for x = x1, x2 - 1 do
    foo(array[z - z1][y - y1][x - x1])
```

--------------------------------

### Compile Luanti via PowerShell

Source: https://docs.luanti.org/for-engine-devs/compiling/windows-msvc

Use these commands to configure and build the project from the command line using the vcpkg toolchain.

```powershell
cmake . -G"Visual Studio 16 2019" -DCMAKE_TOOLCHAIN_FILE=D:/vcpkg/scripts/buildsystems/vcpkg.cmake -DCMAKE_BUILD_TYPE=Release -DENABLE_CURSES=OFF
cmake --build . --config Release
```

--------------------------------

### Define a simple textured plane

Source: https://docs.luanti.org/for-creators/models/obj-spec

A basic example of a square defined by four vertices and four texture coordinates, forming two triangular faces.

```text
v 0 0 0
v 0 1 0
v 1 1 0
v 1 0 0
vt 0 0
vt 0 1
vt 1 1
vt 1 0
f 1/1 2/2 3/3
f 3/3 4/4 1/1
```

--------------------------------

### Format Lua tables

Source: https://docs.luanti.org/Lua_code_style_guidelines

Demonstrates correct formatting for small and large tables, including comma placement and brace alignment.

```lua
local foo = {bar=true}
foo = {
	bar = 0,
	biz = 1,
	baz = 2,
}
```

--------------------------------

### Add, commit, and push changes

Source: https://docs.luanti.org/about/contributing-to-docs

Command sequence for local-based contribution workflow.

```bash
git add -A && git commit -m "your commit message here" && git push
```

--------------------------------

### Register global steps with core.register_globalstep

Source: https://docs.luanti.org/for-creators/api/timing-and-event-loop

Registers a callback to execute every server step. These are performance-critical and should be optimized to prevent server lag.

```lua
core.register_globalstep(function(dtime)
	-- do something, probably involving dtime
end)
```

```lua
-- period is in seconds
local function run_periodically(period, func)
	local timer = 0
	core.register_globalstep(function(dtime)
		timer = timer + dtime
		if timer > period then
			func()
			timer = 0
		end
	end)
end
run_periodically(5, function()
	core.chat_send_all("5 seconds have passed!")
end)
```

--------------------------------

### Accept Android SDK Licenses

Source: https://docs.luanti.org/for-engine-devs/compiling/android

Command to accept the necessary SDK licenses using the sdkmanager.

```bash
./cmdline-tools/bin/sdkmanager --licenses --sdk_root=.
```

--------------------------------

### Configure per-project autocompletion with .luarc.json

Source: https://docs.luanti.org/for-creators/development-setup

Create a .luarc.json file in your project root to configure the language server for the local submodule.

```json
{
  "$schema": "https://raw.githubusercontent.com/LuaLS/vscode-lua/master/setting/schema.json",
  "workspace.library": ["./luanti-api"]
}
```

--------------------------------

### Perform Live SQLite Backups with Bash

Source: https://docs.luanti.org/for-server-hosts/backup-solutions

Uses the sqlite3 CLI to perform a transactional VACUUM INTO operation, ensuring a consistent snapshot of the database while the server is running.

```bash
#!/bin/bash

bakdir=".BACKUP"

mkdir -p "${bakdir}/"

for db in world/*.sqlite; do
    base_name=$(basename "$db")
    sqlite3 "${db}" "VACUUM INTO '${bakdir}/${base_name}';"
done

cp world/*.txt world/world.mt "${bakdir}/"
```

--------------------------------

### Create a server management script

Source: https://docs.luanti.org/for-server-hosts/setup/linux

A bash script to run the Luanti server in a loop, ensuring it restarts automatically if it crashes.

```bash
#!/bin/bash

while true
do
    ./bin/luantiserver --gameid <game> --worldname world --terminal
    sleep 2
done
```

```bash
#!/bin/bash

while true
do
    ../../bin/luantiserver --world "world" --config "server.conf" --logfile "server.log" --terminal
    sleep 2
done
```

--------------------------------

### Define Base POT File Path

Source: https://docs.luanti.org/for-creators/translation/weblate

Template string to locate the base POT file for new translations within the mod directory.

```text
mods/{{ component }}/locale/{{ component }}.pot
```

--------------------------------

### Build Luanti

Source: https://docs.luanti.org/for-engine-devs/compiling/windows

Configures the build using CMake and compiles the project using Ninja.

```bash
mkdir build; cd build
cmake .. -G Ninja
ninja -j$(nproc)
```

--------------------------------

### Implement entity spawning logic

Source: https://docs.luanti.org/for-creators/guides/your-first-mob

Uses core.raycast to find a valid surface near a random player and core.add_entity to place the entity.

```lua
local function try_spawn()
	local players = core.get_connected_players()
	-- pick a random player
	local player = players[math.random(1, #players)]
	for _ = 1, 100 do -- cap the number of tries
		-- random point up to 25 nodes away in each direction, and 10 nodes higher.
		-- we want to raycast down from here to find a suitable spawn position.
		local start = player:get_pos() + vector.new(math.random(-25, 25), 10, math.random(-25, 25))
		if start:distance(player:get_pos()) >= 10 then -- don't spawn too close
			-- raycast down to find a node to spawn on, if any
			local thing = core.raycast(start, start + vector.new(0, -10, 0), false):next()
			if thing then
				core.add_entity(thing.above, "mymod:bloblet") -- spawn bloblet on node
				break
			end
		end
	end
end
```

--------------------------------

### Iterate over raycast results

Source: https://docs.luanti.org/for-creators/api/classes/raycast

Demonstrates the standard way to iterate over pointed things using a for-loop.

```lua
local ray = Raycast(...)
for pointed_thing in ray do
	-- do something
end
```

```lua
local ray = Raycast(...)
for pointed_thing in ray.next, ray do
	-- do something
end
```

```lua
local ray = Raycast(...)
local pointed_thing = ray:next()
while pointed_thing ~= nil do
	-- do something
	pointed_thing = ray:next()
end
```

--------------------------------

### Build Luanti with Prometheus

Source: https://docs.luanti.org/for-server-hosts/prometheus-metrics

Configure and compile Luanti with the Prometheus flag enabled.

```bash
cmake . -DENABLE_PROMETHEUS=1
make -j$(nproc)
```

--------------------------------

### Create Progress Bars

Source: https://docs.luanti.org/for-creators/api/texture-modifiers

Demonstrates resolution-dependent and resolution-agnostic methods for creating progress bars.

```text
[combine:256x48:0,0=progress_bar_bg.png:0,0=[combine\:128x48\:0,0=progress_bar.png
```

```text
progress_bar_bg.png^[transformR90^[lowpart:50:progress_bar.png\^[transformR90^[transformR270
```

--------------------------------

### Format Comment Grammar and Casing

Source: https://docs.luanti.org/for-engine-devs/lua-code-style-guidelines

Demonstrates required capitalization and punctuation for standard comments.

```lua
-- This is a properly formatted comment.
-- This isnt.              (missing apostrophe)
-- neither is this.        (lowercase first letter)
```

--------------------------------

### Perform vector math using operators

Source: https://docs.luanti.org/for-creators/api/classes/vector

Demonstrates how to use standard math operators with vector objects as an alternative to namespaced functions.

```lua
local v1 = vector.new(1, 2, 3)
local v2 = vector.new(4, 5, 6)
local v3

-- This:
v3 = vector.add(v1, v2)
-- Is equivalent to:
v3 = v1 + v2

-- You can also use do more lengthy calculations:
v3 = ((v1 + v2) / 2) * 3
-- The equivalent using the namespaced functions would be rather unwieldy:
v3 = vector.multiply(vector.divide(vector.add(v1, v2), 2), 3)
```

--------------------------------

### Define entity visuals and properties

Source: https://docs.luanti.org/for-creators/guides/your-first-mob

Configures the entity's appearance using initial_properties, including visual type, size, and face textures.

```lua
core.register_entity("mymod:bloblet", {
	initial_properties = {
		visual = "cube",
		visual_size = vector.new(0.5, 0.5, 0.5), -- half the size along all axes
		textures = {
			-- top and bottom should be green
			"[fill:1x1:green", -- +Y
			"[fill:1x1:green", -- -Y
			-- sides too
			"[fill:1x1:green", -- +X
			"[fill:1x1:green", -- -X
			-- but not the front
			"[fill:1x1:red", -- +Z ("front")
			"[fill:1x1:green", -- -Z ("back")
		},
	},
})
```

--------------------------------

### core.register_globalstep

Source: https://docs.luanti.org/for-creators/api/timing-and-event-loop

Registers a callback function to be executed every server step.

```APIDOC
## core.register_globalstep(func)

### Description
Registers a callback function that is invoked every server step. This is useful for polling events or periodic tasks.

### Parameters
- **func** (function) - A function that receives `dtime` (the delta time since the last step in seconds) as an argument.
```

--------------------------------

### HttpApi.fetch_async(request)

Source: https://docs.luanti.org/for-creators/api/http-api

Initiates an asynchronous HTTP request and returns a handle.

```APIDOC
## HttpApi.fetch_async(request)

### Description
Initiates an asynchronous HTTP request. Returns a handle that can be used to retrieve the result later.

### Parameters
- **request** (HttpRequest) - Required - The request configuration object.

### Returns
- **handle** (any) - A handle to be passed to HttpApi.fetch_async_get.
```

--------------------------------

### Handling Nil and Boolean Comparisons

Source: https://docs.luanti.org/Lua_code_style_guidelines

Illustrates preferred practices for checking values, avoiding explicit comparisons to true, false, or nil unless necessary.

```lua
local f, err = io.open(filename, "r")
if not f then return err end

local t = {"a", true, false}
for i = 1, 5 do
	-- Needs an explicit nil check to avoid triggering
	-- on false, which is a valid value.
	if t[i] == nil then
		t[i] = "Default"
	end
end
```

```lua
if f == nil then return err end
```

--------------------------------

### Demonstrate restartable iterator behavior

Source: https://docs.luanti.org/for-creators/api/classes/raycast

Shows how standard iterators like ipairs can be restarted, contrasting with the non-restartable nature of raycasts.

```lua
local t = {1, 2, 3}
for _ = 1, 3 do
	for i, v in ipairs(t) do
		print(i, v)
	end
end
```

--------------------------------

### Clone the repository

Source: https://docs.luanti.org/about/contributing-to-docs

Use this command to clone the repository recursively, ensuring all submodules are included.

```bash
git clone --recursive https://github.com/luanti-org/docs.luanti.org
```

--------------------------------

### [inventorycube{<top>{<left>{<right>

Source: https://docs.luanti.org/for-creators/api/texture-modifiers

Renders a cube with three given textures using simple software rendering.

```APIDOC
## [inventorycube{<top>{<left>{<right>

### Description
Renders a cube with the three provided textures using simple software rendering. The resulting image dimensions are calculated based on the largest face dimensions.

### Parameters
- **top** (string) - Required - Texture for the top face.
- **left** (string) - Required - Texture for the left face.
- **right** (string) - Required - Texture for the right face.
```

--------------------------------

### Define a server with specific game and world

Source: https://docs.luanti.org/for-server-hosts/setup/docker

An extended compose.yml configuration that specifies the game ID and world name using command flags.

```yaml
services:
  luanti_server:
    image: ghcr.io/luanti-org/luanti:latest
    restart: unless-stopped
    volumes:
      - ./config:/etc/minetest:ro
      - ./data:/var/lib/minetest
      - ./games:/var/lib/minetest/.minetest/games:ro
      - ./mods:/var/lib/minetest/.minetest/mods:ro
    ports:
      - "30000:30000/udp"
    command: --config /etc/minetest/minetest.conf --gameid voxelibre --worldname world
```

--------------------------------

### Generate Xcode project for distribution

Source: https://docs.luanti.org/for-engine-devs/compiling/macos

Configure the build system to generate an Xcode project with specific library paths.

```bash
mkdir build
cd build

cmake .. \
    -DCMAKE_FIND_FRAMEWORK=LAST \
    -DRUN_IN_PLACE=FALSE -DENABLE_GETTEXT=TRUE \
    -DFREETYPE_LIBRARY=/path/to/lib/dir/libfreetype.a \
    -DGETTEXT_INCLUDE_DIR=/path/to/include/dir \
    -DGETTEXT_LIBRARY=/path/to/lib/dir/libintl.a \
    -DLUA_LIBRARY=/path/to/lib/dir/libluajit-5.1.a \
    -DOGG_LIBRARY=/path/to/lib/dir/libogg.a \
    -DVORBIS_LIBRARY=/path/to/lib/dir/libvorbis.a \
    -DVORBISFILE_LIBRARY=/path/to/lib/dir/libvorbisfile.a \
    -DOPENAL_LIBRARY=/path/to/lib/dir/libopenal.a \
    -DOPENAL_INCLUDE_DIR=/path/to/include/dir/AL \
    -DZSTD_LIBRARY=/path/to/lib/dir/libzstd.a \
    -DGMP_LIBRARY=/path/to/lib/dir/libgmp.a \
    -DJSON_LIBRARY=/path/to/lib/dir/libjsoncpp.a \
    -DENABLE_LEVELDB=OFF \
    -DENABLE_POSTGRESQL=OFF \
    -DENABLE_REDIS=OFF \
    -DJPEG_LIBRARY=/path/to/lib/dir/libjpeg.a \
    -DPNG_LIBRARY=/path/to/lib/dir/libpng.a \
    -DCMAKE_EXE_LINKER_FLAGS=-lbz2\
    -GXcode
```

--------------------------------

### Create Texture Pack via Linux Terminal

Source: https://docs.luanti.org/Creating_texture_packs

Use these commands to create a new texture pack directory and copy all PNG files from a specific game into it.

```bash
TP_NAME=your-pack-name
cd your/path/to/luanti
mkdir textures/$TP_NAME
find games/minetest_game/ -name '*.png' -exec cp '{}' "textures/$TP_NAME" ';'
```

--------------------------------

### Bundle DLLs

Source: https://docs.luanti.org/for-engine-devs/compiling/windows

Copies necessary runtime libraries to the binary folder to allow the executable to run outside the MSYS2 environment.

```bash
../util/bundle_dlls.sh ../bin/luanti.exe ../bin/
```

--------------------------------

### Atomic File Write Comparison

Source: https://docs.luanti.org/for-creators/api/filesystem

Demonstrates the logic equivalent to core.safe_file_write if it were an atomic operation.

```lua
local f = io.open(path, "wb")
f:write(content)
f:close()
```

--------------------------------

### Download source code

Source: https://docs.luanti.org/for-engine-devs/compiling/linux-server

Methods for acquiring the source code via Git or manual archive download.

```bash
git clone --depth 1 https://github.com/luanti-org/luanti
cd luanti
```

```bash
wget https://github.com/luanti-org/luanti/archive/master.tar.gz
tar xf master.tar.gz
cd luanti-master
```

--------------------------------

### Generate Media Hashes and Index

Source: https://docs.luanti.org/for-server-hosts/remote-media

Shell script to collect media files, generate SHA1 hashes, and create the index.mth file required for remote media hosting.

```bash
#!/bin/bash

collect_from () {
	echo "Processing media from: $1"
	find -L "$1" -type f -name "*.png" -o -name "*.jpg" -o -name "*.jpeg" -o -name "*.ogg" -o -name "*.x" -o -name "*.b3d" | while read f; do
		basename "$f"
		hash=`openssl dgst -sha1 <"$f" | cut -d " " -f 2`
		cp "$f" media/$hash
	done
}

mkdir -p media/
# Change this 'collect_from' or add more lines of 'collect_from', the script will recursively
# search for files with extensions of Luanti media in this folder.
# This is an example to be run in a game folder, but you can change this to anything to catch
# all textures that a server uses.
collect_from mods/
# Example for MineClone2 (they put textures in textures/ now)
#collect_from mods/
#collect_from textures/

printf "Creating index.mth... "
printf "MTHS\x00\x01" > media/index.mth
find media/ -type f -not -name index.mth | while read f; do
	openssl dgst -binary -sha1 <$f >> media/index.mth
done
```

--------------------------------

### core.mvdir

Source: https://docs.luanti.org/for-creators/api/filesystem

Moves a directory from source to destination.

```APIDOC
## core.mvdir(source_path, destination_path)

### Description
Moves a source directory to a destination. Fails if the destination is a non-empty directory.

### Arguments
- **source_path** (string) - The path to the source directory.
- **destination_path** (string) - The path to the destination directory.

### Returns
- **success** (bool) - Whether the operation succeeded.
```

--------------------------------

### Manage Android Data via ADB

Source: https://docs.luanti.org/for-players/mobile

Use these commands to transfer worlds, mods, or backups between a computer and an Android device.

```bash
adb push cool_world/ /storage/emulated/0/Android/data/net.minetest.minetest/files/Minetest/worlds/
```

```bash
adb push indev_mod/ /storage/emulated/0/Android/data/net.minetest.minetest/files/Minetest/mods/
```

```bash
adb pull /storage/emulated/0/Android/data/net.minetest.minetest/files/Minetest/worlds/cool_world/ cool_world_android_backup/
```

```bash
adb pull /storage/emulated/0/Android/data/net.minetest.minetest/files/Minetest/ minetest_android_backup/
```

--------------------------------

### core.cpdir

Source: https://docs.luanti.org/for-creators/api/filesystem

Copies a directory from source to destination.

```APIDOC
## core.cpdir(source_path, destination_path)

### Description
Copies a source directory to a destination. If the destination directory exists, it will be overwritten.

### Arguments
- **source_path** (string) - The path to the source directory.
- **destination_path** (string) - The path to the destination directory.

### Returns
- **success** (bool) - Whether the operation succeeded.
```

--------------------------------

### Locate Built APKs

Source: https://docs.luanti.org/for-engine-devs/compiling/android

Command to find the generated APK files in the build output directory.

```bash
$ find -name '*.apk'
./app/build/outputs/apk/debug/app-armeabi-v7a-debug.apk
./app/build/outputs/apk/debug/app-x86_64-debug.apk
./app/build/outputs/apk/debug/app-x86-debug.apk
./app/build/outputs/apk/debug/app-arm64-v8a-debug.apk
```

--------------------------------

### core.register_globalstep

Source: https://docs.luanti.org/for-creators/api/timing-and-event-loop

Registers a function to be called every server step.

```APIDOC
## core.register_globalstep

### Description
Registers a function to be called every server step.

### Parameters
- **func** (function) - The function to call. It receives `dtime` (the time elapsed since the last step) as an argument.
```

--------------------------------

### Define developer version full format

Source: https://docs.luanti.org/for-engine-devs/version-number

The complete version string for developer builds, including commit hash and dirty status.

```text
<FUTURE_VERSION>-dev-<COMMIT><DIRTY>
```

--------------------------------

### Implement entity on_step callback

Source: https://docs.luanti.org/for-creators/api/timing-and-event-loop

Defines the per-entity callback triggered every globalstep, providing the delta time since the last step.

```lua
function entity:on_step(dtime, ...)
	-- use dtime
end
```

--------------------------------

### Resume raycast iteration

Source: https://docs.luanti.org/for-creators/api/classes/raycast

Shows how a raycast can be resumed after breaking from a loop.

```lua
local ray = Raycast(...)
for pt in ray do
	if ... then break end
end
for pt in ray do
	-- will resume looping with the next pointed thing
end
```

--------------------------------

### Typical B3D File Structure

Source: https://docs.luanti.org/for-creators/models/b3d-spec

Shows the high-level organization of a standard B3D file containing textures, brushes, and nodes.

```text
BB3D
  1
  TEXS
    ...list of textures...
  BRUS
    ...list of brushes...
  NODE
    ...stuff in the node...
```

--------------------------------

### Check for game-specific mod support

Source: https://docs.luanti.org/for-creators/mod-dependency-management

Use this pattern to provide compatibility across different games by checking for the presence of specific mods.

```lua
if core.get_modpath("default") then
    -- Code path for Minetest Game
elseif core.get_modpath("mcl_core") then
    -- Code path for Voxelibre or forks
end
```

--------------------------------

### Define a Luanti server with Docker Compose

Source: https://docs.luanti.org/for-server-hosts/setup/docker

A basic compose.yml configuration for running the Luanti server container with volume mounts for configuration, data, and mods.

```yaml
services:
  luanti_server:
    image: ghcr.io/luanti-org/luanti:latest
    restart: unless-stopped
    volumes:
      - ./config:/etc/minetest:ro
      - ./data:/var/lib/minetest
      - ./games:/var/lib/minetest/.minetest/games:ro
      - ./mods:/var/lib/minetest/.minetest/mods:ro
    ports:
      - "30000:30000/udp"
```

--------------------------------

### Configure Component Discovery Regular Expression

Source: https://docs.luanti.org/for-creators/translation/weblate

Use this regex to match PO translation files within the mod directory structure.

```regex
mods/(?P<component>[a-zA-Z0-9_]*)/locale/(?P=component)\.(?P<language>[a-z]*)\.po
```

--------------------------------

### Configure CMake for mold Linker

Source: https://docs.luanti.org/for-engine-devs/compiling/improving-build-times

Pass these linker flags to CMake to utilize the high-performance mold linker.

```bash
-DCMAKE_EXE_LINKER_FLAGS="-fuse-ld=mold" -DCMAKE_SHARED_LINKER_FLAGS="-fuse-ld=mold"
```

--------------------------------

### Formatting Conditional Statements

Source: https://docs.luanti.org/Lua_code_style_guidelines

Demonstrates preferred formatting for conditional statements, favoring readability over compacting multiple statements on one line.

```lua
local f, err = io.open(filename, "r")
if not f then return err end

if     foo then return foo
elseif bar then return bar
elseif qux then return qux
end
```

```lua
if not f and use_error then error(err) elseif not f then return err end
```

--------------------------------

### Check for optional global dependencies

Source: https://docs.luanti.org/for-creators/warnings

Use rawget or core.global_exists to safely check for the existence of an optional mod dependency.

```lua
-- at the top of the file:
local my_opt_dep = rawget(_G, "my_opt_dep")
...
-- somewhere deep in the remaining code:
if my_opt_dep then my_opt_dep.frobnicate(...) end
```
Tokens:
Raw