README.md

JSON Minifier for the Godot Engine

This simple asset makes it possible to load json with comments (jsonc) into Godot. The JSON minifier removes all comments from a jsonc so it can be correctly parsed afterwards by Godot's parse_json() without error.

Example .jsonc-file

{
    // This is my array of animals for my zoo!
    "animals": [
        {
            "tiger": {
                "amount": 2
            },
            "pelican": {
                "amount": 69 // nice
            },
            // Unicorns don't exist!
            /*
            "unicorn": {
                "amount": 1
            }
            */
        }
    ]
}

Which, after going though .minify_json, will be stripped of comments as such:

{
    "animals": [
        {
            "tiger": {
                "amount": 2
            },
            "pelican": {
                "amount": 69
            },
        }
    ]
}

Example usage:

static func load_JSON(path : String):
	var file : File = File.new()
	var error : int = file.open(path, File.READ)
	if error == OK:
		var text : String = file.get_as_text()
		file.close()
		text = JSONMinifier.minify_json(text)
		var parse_result = parse_json(text)
		if parse_result is Array or parse_result is Dictionary:
			return parse_result
		else:
      			push_error("Failed to correctly process '{0}', check file format!".format([path]))
      			return {}
  	else:
    		push_error("Failed to open '{0}', check file availability!".format([path]))
    		return {}

Credits

Code is heavily inspired by the (stale) python-branch of the JSON.minify repository as found here and has been adapted to Godot from there.