Free texture packer plugin for grunt
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
tasks
test
.gitignore
.jshintrc
Gruntfile.js
LICENSE.md
README.md
package.json

README.md

grunt-free-tex-packer

Stats
Free texture packer plugin for grunt
Based on https://github.com/odrick/free-tex-packer

Install

$ npm install grunt-free-tex-packer

Basic usage

module.exports = function(grunt) {
    grunt.initConfig({
        free_tex_packer: {
            demo: {
                files: [
                    {expand: true, src: 'src/**/*', basePath: 'src/', filter: 'isFile'}
                ],
                options: {
                    dest: 'dest'
                }
            }
        }
    });
    
    grunt.loadNpmTasks('grunt-free-tex-packer');
    grunt.registerTask('default', ['free_tex_packer']);
};

Advanced usage

Use packer options object

module.exports = function(grunt) {
    grunt.initConfig({
        free_tex_packer: {
            demo: {
                files: [
                    {expand: true, src: 'src/**/*', basePath: 'src/', filter: 'isFile'}
                ],
                options: {
                    dest: 'dest',
                    textureName: "my-texture",
                    width: 1024,
                    height: 1024,
                    fixedSize: false,
                    padding: 2,
                    allowRotation: true,
                    detectIdentical: true,
                    allowTrim: true,
                    exporter: "Pixi",
                    removeFileExtension: true,
                    prependFolderName: true
                }
            }
        }
    });
    
    grunt.loadNpmTasks('grunt-free-tex-packer');
    grunt.registerTask('default', ['free_tex_packer']);
};

Additional parameters:

basePath in files - path to be removed from sprite name in texture dest in options - destination folder path

Pack options description: https://github.com/odrick/free-tex-packer-core#available-options

Custom exporters description: https://github.com/odrick/free-tex-packer-core#custom-exporter

Used libs


License: MIT