Modular Multipurpose Minetest Modding Library
Go to file
2021-09-15 00:11:04 +02:00
minetest Commit missed deletion of "improve globalstep timing" 2021-09-15 00:11:04 +02:00
persistence Fix SQLite3 requiring for trusted modlib 2021-08-09 14:30:55 +02:00
.gitignore Add SQLite3 database persistence 2021-07-14 21:52:13 +02:00
b3d_specification.txt Experimental Blitz3D .b3d file reader 2021-01-31 21:41:42 +01:00
b3d.lua Redo environments 2021-06-17 19:45:08 +02:00
binary.lua Use math constants 2021-08-09 13:58:10 +02:00
bluon.lua Bluon: Fix nan reading 2021-08-09 13:46:15 +02:00
conf.lua Redo environments 2021-06-17 19:45:08 +02:00
debug.lua Redo environments 2021-06-17 19:45:08 +02:00
file.lua Rename split_extension to get_extension 2021-09-01 17:09:14 +02:00
func.lua Simplify func.iterate 2021-08-08 23:32:50 +02:00
hashlist.lua Use tabs not spaces 2021-07-14 11:53:42 +02:00
heap.lua Redo environments 2021-06-17 19:45:08 +02:00
init.lua Expose JSON module 2021-09-07 21:08:46 +02:00
json.lua Add experimental JSON module 2021-09-07 20:52:42 +02:00
kdtree.lua Redo environments 2021-06-17 19:45:08 +02:00
License.txt Add proper license file 2021-07-06 22:03:44 +02:00
log.lua Redo environments 2021-06-17 19:45:08 +02:00
logo.svg Minor logo fixes 2021-09-11 10:10:52 +02:00
luon.lua Use tabs not spaces 2021-07-14 11:53:42 +02:00
math.lua Add special value support to math.tostring 2021-08-16 20:07:23 +02:00
minetest.lua Add experimental minetest.media module 2021-08-29 11:41:10 +02:00
mod.conf Large configuration improvements, text helpers 2020-06-02 23:07:33 +02:00
mod.lua Redo environments 2021-06-17 19:45:08 +02:00
persistence.lua Fix SQLite3 requiring for trusted modlib 2021-08-09 14:30:55 +02:00
player.lua Add table to player.lua locals 2021-06-18 20:42:32 +02:00
quaternion.lua Fix quaternion.from_euler_rotation 2021-08-29 11:42:03 +02:00
ranked_set.lua Redo environments 2021-06-17 19:45:08 +02:00
Readme.md Add a logo 2021-09-10 21:08:13 +02:00
schema.lua Redo environments 2021-06-17 19:45:08 +02:00
screenshot.png Large configuration improvements, text helpers 2020-06-02 23:07:33 +02:00
table.lua Fix table.shuffle off-by-one error 2021-08-30 23:02:01 +02:00
test.lua Remove assertion message 2021-09-07 21:08:08 +02:00
text.lua Add text.trim_spacing 2021-08-29 15:41:51 +02:00
trie.lua Redo environments 2021-06-17 19:45:08 +02:00
vector.lua Vector: Remove modlib dependency 2021-08-29 10:52:41 +02:00

Logo Modding Library (modlib)

Multipurpose Minetest Modding Library

About

No dependencies. Licensed under the MIT License. Written by Lars Mueller aka LMD or appguru(eu).

API

Mostly self-documenting code. Mod namespace is modlib, containing all variables & functions.

Persistence

Lua Log Files

A data log file based on Lua statements. Experimental. High performance. Example from test.lua:

local logfile = persistence.lua_log_file.new(mod.get_resource"logfile.test.lua", {})
logfile:init()
logfile.root = {}
logfile:rewrite()
logfile:set_root({a = 1}, {b = 2, c = 3})
logfile:close()
logfile:init()
assert(table.equals(logfile.root, {[{a = 1}] = {b = 2, c = 3}}))

Both strings and tables are stored in a reference table. Unused strings won't be garbage collected as Lua doesn't allow marking them as weak references. This means that setting lots of temporary strings will waste memory until you call :rewrite() on the log file. An alternative is to set the third parameter, reference_strings, to false (default value is true):

persistence.lua_log_file.new(mod.get_resource"logfile.test.lua", {}, false)

This will prevent strings from being referenced, possibly bloating file size, but saving memory.

SQLite3 Database Persistence

Uses a SQLite3 database to persistently store a Lua table. Experimental.. Obtaining it is a bit trickier, as it requires access to the lsqlite3 library, which may be passed:

local modlib_sqlite3 = persistence.sqlite3(require"lsqlite3")

(assuming require is that of an insecure environment if Minetest is used)

Alternatively, if you are not running Minetest, mod security is disabled, you have (temporarily) provided require globally, or added modlib to secure.trusted_mods, you can simply do the following:

local modlib_sqlite3 = persistence.sqlite3()

Modlib will then simply call require"lsqlite3" for you.

Then, you can proceed to create a new database:

local database = persistence.modlib_sqlite3.new(mod.get_resource"database.test.sqlite3", {})
-- Create or load
database:init()
-- Use it
database:set_root("key", {nested = true})
database:close()

It uses a similar API to Lua log files:

  • new(filename, root) - without reference_strings however (strings aren't referenced currently)
  • init
  • set
  • set_root
  • rewrite
  • close

The advantage over Lua log files is that the SQlite3 database keeps disk usage minimal. Unused tables are dropped from the database immediately through reference counting. The downside of this is that this, combined with the overhead of using SQLite3, of course takes time, making updates on the SQLite3 database slower than Lua log file updates (which just append to an append-only file). As simple and fast reference counting doesn't handle cycles, an additional collectgarbage stop-the-world method performing a full garbage collection on the database is provided which is called during init. The method defragment_ids should not have to be used in practice (if it has to be, it happens automatically) and should be used solely for debugging purposes (neater IDs).

Bluon

Binary Lua object notation. Experimental. Handling of subnormal numbers (very small floats) may be broken.

new(def)

def = {
	aux_is_valid = function(object)
		return is_valid
	end,
	aux_len = function(object)
		return length_in_bytes
	end,
	-- read type byte, stream providing :read(count), map of references -> id
	aux_read = function(type, stream, references)
		... = stream:read(...)
		return object
	end,
	-- object to be written, stream providing :write(text), list of references
	aux_write = function(object, stream, references)
		stream:write(...)
	end
}

:is_valid(object)

Returns whether the given object can be represented by the instance as boolean.

:len(object)

Returns the expected length of the object if serialized by the current instance in bytes.

:write(object, stream)

Writes the object to a stream supporting :write(text). Throws an error if invalid.

:read(stream)

Reads a single bluon object from a stream supporting :read(count). Throws an error if invalid bluon.

Checking whether the stream has been fully consumed by doing assert(not stream:read(1)) is left up to the user.

Format

  • nil: nothing ("")
  • false: 0
  • true: 1
  • Numbers:
    • Constants: 0, nan, +inf, -inf
    • Integers: Little endian U8, U16, U32, U64, -U8, -U16, -U32, -U64
    • Floats: Little endian F32, F64
  • Strings:
    • Constant: ""
    • Length as unsigned integer: T8, T16, T32, T64
  • Tables:
    • List and map part count as unsigned integers
    • L0, L8, L16, L32, L64 times M0, M8, M16, M32, M64
  • Reference:
    • Reference ID as unsigned integer: R8, R16, R32, R64
  • Reserved types:
    • Everything <= 55 => 200 free types

Features

  • Embeddable: Written in pure Lua
  • Storage efficient: No duplication of strings or reference-equal tables
  • Flexible: Can serialize circular references and strings containing null

Simple example

local object = ...
-- Write to file
local file = io.open(..., "wb")
modlib.bluon:write(object, file)
file:close()
-- Write to text
local rope = modlib.table.rope{}
modlib.bluon:write(object, rope)
text = rope:to_text()
-- Read from text
local inputstream = modlib.text.inputstream"\1"
assert(modlib.bluon:read(object, rope) == true)

Advanced example

-- Serializes all userdata to a constant string:
local custom_bluon = bluon.new{
	aux_is_valid = function(object)
		return type(object) == "userdata"
	end,
	aux_len = function(object)
		return 1 + ("userdata"):len())
	end,
	aux_read = function(type, stream, references)
		assert(type == 100, "unsupported type")
		assert(stream:read(("userdata"):len()) == "userdata")
		return userdata()
	end,
	-- object to be written, stream providing :write(text), list of references
	aux_write = function(object, stream, references)
		assert(type(object) == "userdata")
		stream:write"\100userdata"
	end
}
-- Write to text
local rope = modlib.table.rope{}
custom_bluon:write(userdata(), rope)
assert(rope:to_text() == "\100userdata")

Schema

Place a file schema.lua in your mod, returning a schema table.

Non-string entries and minetest.conf

Suppose you have the following schema:

return {
	type = "table",
	entries = {
		[42] = {
			type = "boolean",
			description = "The Answer"
			default = true
		}
	}
}

And a user sets the following config:

mod.42 = false

It won't work, as the resulting table will be {["42"] = false} instead of {[42] = false}. In order to make this work, you have to convert the keys yourself:

return {
	type = "table",
	keys = {
		-- this will convert all keys to numbers
		type = "number"
	},
	entries = {
		[42] = {
			type = "boolean",
			description = "The Answer"
			default = true
		}
	}
}

This is best left explicit. First, you shouldn't be using numbered field keys if you want decent minetest.conf support, and second, modlib's schema module could only guess in this case, attempting conversion to number / boolean. What if both number and string field were set as possible entries? Should the string field be deleted? And so on.

Configuration

Legacy

  1. Configuration is loaded from <worldpath>/config/<modname>.<extension>, the following extensions are supported and loaded (in the given order), with loaded configurations overriding properties of previous ones:
    1. json
    2. lua
    3. luon, Lua but without the return
    4. conf
  2. Settings are loaded from minetest.conf and override configuration values

Locations

  1. Default configuration: <modfolder>/conf.lua
  2. World configuration: config/<modname>.<format>
  3. Mod configuration: <modfolder>/conf.<format>
  4. Minetest configuration: minetest.conf

Formats

  1. lua
  • Lua, with the environment being the configuration object
  • field = value works
  • Return new configuration object to replace
  1. luon
  • Single Lua literal
  • Booleans, numbers, strings and tables
  1. conf
  • Minetest-like configuration files
  1. json
  • Not recommended

debug

modlib.debug offers utilities dumping program state in tables.

variables(stacklevel)

Dumps local variables, upvalues and the function environment of the function at the given stacklevel (default 1).

stack(stacklevel)

Dumps function info & variables for all functions in stack, starting with stacklevel (default 1).

minetest

schematic

A schematic format with support for metadata and baked light data. Experimental.

Release Notes

rolling-73

  • Fixes Mesecons LuaController overheating by luk3yx

rolling-71

  • Fixes
    • Colorspec
      • Stricter patterns in colorspec:from_string
      • colorspec:to_string works now
    • Lua log file
      • Patched memory leaks
        • Added option to not reference strings
      • Handling of circular tables
  • Additions
    • luon: Configurable serialization to and from Lua with circular and string reference support
      • minetest.luon even supports ItemStack and AreaStore
    • vector.rotate3
    • table.deep_foreach_any
    • func:
      • func.iterate
      • func.aggregate
      • Functional wrappers for operators
  • Improvements
    • Code quality
    • Performance
  • Proper license file

rolling-70

  • Fixes module environments once and for all
  • Fixes vector aliases
  • Presumably boosts performance

rolling-69

  • Fixes various things, most importantly modules indexing the global table

rolling-68

  • Replace changelog by release notes (see the commit log for changes)

rolling-67

  • Fixes various things, most importantly objects indexing the global table
    • Concerns kdtree, trie, ranked_set, vector, schema

rolling-66

  • Adds modlib.persistence.lua_log_file

rolling-62

  • Fix modlib.func.curry_tail
  • Change b3d:get_animated_bone_properties to return a list according to hierarchy

rolling-61

  • Fix quaternion.to_euler_rotation

rolling-60

  • Fix vector.interpolate

rolling-59

  • Schema failing check handling fixes

rolling-58

  • Schema improvements & docs

rolling-57

  • Uses minetest.safe_file_write for file.write

rolling-56

  • Fixes math.fround
  • Other minor fixes
  • Switch to lazy loading
    • Do _ = modlib.<module> to avoid lag spikes at run time