krzysztof-o / resource-loader

A middleware-style generic resource loader built with web games in mind.

Resource Loader

A generic resource loader, made with web games in mind.

Usage

// ctor
var loader = new Loader();

loader
    // chainable `add` to enqueue a resource
    .add(name, url, options)

    // chainable `before` to add a middleware that runs for each resource, *before* loading a resource.
    // this is useful to implement custom caching modules (using filesystem, indexeddb, memory, etc).
    .before(cachingMiddleware);

    // chainable `after` to add a middleware that runs for each resource, *after* loading a resource.
    // this is useful to implement custom parsing modules (like spritesheet parsers, spine parser, etc).
    .after(parsingMiddleware);


    // `load` method loads the queue of resources, and calls the passed in callback called once all
    // resources have loaded.
    .load(function (loader, resources) {
        // resources is an object where the key is the name of the resource loaded and the value is the resource object.
        // They have a couple default properties:
        // - `url`: The URL that the resource was loaded from
        // - `error`: The error that happened when trying to load (if any)
        // - `data`: The raw data that was loaded
        // also may contain other properties based on the middleware that runs.
    });

// throughout the process multiple events can happen.
loader.on('progress', ...); // called once per loaded/errored file
loader.on('error', ...); // called once per errored file
loader.on('load', ...); // called once per loaded file
loader.on('complete', ...); // called once when the queued resources all load.

Building

You will need to have node and gulp setup on your machine.

Then you can install dependencies and build:

npm i && npm run build

That will output the built distributables to ./dist.

Supported Browsers

• IE 10+
• FF 13+
• Chrome 20+
• Safari 6+
• Opera 12.1+

To Do:

• IE 9 support