mirror of
https://github.com/AntumMT/mod-wdata.git
synced 2024-07-04 15:05:19 +02:00
Update README
This commit is contained in:
parent
fcff032c4d
commit
73409fc7ca
27
README.md
27
README.md
@ -2,9 +2,9 @@
|
||||
|
||||
### Description:
|
||||
|
||||
A [Minetest][] mod for simplifying reading & writing configuration files in the world directory.
|
||||
A [Minetest][] library for managing data files in the world directory.
|
||||
|
||||
***WARNING:** this mod is in early development & not ready for live use*
|
||||
It takes a little work to read from & write to data in the world directory. wconfig aims to make that easier by utilizing just two simple methods.
|
||||
|
||||
### Licensing:
|
||||
|
||||
@ -12,8 +12,31 @@ A [Minetest][] mod for simplifying reading & writing configuration files in the
|
||||
|
||||
### Usage:
|
||||
|
||||
There are two methods:
|
||||
|
||||
```
|
||||
- wconfig.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").
|
||||
- wconfig.write(fname, data[, styled])
|
||||
- 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
|
||||
```
|
||||
|
||||
### Links
|
||||
|
||||
- [Forum](https://forum.minetest.net/viewtopic.php?t=26804)
|
||||
- [Git repo](https://github.com/AntumMT/mod-wconfig)
|
||||
- [API](https://antummt.github.io/mod-wconfig/docs/api.html)
|
||||
- [Changelog](changelog.txt)
|
||||
- [TODO](TODO.txt)
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user