Version 0.0.3

Author: gpedro

.gitignore

@@ -1,8 +1,8 @@
-node_modules
+node_modules/
 *.log
 log
 *~
 .DS_Store
 out/
 *.dat
-*.spr
+*.spr

.jshintrc

@@ -0,0 +1,14 @@
+{
+  "curly": true,
+  "eqeqeq": true,
+  "immed": true,
+  "latedef": true,
+  "newcap": true,
+  "noarg": true,
+  "sub": true,
+  "undef": true,
+  "unused": true,
+  "boss": true,
+  "eqnull": true,
+  "node": true
+}

.travis.yml

@@ -0,0 +1,3 @@
+language: node_js
+node_js:
+  - '0.10'

Gruntfile.js

@@ -0,0 +1,48 @@
+'use strict';
+module.exports = function (grunt) {
+  // Show elapsed time at the end
+  require('time-grunt')(grunt);
+  // Load all grunt tasks
+  require('load-grunt-tasks')(grunt);
+
+  grunt.initConfig({
+    jshint: {
+      options: {
+        jshintrc: '.jshintrc',
+        reporter: require('jshint-stylish')
+      },
+      gruntfile: {
+        src: ['Gruntfile.js']
+      },
+      js: {
+        src: ['src/**/*.js']
+      },
+      test: {
+        src: ['test/**/*.js']
+      }
+    },
+    mochacli: {
+      options: {
+        reporter: 'nyan',
+        bail: true
+      },
+      all: ['test/*.js']
+    },
+    watch: {
+      gruntfile: {
+        files: '<%= jshint.gruntfile.src %>',
+        tasks: ['jshint:gruntfile']
+      },
+      js: {
+        files: '<%= jshint.js.src %>',
+        tasks: ['jshint:js', 'mochacli']
+      },
+      test: {
+        files: '<%= jshint.test.src %>',
+        tasks: ['jshint:test', 'mochacli']
+      }
+    }
+  });
+
+  grunt.registerTask('default', ['jshint', 'mochacli']);
+};

README.md

@@ -1,6 +1,7 @@
 # Sprite Sheet Extractor
+# [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-url]][daviddm-image] [![Code Climate][coverge-image]][coverge-url] [![Test Coverge][test-image]][coverge-url]
 
-Sprite Sheet Extractor for Open Tibia written in JavaScript and powered by Node.js.
+> CLI Tool to extract SpriteSheet from Tibia Spr & Dat files
 
 ## Getting Started
 
@@ -19,6 +20,7 @@ Please submit all issues and pull requests to the [TibiaJS/spritesheet-extractor
 If you have any problem or suggestion please open an issue [here](https://github.com/TibiaJS/spritesheet-extractor/issues).
 
 ## License
+
 The BSD License
 
 Copyright (c) 2015, TibiaJS Community
@@ -32,3 +34,14 @@ Redistribution and use in source and binary forms, with or without modification,
 *Neither the name of the TibiaJS Community nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+
+[npm-url]: https://npmjs.org/package/tibia-spritesheet-extractor
+[npm-image]: https://badge.fury.io/js/tibia-spritesheet-extractor.svg
+[travis-url]: https://travis-ci.org/TibiaJS/spritesheet-extractor
+[travis-image]: https://travis-ci.org/TibiaJS/spritesheet-extractor.svg?branch=master
+[daviddm-url]: https://david-dm.org/TibiaJS/spritesheet-extractor.svg?theme=shields.io
+[daviddm-image]: https://david-dm.org/TibiaJS/spritesheet-extractor
+[test-image]: https://codeclimate.com/github/TibiaJS/spritesheet-extractor/badges/coverage.svg
+[coverge-image]: https://codeclimate.com/github/TibiaJS/spritesheet-extractor/badges/gpa.svg
+[coverge-url]: https://codeclimate.com/github/TibiaJS/spritesheet-extractor

index.js

@@ -1,4 +1,5 @@
-"use strict";
+#!/usr/bin/env node
+'use strict';
 
 // Process
 var datFile  = process.argv[2],
@@ -10,8 +11,8 @@ var datFile  = process.argv[2],
 // Require
 var fs       = require('fs'),
     PNGImage = require('pngjs-image'),
-    Metadata = require('./lib/Metadata.js'),
-    Sprites  = require('./lib/Sprites.js');
+    Metadata = require('./src/Metadata'),
+    Sprites  = require('./src/Sprites');
 
 // Checking extension of datFile.
 if(datFile.substring((datFile.length - 4), datFile.length) != '.dat') {

package.json

@@ -1,31 +1,41 @@
 {
-  "name": "spritesheet-extrator",
-  "version": "0.0.2",
-  "description": "Exports a client graphic as sprite sheet.",
-  "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/TibiaJS/spritesheet-extractor"
-  },
-  "keywords": [
-    "open tibia",
-    "sprite sheet"
-  ],
+  "name": "tibia-spritesheet-extractor",
+  "version": "0.0.3",
+  "description": "CLI Tool to extract SpriteSheet from Tibia Spr & Dat files",
+  "homepage": "https://github.com/TibiaJS/spritesheet-extractor",
   "author": {
     "name": "Nailson Santos",
-    "email" : "[email protected]",
-    "url" : "https://github.com/Mignari"
-    },
-  "license": "BSD",
-  "bugs": {
-    "url": "https://github.com/TibiaJS/spritesheet-extractor/issues"
+    "email": "[email protected]",
+    "url": "https://github.com/Mignari"
   },
-  "homepage": "https://github.com/TibiaJS/spritesheet-extractor",
+  "repository": "TibiaJS/tibia-spritesheet-extractor",
+  "license": "BSD",
+  "keywords": [
+    "tibia-spritesheet-extractor",
+    "tibia",
+    "spritesheet",
+    "extractor",
+    "cipsoft",
+    "tibiajs"
+  ],
   "dependencies": {
     "buffer-reader": "0.0.2",
     "pngjs-image": "^0.9.3"
+  },
+  "devDependencies": {
+    "grunt-cli": "^0.1.13",
+    "grunt-contrib-jshint": "^0.10.0",
+    "grunt-contrib-nodeunit": "^0.4.1",
+    "grunt-contrib-watch": "^0.6.1",
+    "load-grunt-tasks": "^1.0.0",
+    "time-grunt": "^1.0.0",
+    "grunt-mocha-cli": "^1.11.0",
+    "jshint-stylish": "^1.0.0"
+  },
+  "scripts": {
+    "test": "grunt"
+  },
+  "bin": {
+    "tibia-spritesheet-extractor": "index.js"
   }
 }

lib/Metadata.js renamed to src/Metadata.js

@@ -1,4 +1,4 @@
-"use strict";
+'use strict';
 
 var fs = require('fs');
 var BufferReader = require('buffer-reader');
@@ -13,19 +13,19 @@ function Metadata(file, cb) {
   }
 
   // Setupping variables
-  this.signature    = 0,
-  this.items        = [],
-  this.outfits      = [],
-  this.effects      = [],
-  this.missiles     = [],
-  this.itemCount    = 0,
-  this.outfitCount  = 0,
-  this.effectCount  = 0,
+  this.signature    = 0;
+  this.items        = [];
+  this.outfits      = [];
+  this.effects      = [];
+  this.missiles     = [];
+  this.itemCount    = 0;
+  this.outfitCount  = 0;
+  this.effectCount  = 0;
   this.missileCount = 0;
 
   var self = this;
   fs.readFile(file, function(err, buffer) {
-    if (err) throw err;
+    if (err) { throw err; }
 
     self._readLists(buffer);
 
@@ -54,46 +54,46 @@ Metadata.prototype.getMissileCount = function() {
 };
 
 Metadata.prototype.hasThingType = function(category, id) {
-  if (category == 'item') {
+  if (category === 'item') {
     return (id >= 100 && id <= this.itemCount);
-  } else if (category == 'outfit') {
+  } else if (category === 'outfit') {
     return (id >= 1 && id <= this.outfitCount);
-  } else if (category == 'effect') {
+  } else if (category === 'effect') {
     return (id >= 1 && id <= this.effectCount);
-  } else if (category == 'missile') {
+  } else if (category === 'missile') {
     return (id >= 1 && id <= this.missileCount);
   }
   return false;
 };
 
 Metadata.prototype.getThingType = function(category, id) {
-  if (category == 'item') {
+  if (category === 'item') {
     return this.getItem(id);
-  } else if (category == 'outfit') {
+  } else if (category === 'outfit') {
     return this.getOutfit(id);
-  } else if (category == 'effect') {
+  } else if (category === 'effect') {
     return this.getEffect(id);
-  } else if (category == 'missile') {
+  } else if (category === 'missile') {
     return this.getMissile(id);
   }
   return null;
 };
 
 Metadata.prototype.getMinId = function(category) {
-  if (category == 'item') {
+  if (category === 'item') {
     return 100;
   }
   return 1;
 };
 
 Metadata.prototype.getMaxId = function(category) {
-  if (category == 'item') {
+  if (category === 'item') {
     return this.itemCount;
-  } else if (category == 'outfit') {
+  } else if (category === 'outfit') {
     return this.outfitCount;
-  } else if (category == 'effect') {
+  } else if (category === 'effect') {
     return this.effectCount;
-  } else if (category == 'missile') {
+  } else if (category === 'missile') {
     return this.missileCount;
   }
   return 0;
@@ -151,7 +151,7 @@ Metadata.prototype._readLists = function(buffer) {
     for (id = 1; id <= this.missileCount; id++) {
       this.missiles[id] = this._readThing(id, 'missile');
     }
-}
+};
 
 Metadata.prototype._readThing = function(id, category) {
 
@@ -256,6 +256,6 @@ Metadata.prototype._readThing = function(id, category) {
     thing.groups[groupType] = group;
   }
   return thing;
-}
+};
 
 module.exports = Metadata;

lib/Sprites.js renamed to src/Sprites.js

@@ -1,4 +1,4 @@
-"use strict";
+'use strict';
 
 var fs = require('fs');
 var BufferReader = require('buffer-reader');
@@ -12,12 +12,12 @@ function Sprites(file, cb) {
   }
 
   // Setupping variables
-  this.signature   = 0,
+  this.signature   = 0;
   this.spriteCount = 0;
 
   var self = this;
   fs.readFile(file, function(err, buffer) {
-    if (err) throw err;
+    if (err) { throw err; }
 
     reader           = new BufferReader(buffer);
     self.signature   = reader.nextUInt32LE();
@@ -29,18 +29,18 @@ function Sprites(file, cb) {
 
 Sprites.prototype.getSignature = function() {
   return this.signature;
-}
+};
 
 Sprites.prototype.getSpriteCount = function() {
   return this.spriteCount;
-}
+};
 
 Sprites.prototype.copyPixels = function(spriteId, image, x, y) {
   var formula = 8 + (spriteId - 1) * 4;
   reader.seek(formula);
 
   var address = reader.nextUInt32LE();
-  if (address == 0) { // Address 0 always is an empty sprite.
+  if (address === 0) { // Address 0 always is an empty sprite.
     return;
   }
   reader.seek(address);
@@ -65,6 +65,6 @@ Sprites.prototype.copyPixels = function(spriteId, image, x, y) {
       currentPixel++;
     }
   }
-}
+};
 
 module.exports = Sprites;

lib/ThingType.js renamed to src/ThingType.js

@@ -2,7 +2,7 @@ function ThingType(id, category) {
     this.id       = id;
     this.category = category;
     this.groups   = [];
-};
+}
 
 ThingType.prototype.getFrameGroup = function(type) {
     if (type < this.groups.length) {

test/test.js

@@ -0,0 +1 @@
+// TODO!