JSPM

LightCinematic

1.0.1
    • ESM via JSPM
    • ES Module Entrypoint
    • Export Map
    • Keywords
    • License
    • Repository URL
    • TypeScript Types
    • README
    • Created
    • Published
    • Downloads 2
    • Score
      100M100P100Q31087F

    Small library for spritesheet canvas animations

    Package Exports

    • LightCinematic

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (LightCinematic) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    Build Status Coverage Status Code Climate npm version

    LightCinematicTS

    Light helper for animations based on spritesheets/image sequence written in Typescript.

    How to use

    You have mainly two objects in this small lib: - LightManager - LightCinematic

    You can create a scene instantiating LightManager like:

    var manager = LightManager.create({fps:25, stage: {width: 200, height:200, canvas:document.getElementById('myCanvas')}});

    Create a spritesheet:

    var img = new Image();
    img.src = "dude_animation_sheet.png";
    
    var sprites = LightSpritesheet.create({
                cols: 9,
                frames: {count: 9, width: 50, height: 72, src: [img]},
                loop:true,
                x: 0,
                y: 0
            });

    Add add it to the manager

    manager.add(sprites);

    Whenever you feel ready, start the manager:

    manager.start();

    Light Manager Config

    These are the properties you can pass to the manager:

    • fps : Frames per second which the animation will be drawn. - Default: 25
    • stage : Contains the information about your canvas dom element`
      • width : your canvas total width - Default: 300
      • height : your canvas total height - Default: 300
      • canvas : HTML Canvas element

    Light Spritesheet Config

    These are the properties you can pass to the spritesheet:

    • cols : Amount of columns in the spritesheet
    • frames : Contains the information about frames in the spritesheet`
      • count : total amount of frames
      • width : width of each frame
      • height : height of each frame
      • src : Array of images (if it's just one image, it will be taken as spritesheet)
    • loop : Indicates if the spritesheet must loop
    • x : x position within your canvas (Relative to 0,0)
    • y : y position within your canvas (Relative to 0,0)
    • scale : scale factor range 0 to 1

    Contributing

    • You need to have Typescript transpiler installed: http://www.typescriptlang.org/
    • Set the following arguments to the compiler: --target ES5 --declaration