A module to help you save / load config and player data in your Defold projects between sessions
You can use DefSave in your own project by adding this project as a Defold library dependency. Open your game.project file and in the dependencies field under project add:
https://github.com/subsoap/defsave/archive/master.zip
Once added, you must require the main Lua module in scripts via
local defsave = require("defsave.defsave")
First set your game's appname
defsave.appname = "my_awesome_game"
Load a file
defsave.load("config")
Get a key from a loaded file
defsave.get("config", "audio")
Set a key to a loaded file
defsave.set("config", "fullscreen", false)
Save a file
defsave.save("config")
You can save all files at once. By default, it will only actually save files with changes, but you can force saving all files by setting the force flag to true.
defsave.save_all() -- only saves changed files
defsave.save_all(true) -- saves all files
In your update, if you want autosave to be enabled, you will need to include
defsave.update(dt)
To save all files on the ending of your game you need to include in final
defsave.save_all()
You can setup template defaults for your files too. These are used if you set defsave.use_default_data to true which is true by default. While use_default_data is true defsave will check the defsave.default_data table to see if there is any default data there when a file is loaded which is empty. Check the example for an example of default_data.lua and how it can be set.
Don't include an extension in your file names. Use "config" over "config.dat" for example.
Don't name your filenames with a leading number or any character not allowed in Lua variable names. Use "profile_1" not "1" for example.
By default, the contents of the saved files are not encrypted, but support for this is coming soon.
Set verbose to true to also print any successful messages, otherwise only errors or warnings will be printed.
If you need to backup or clear your save data you can find it in:
Windows
%appdata%\Roaming\appname\filename
OS X
~/Library/Application Support/appname/filename
Linux (default path is slightly modified to be within .config user folder)
~/.config/appname/filename
iOS
/var/mobile/Containers/Data/Application/{app-uid?}/Library/Application Support/appname/filename
Android
/data/data/com.packagename/files/filename
HTML5
Uses localStorage, under item named "appname_filename".
The appname is based on the function for getting the path sys.get_save_file("appname", "filename") by default DefSave saves in the OS appropriate location and not next to the binary.