mod-wdata/README.md
2021-08-28 21:04:11 -07:00

1.9 KiB

World Data Manager library for Minetest

Description:

A Minetest library for managing data files in the world directory.

It takes a little work to read from & write to data in the world directory. wdata aims to make that easier by utilizing just two simple methods.

This mod is essentially an alternative to Minetest's built-in StorageRef & was created before I realized the implementation existed. Some may still find wdata useful as it does allow for customizing sub-directories & filenames.

icon

Licensing:

Usage:

There are two methods:

- wdata.read(fname)
  - reads json data from file in world directory & converts to a table.
  - fname:  File basename without suffix (e.g. "my_config" or "my_mod/my_config").

- wdata.write(fname, data[, flags])
  - converts table to json data & writes to file in world directory.
  - fname:  File basename without suffix (e.g. "my_config" or "my_mod/my_config").
  - data:   Table containing data to be exported.
  - flags: Table of modifying flags.
    - styled: Outputs in a human-readable format if this is set (default: true).
    - null_to_table: "null" values will be converted to tables in output (default: `false`).

Requirements:

Depends:          none
Optional depends: none