snowyu/minetest_yaml

Minetest YAML Config Library Mod

Sample YAML Config Format:

# totalPlayTime unit is minute
totalPlayTime: 30
# Whether skip the question which has already be answered correctly.
skipAnswered: 1
# checkInterval unit is seconds
checkInterval: 10
# idleInterval unit is minute
idleInterval: 1
# question list
quiz:
  - id: favorColor
    title: "What's my favor color?"
    answer: red
  - id: theYear
  - title: "What's the year?"
    answer: 2021

Usage

local MOD_NAME = minetest.get_current_modname()
-- load config from file,
-- first load the my-config.yml file in mod directory as default settings
-- then try to load from world directory:
-- the filename in the world folder is MOD_NAME .. "_my-config.yml"
local settings = yaml.readConfig(MOD_NAME, "my-config.yml")
-- save the config file to world directory
-- the default filename is "config.yml" if filename not exists
-- the filename in the world folder is MOD_NAME .. "_" .."my_config.yml"
yaml.writeConfig(settings, "my-config.yml")
-- append config to file
yaml.writeConfig({ {time = os.time(), content = "content"} }, "my-log.yml", "a")

API

• yaml.readConfig(modName, filename = "config.yml", exclude = nil)
  • first load the yaml file in mod directory as default settings
  • then load file from mod_data directory if exists
  • last load file from world directory
  • return merge the settings together at last, ignore the keys in exclude list.
• yaml.writeConfig(settings, filename = "config.yml", modName, mode = "wb")
  • first try to save the configuration file in the "mod_data" folder first
  • if fails, save it in the world directory
• yaml.readYamlFile(filepath)
  • read a YAML format file
• yaml.readModConfig(filename, modName)
• yaml.readModDataConfig(filename, modName)
  • Note: you should merge the world-independent storage directory for mods branch before using this.
  • The config file name could be [filename].yml or [modName]_[filename].yml
• yaml.readWorldConfig(filename)
• yaml.writeYamlFile(filepath, content, mode = "wb")
• yaml.writeModConfig(filename, content, modName, mode = "wb")
• yaml.writeModDataConfig(filename, content, modName, mode = "wb")
  • Note: you should merge the world-independent storage directory for mods branch before using this.
• yaml.writeWorldConfig(content, filename, mode = "wb")
• yaml.readFile(filepath, mode = "rb")
  • read whole file
  • return content if successful
• yaml.writeFile(filepath, content, mode = "wb")
  • return true if successful
• yaml.dump(obj)
  • convert the obj to YAML string
• yaml.eval(str)
  • convert the str to the lua object.
• yaml.defaults(target, default)
  • merge the default to the target table
  • return target
• yaml.contains(list, value)
  • whether the list contains the value.

Using the lua-yaml as yaml parser.

minetest_yaml's Issues

Mod security: Blocked attempted read

Setting up the quiz mod I got this error from mod security (Minetest 5.6.1)

ModError: Failed to load and run script from /Users/harrywood/Library/Application Support/minetest/mods/quiz/init.lua:
Mod security: Blocked attempted read from /Users/harrywood/Library/Application Support/minetest/mod_data/quiz/config.yml
stack traceback:
	[C]: in function 'open'
	.../Library/Application Support/minetest/mods/yaml/init.lua:44: in function 'readFile'
	.../Library/Application Support/minetest/mods/yaml/init.lua:72: in function 'readModDataConfig'
	.../Library/Application Support/minetest/mods/yaml/init.lua:109: in function 'readConfig'
	.../Library/Application Support/minetest/mods/quiz/init.lua:30: in main chunk
Check debug.txt for details.

I guess it means this needs updating to avoid doing file reads which upset mod security? ...or maybe I'm just doing something wrong.

I did manage to hack it work by modifying this line which sets 'modDataPath'. But I just crudely swapped it to

local modDataPath = WORLD_PATH .. filename