mod-wdata/README.md

45 lines
1.2 KiB
Markdown
Raw Normal View History

2021-05-28 09:24:10 +02:00
## World Data Manager library for Minetest
2021-05-28 07:12:23 +02:00
### Description:
2021-05-28 09:09:47 +02:00
A [Minetest][] library for managing data files in the world directory.
2021-05-28 07:12:23 +02:00
2021-05-28 09:24:10 +02:00
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.
2021-05-28 07:12:23 +02:00
### Licensing:
- [MIT](LICENSE.txt)
### Usage:
2021-05-28 09:09:47 +02:00
There are two methods:
```
2021-05-28 09:24:10 +02:00
- wdata.read(fname)
2021-05-28 09:09:47 +02:00
- 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").
2021-05-28 09:24:10 +02:00
- wdata.write(fname, data[, styled])
2021-05-28 09:09:47 +02:00
- 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.
- styled: Outputs in a human-readable format if this is set (default: true).
```
### Requirements:
```
Depends: none
Optional depends: none
```
2021-05-28 07:12:23 +02:00
### Links
2021-05-28 09:09:47 +02:00
- [Forum](https://forum.minetest.net/viewtopic.php?t=26804)
2021-05-28 09:24:10 +02:00
- [Git repo](https://github.com/AntumMT/mod-wdata)
- [API](https://antummt.github.io/mod-wdata/docs/api.html)
2021-05-28 07:12:23 +02:00
- [Changelog](changelog.txt)
- [TODO](TODO.txt)
[Minetest]: http://minetest.net/