Create README.md

This commit is contained in:
RealBadAngel 2014-01-25 15:11:40 +01:00
parent 22a2a50ccd
commit 4bcd5938fe

20
README.md Normal file

@ -0,0 +1,20 @@
datastorage
===========
Helper mod to manage players data.
All the mods can acces a single file (container) and easily have the data saved/loaded for them.
Use:
local container = datastorage.get_container (mod_name, player)
returns the table for given mod and a player.
If container wasnt used before it will be created, otherwise it will contain all previously stored data.
The table can store any data.
Player's containers will be saved to disk on player leave.
All the containers will be saved on server shutdown.
To force save all player's data, use:
datastorage.save_container (player)