Wondering what’s next for npm?Check out our public roadmap! »

    gl-tiled
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.0 • Public • Published

    gl-tiled

    A WebGL renderer for maps created with the Tiled Editor.

    Tested with Tiled Map Editor v1.3.3.

    Contents

    Usage

    For the most basic usage, you only need to provide a JS object that represents the parsed JSON Tiled map and a WebGL Context to render with.

    // Create the map instance. `mapData` is the parsed Tiled JSON map,
    // and `gl` is the WebGLRenderingContext.
    var tilemap = new glTiled.Tilemap(mapData, { gl });
     
    // size the viewport of the map
    tileMap.resizeViewport(gl.canvas.width, gl.canvas.height);
     
    // setup a update and render loop
    var lastTime = 0;
    (function draw(now)
    {
        requestAnimationFrame(draw);
     
        // update animations, if your map has no animated tiles
        // you can skip this step.
        var dt = now - lastTime;
        lastTime = now;
        tileMap.update(dt); // dt is expected to be elapsed ms since last call.
     
        // draw!
        tileMap.draw();
    })();

    Framework Bundles

    This library also ships with a number of bundles (gl-tiled.<bundle-name>.js). These bundles contain the code necessary for gl-tiled to integrate with other frameworks. Each bundle is listed below, with a short description of what they do. For more information click their Documentation link.

    Core (gl-tiled.js) - Documentation

    This is the core library bundle. It is meant to work with WebGL, and therefore can work with any framework. However, it does not provide any special code to ease integration with those frameworks.

    Resource Loader (gl-tiled.resource-loader.js) - Documentation

    The Resource Loader bundle a resource-loader middleware that makes it easy to load Tiled JSON maps.

    Install

    npm i gl-tiled

    DownloadsWeekly Downloads

    3

    Version

    1.0.0

    License

    MIT

    Unpacked Size

    164 kB

    Total Files

    52

    Last publish

    Collaborators

    • avatar