Skip to content
BasaltProjectPublic

About

Build and package Lua plugins for Basalt

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

Basalt Basalt

Basalt Kiln

Compiles and verifies the Lua of a Basalt plugin. Native, no JVM.

C++ Lua Platforms License

About

Kiln is the command line for writing plugins. For a plugin folder it verifies plugin.toml, every Lua file, each require and every name taken from the Basalt API, and reports what is wrong before the plugin reaches a server. It compiles to Lua bytecode with the same Lua 5.5.1 the server runs, scaffolds new plugins, packs .bspkg (.bppkg for the proxy), runs plugin tests and signs builds.

kiln check <plugin|file.lua|dir>      verify, write nothing
kiln compile <plugin|file.lua|dir>    verify, then write the bytecode
kiln new <id> [name]                  create a new plugin
kiln pack [plugin]                    verify, then pack a .bspkg
kiln test [plugin]                    verify, then run its tests
$ kiln check arena
src/main.lua:1: no module `missing` in src/
src/main.lua:3: `log.infoo` is not part of the API
2 problem(s)

Use --target server|proxy to pick the product (default server) and kiln --help for the rest.

Download

Each release on the releases page carries the executable and a SHA256SUMS file. Put it on your PATH as kiln.

Building

git submodule update --init
cmake --preset release && cmake --build build/release

Needs CMake 3.28+, Ninja and Clang.

License

GPL-3.0-only.

About

Build and package Lua plugins for Basalt

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Contributors

Languages