Custom resource format loaders

This guide assumes the reader knows how to create C++ modules and Godot data types. If not, refer to this guide .

• core/io/resource_loader.cpp

What for?

• Adding new support for many file formats

• Audio formats

• Video formats

• Raster images

ImageFormatLoader should be used to load images.

• core/io/image_loader.h

Creating a ResourceFormatLoader

Each file format consist of a data container and a .

ResourceFormatLoaders are usually simple classes which return all the necessary metadata for supporting new extensions in Godot. The class must return the format name and the extension string.

In addition, ResourceFormatLoaders must convert file paths into resources with the load function. To load a resource, load must read and handle data serialization.

/* resource_loader_json.cpp */
#include "resource_loader_json.h"
#include "resource_json.h"
RES ResourceFormatLoaderJson::load(const String &p_path, const String &p_original_path, Error *r_error) {
Ref<JsonResource> json = memnew(JsonResource);
    if (r_error) {
            *r_error = OK;
    }
    Error err = json->load_file(p_path);
    return json;
}
void ResourceFormatLoaderJson::get_recognized_extensions(List<String> *r_extensions) const {
    if (!r_extensions->find("json")) {
            r_extensions->push_back("json");
    }
}
String ResourceFormatLoaderJson::get_resource_type(const String &p_path) const {
    return "Resource";
}
bool ResourceFormatLoaderJson::handles_type(const String &p_type) const {
    return ClassDB::is_parent_class(p_type, "Resource");
}

If you’d like to be able to edit and save a resource, you can implement a ResourceFormatSaver:

/* resource_saver_json.h */
#ifndef RESOURCE_SAVER_JSON_H
#define RESOURCE_SAVER_JSON_H
#include "core/io/resource_saver.h"
class ResourceFormatSaverJson : public ResourceFormatSaver {
    GDCLASS(ResourceFormatSaverJson, ResourceFormatSaver);
public:
    virtual Error save(const String &p_path, const RES &p_resource, uint32_t p_flags = 0);
    virtual bool recognize(const RES &p_resource) const;
    virtual void get_recognized_extensions(const RES &p_resource, List<String> *r_extensions) const;
};
#endif // RESOURCE_SAVER_JSON_H

Creating custom data types

Godot may not have a proper substitute within its Core types or managed resources. Godot needs a new registered data type to understand additional binary formats such as machine learning models.

#ifndef RESOURCE_JSON_H
#define RESOURCE_JSON_H
#include "core/io/json.h"
#include "core/variant_parser.h"
class JsonResource : public Resource {
    GDCLASS(JsonResource, Resource);
protected:
    static void _bind_methods() {
            ClassDB::bind_method(D_METHOD("get_dict"), &JsonResource::get_dict);
            ADD_PROPERTY(PropertyInfo(Variant::DICTIONARY, "content"), "set_dict", "get_dict");
    }
private:
    Dictionary content;
public:
    Error load_file(const String &p_path);
    Error save_file(const String &p_path, const RES &p_resource);
    void set_dict(const Dictionary &p_dict);
    Dictionary get_dict();
};
#endif // RESOURCE_JSON_H

/* resource_json.cpp */
#include "resource_json.h"
Error JsonResource::load_file(const String &p_path) {
    Error error;
    FileAccess *file = FileAccess::open(p_path, FileAccess::READ, &error);
    if (error != OK) {
            if (file) {
                    file->close();
            }
            return error;
    }
    String json_string = String("");
    while (!file->eof_reached()) {
            json_string += file->get_line();
    }
    file->close();
    String error_string;
    int error_line;
    JSON json;
    Variant result;
    error = json.parse(json_string, result, error_string, error_line);
    if (error != OK) {
            file->close();
            return error;
    }
    content = Dictionary(result);
    return OK;
}
Error JsonResource::save_file(const String &p_path, const RES &p_resource) {
    FileAccess *file = FileAccess::open(p_path, FileAccess::WRITE, &error);
    if (error != OK) {
            if (file) {
                    file->close();
            }
            return error;
    }
    Ref<JsonResource> json_ref = p_resource.get_ref_ptr();
    JSON json;
    file->store_string(json.print(json_ref->get_dict(), "    "));
    file->close();
    return OK;
}
void JsonResource::set_dict(const Dictionary &p_dict) {
    content = p_dict;
}
Dictionary JsonResource::get_dict() {
    return content;
}

Some libraries may not define certain common routines such as IO handling. Therefore, Godot call translations are required.

For example, here is the code for translating FileAccess calls into std::istream.

• streambuf

Godot registers ResourcesFormatLoader with a ResourceLoader handler. The handler selects the proper loader automatically when load is called.

/* register_types.h */
void register_json_types();
void unregister_json_types();

/* register_types.cpp */
#include "register_types.h"
#include "core/class_db.h"
#include "resource_loader_json.h"
#include "resource_saver_json.h"
#include "resource_json.h"
static Ref<ResourceFormatLoaderJson> json_loader;
static Ref<ResourceFormatSaverJson> json_saver;
void register_json_types() {
    ClassDB::register_class<JsonResource>();
    json_loader.instance();
    ResourceLoader::add_resource_format_loader(json_loader);
    json_saver.instance();
    ResourceSaver::add_resource_format_saver(json_saver);
}
void unregister_json_types() {
    ResourceLoader::remove_resource_format_loader(json_loader);
    json_loader.unref();
    ResourceSaver::remove_resource_format_saver(json_saver);
    json_saver.unref();
}

• core/io/resource_loader.cpp

Loading it on GDScript

Then attach the following script to any node:

extends Node
onready var json_resource = load("res://demo.json")