Skip to content

edu-minetest/yaml

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

34 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Minetest YAML Config Library Mod

ContentDB

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)
  • yaml.readWorldConfig(filename)
  • yaml.writeYamlFile(filepath, content, mode = "wb")
  • yaml.writeModConfig(filename, content, modName, mode = "wb")
  • yaml.writeModDataConfig(filename, content, modName, mode = "wb")
  • 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.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published