gbtiles 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5be37ad53523b74a26c967713c55cfc23b362d5a
-  data.tar.gz: 59a53120142ede026df2e71dded36df0595b3343
+  metadata.gz: 5c47f1925b50e61d331766cb83c1bbc9c6212189
+  data.tar.gz: e4dbe6e1333ae545493ed3a307713cdb19c675fc
 SHA512:
-  metadata.gz: b56b85838a7d43b709b0a2544146246a022f2bd636906d3a8bc13f9e945e67d2e8d54c279445ebbe7bc70bc9fdb0b3fdc5909401becc40394522bbbf86967407
-  data.tar.gz: d203ff9cddd9eef3c29ead57f997bf6e73bb6bd8b6a9d8e0d37099592015476503b510075e548ee07d3a43a7a06f9c8d5bf65b0966597eba68f81d7ddb35808c
+  metadata.gz: ff753667dc247a29dd990fdf2914aecb6c40e23fe5ec7314b92f633fe17da31cc33d5944a27c880ec3b1530dfb0b1c7b28df346febb728776f64adf583f4de9e
+  data.tar.gz: fae1c944cd637d8278d5e49f484bc5554994bb742365bb4850ab0ba20794c5c787543e1aa4086770661a1e846d19c0b95390e9864c9664e820974fe876837b1b

data/README.md

@@ -1,5 +1,7 @@
 # GBTiles
 
+[![wercker status](https://app.wercker.com/status/c42dc696662599ce8eb787410c3b8780/s "wercker status")](https://app.wercker.com/project/bykey/c42dc696662599ce8eb787410c3b8780) [![Code Climate](https://codeclimate.com/github/bashaus/gbtiles/badges/gpa.svg)](https://codeclimate.com/github/bashaus/gbtiles) [![Test Coverage](https://codeclimate.com/github/bashaus/gbtiles/badges/coverage.svg)](https://codeclimate.com/github/bashaus/gbtiles/coverage)
+
 Converts `.GBR` files created with 
 [Harry Mulder's Tile Designer (GBTD)](http://www.devrs.com/gb/hmgd/gbtd.html)
 and `.GBM` files created with 
@@ -32,6 +34,9 @@ a C file `*.h` for convenience.
 
     gbr convert --output "sample.s" sample.gbr
 
+Omitting the input file `.gbm` file will default to `STDIN`. Omitting the
+output file `.s` will default to `STDOUT`.
+
 ### GBM (GBMB files)
 
 Converts a Map Builder file `*.gbm` to an ASM file `*.s` and generates 
@@ -39,6 +44,15 @@ a C file `*.h` for convenience.
 
     gbm convert --output "sample.s" sample.gbm
 
+You can also specify the target layer of a map specifying a layer flag. 
+Acceptable values: `bkg` for the background, `win` for the window overlay or 
+`sprite` for sprites. Default value: `bkg`.
+
+    gbm convert --output "sample.s" --layer=bkg sample.gbm
+
+Omitting the input file `.gbm` file will default to `STDIN`. Omitting the
+output file `.s` will default to `STDOUT`.
+
 ## Contributors
 
 * @bashaus -- [Bashkim Isai](http://www.bashkim.com.au/)

data/bin/gbm

@@ -1,11 +1,8 @@
 #!/usr/bin/env ruby
 require "gli"
-
 include GLI::App
 
 require "gbtiles/version"
-require "gbtiles/helpers/fixnum"
-
 require "gbtiles/gbm/cli/convert"
 
 program_desc "Converts .GBM files to different formats for the Game Boy"

data/bin/gbr

@@ -1,11 +1,8 @@
 #!/usr/bin/env ruby
 require "gli"
-
 include GLI::App
 
 require "gbtiles/version"
-require "gbtiles/helpers/fixnum"
-
 require "gbtiles/gbr/cli/convert"
 
 program_desc "Converts .GBR files to different formats for the Game Boy"

data/lib/gbtiles/gbm/cli/convert.rb

@@ -1,29 +1,19 @@
-require "gbtiles/data_type"
-
+require "gbtiles/helpers/data_type"
 require "gbtiles/gbm/import/gbm_file"
-
-require "gbtiles/gbm/map/map_set"
-
-require "gbtiles/gbm/map/object"
-require "gbtiles/gbm/map/object_type"
-
-require "gbtiles/gbm/map/objects/producer"
-require "gbtiles/gbm/map/objects/map"
-require "gbtiles/gbm/map/objects/map_tile_data"
-require "gbtiles/gbm/map/objects/map_tile_data_record"
-require "gbtiles/gbm/map/objects/map_settings"
-require "gbtiles/gbm/map/objects/map_export_settings"
-require "gbtiles/gbm/map/objects/unknown"
-
 require "gbtiles/gbm/export/asm/asm"
 
 desc "Convert a file from GBM format"
 arg_name "input"
 command :convert do |c|
 
-  c.desc "Output filename (*.s)"
+  c.desc "Output filename [*.s]"
   c.flag :output
 
+  c.desc "Layer type of the map [bkg, win, sprite]"
+  c.flag :layer,
+    :must_match => [:bkg, :win, :sprite],
+    :default_value => :bkg
+
   c.action do |global_options,options,args|
     # Prepare input file
     if !args[0].nil? then
@@ -50,6 +40,7 @@ command :convert do |c|
     # Do export
     export = GBTiles::GBM::Export::ASM::ASM.new
     export.map_set = import.map_set
+    export.layer = options[:layer]
     export.write(output_file)
     output_file.close
   end

data/lib/gbtiles/gbm/export/asm/asm.h.erb

@@ -4,11 +4,11 @@
  * GBTiles Ruby Gem (v<%= GBTiles::VERSION %>) - GBM
  *
  * .GBM created with
- * <%= map_set.producers.first.name %> (v<%= map_set.producers.first.version %>)
- * <%= map_set.producers.first.info %>
+ * <%= map_set.producer.first.name %> (v<%= map_set.producer.first.version %>)
+ * <%= map_set.producer.first.info %>
  */
 
-<% map_set.maps.each do |map| -%>
+<% map_set.map.each do |map| -%>
 // Helper: Map dimensions
 #define <%= map_export_settings.label_name %>Width <%= map.width %>
 #define <%= map_export_settings.label_name %>Height <%= map.height %>

data/lib/gbtiles/gbm/export/asm/asm.rb

@@ -1,3 +1,5 @@
+require "gbtiles/gbm/layer"
+
 require "erb"
 
 module GBTiles
@@ -8,7 +10,7 @@ module GBTiles
           include ERB::Util
 
           attr_accessor :map_set
-          @map_set
+          attr_accessor :layer
 
           def initialize
           end
@@ -17,6 +19,10 @@ module GBTiles
             if @map_set.nil? then
               raise "Missing required map"
             end
+
+            if @layer.nil? then
+              raise "Missing required layer (bkg, win, sprite)"
+            end
           end
 
           def render_s

data/lib/gbtiles/gbm/export/asm/asm.s.erb

@@ -3,12 +3,12 @@
 ; GBTiles Ruby Gem (v<%= GBTiles::VERSION %>) - GBM
 ;
 ; .GBM created with
-; <%= map_set.producers.first.name %> (v<%= map_set.producers.first.version %>)
-; <%= map_set.producers.first.info %>
+; <%= map_set.producer.first.name %> (v<%= map_set.producer.first.version %>)
+; <%= map_set.producer.first.info %>
 
 .area _CODE_<%= map_export_settings.bank -%>
 
-<% map_set.maps.each do |map| -%>
+<% map_set.map.each do |map| -%>
 <% map_tile_data = map_set.map_tile_data(map.master_id).first -%>
 
 ; Map <%= "(#{map.name})" unless map.name.nil? %>
@@ -21,7 +21,7 @@ _<%= map_export_settings.label_name %>:
 <% row_tile_data = map_tile_data.row(row, 16) -%>
 <% if !row_tile_data.nil? -%>
 .db <%= row_tile_data
-    .map {|x| sprintf("0x%02x", x.tile_number) }
+    .map {|x| sprintf("0x%02x", x.tile_number + GBTiles::GBM::LAYER[layer]) }
     .join(',')
 %>
 <% end -%>

data/lib/gbtiles/gbm/import/gbm_file.rb

@@ -1,3 +1,17 @@
+require "gbtiles/helpers/fixnum"
+
+require "gbtiles/gbm/map/map_set"
+require "gbtiles/gbm/map/object"
+require "gbtiles/gbm/map/object_type"
+
+require "gbtiles/gbm/map/objects/producer"
+require "gbtiles/gbm/map/objects/map"
+require "gbtiles/gbm/map/objects/map_tile_data"
+require "gbtiles/gbm/map/objects/map_tile_data_record"
+require "gbtiles/gbm/map/objects/map_settings"
+require "gbtiles/gbm/map/objects/map_export_settings"
+require "gbtiles/gbm/map/objects/unknown"
+
 module GBTiles
   module GBM
     module Import
@@ -6,28 +20,25 @@ module GBTiles
         OBJECT_MARKER = "HPJMTL"
 
         attr_accessor :version
-        @version
-
         attr_accessor :map_set
-        @map_set
 
-        def initialize()
+        def initialize
           @map_set = GBTiles::GBM::Map::MapSet.new
         end
 
-        def self.open(file)
+        def self.open file
           import = GBTiles::GBM::Import::GBMFile.new
 
           # Check to see if this is a valid file type
           if (file.read(3) != "GBO") then
-            raise "Invalid file, header does not start with GBO"
+            raise IOError, "Not a valid file (expected: GBO)"
           end
 
           # Version number
           import.version = file.read(1)
 
           if import.version != "1" then
-            raise "Invalid file, can only import version number 1"
+            raise IOError, "Cannot import version #{import.version}"
           end
 
           # For each object
@@ -46,20 +57,20 @@ module GBTiles
             object_len  = GBTiles::DataType.long(file.read(4))
             object_data = file.read(object_len)
 
-            case object_type
-            when GBTiles::GBM::Map::ObjectType::PRODUCER
+            case GBTiles::GBM::Map::OBJECT_TYPE.key(object_type)
+            when :producer
               object = GBTiles::GBM::Map::Objects::Producer.initFromBitString object_data
 
-            when GBTiles::GBM::Map::ObjectType::MAP
+            when :map
               object = GBTiles::GBM::Map::Objects::Map.initFromBitString object_data
 
-            when GBTiles::GBM::Map::ObjectType::MAP_TILE_DATA
+            when :map_tile_data
               object = GBTiles::GBM::Map::Objects::MapTileData.initFromBitString object_data
 
-            when GBTiles::GBM::Map::ObjectType::MAP_SETTINGS
+            when :map_settings
               object = GBTiles::GBM::Map::Objects::MapSettings.initFromBitString object_data
 
-            when GBTiles::GBM::Map::ObjectType::MAP_EXPORT_SETTINGS
+            when :map_export_settings
               object = GBTiles::GBM::Map::Objects::MapExportSettings.initFromBitString object_data
 
             else

data/lib/gbtiles/gbm/layer.rb

@@ -0,0 +1,9 @@
+module GBTiles
+  module GBM
+    LAYER = {
+      :bkg    => 0x00,
+      :win    => 0x80,
+      :sprite => 0x00
+    }
+  end
+end

data/lib/gbtiles/gbm/map/map_set.rb

@@ -4,51 +4,62 @@ module GBTiles
       class MapSet
 
         attr_accessor :objects
-        @objects
 
         def initialize
           @objects = []
         end
 
-        def maps master_id = nil
+        def producer master_id = nil
           @objects.select{ |a|
-            a.is_a? GBTiles::GBM::Map::Objects::Map
+            a.object_type == GBTiles::GBM::Map::OBJECT_TYPE[:producer]
           }.select{ |a|
             master_id.nil? || a.object_id = master_id
           }
         end
 
-        def map_export_settings master_id = nil
+        def map master_id = nil
           @objects.select{ |a|
-            a.is_a? GBTiles::GBM::Map::Objects::MapExportSettings
+            a.object_type == GBTiles::GBM::Map::OBJECT_TYPE[:map]
           }.select{ |a|
             master_id.nil? || a.object_id = master_id
           }
         end
 
-        def map_settings master_id = nil
+        def map_tile_data master_id = nil
           @objects.select{ |a|
-            a.is_a? GBTiles::GBM::Map::Objects::MapSettings
+            a.object_type == GBTiles::GBM::Map::OBJECT_TYPE[:map_tile_data]
           }.select{ |a|
             master_id.nil? || a.object_id = master_id
           }
         end
 
-        def map_tile_data master_id = nil
+        def map_settings master_id = nil
           @objects.select{ |a|
-            a.is_a? GBTiles::GBM::Map::Objects::MapTileData
+            a.object_type == GBTiles::GBM::Map::OBJECT_TYPE[:map_settings]
           }.select{ |a|
             master_id.nil? || a.object_id = master_id
           }
         end
 
-        def producers master_id = nil
+        def map_export_settings master_id = nil
           @objects.select{ |a|
-            a.is_a? GBTiles::GBM::Map::Objects::Producer
+            a.object_type == GBTiles::GBM::Map::OBJECT_TYPE[:map_export_settings]
           }.select{ |a|
             master_id.nil? || a.object_id = master_id
           }
         end
+
+        def deleted
+          @objects.select{ |a|
+            a.object_type == GBTiles::GBM::Map::OBJECT_TYPE[:deleted]
+          }
+        end
+
+        def unknown
+          @objects.select{ |a|
+            GBTiles::GBM::Map::OBJECT_TYPE.key(a.object_type).nil?
+          }
+        end
       end
     end
   end

data/lib/gbtiles/gbm/map/object.rb

@@ -4,13 +4,8 @@ module GBTiles
       class Object
 
         attr_accessor :object_type
-        @object_type
-
         attr_accessor :object_id
-        @object_id
-
         attr_accessor :master_id
-        @master_id
 
         def initialize object_type
           @object_type = object_type

data/lib/gbtiles/gbm/map/object_type.rb

@@ -1,14 +1,14 @@
 module GBTiles
   module GBM
     module Map
-      module ObjectType
-        PRODUCER            = 0x01
-        MAP                 = 0x02
-        MAP_TILE_DATA       = 0x03
-        MAP_SETTINGS        = 0x07
-        MAP_EXPORT_SETTINGS = 0x09
-        DELETED             = 0xFF
-      end
+      OBJECT_TYPE = {
+        :producer            => 0x01,
+        :map                 => 0x02,
+        :map_tile_data       => 0x03,
+        :map_settings        => 0x07,
+        :map_export_settings => 0x09,
+        :deleted             => 0xFF
+      }
     end
   end
 end

data/lib/gbtiles/gbm/map/objects/map.rb

@@ -5,28 +5,15 @@ module GBTiles
         class Map < GBTiles::GBM::Map::Object
 
           attr_accessor :name
-          @name
-
           attr_accessor :width
-          @width
-
           attr_accessor :height
-          @height
-
           attr_accessor :prop_count
-          @prop_count
-
           attr_accessor :tile_file
-          @tile_file
-
           attr_accessor :tile_count
-          @tile_count
-
           attr_accessor :prop_color_count
-          @prop_color_count
 
           def initialize
-            super GBTiles::GBM::Map::ObjectType::MAP
+            super GBTiles::GBM::Map::OBJECT_TYPE[:map]
           end
 
           def self.initFromBitString src

data/lib/gbtiles/gbm/map/objects/map_export_settings.rb

@@ -5,49 +5,22 @@ module GBTiles
         class MapExportSettings < GBTiles::GBM::Map::Object
 
           attr_accessor :file_name
-          @file_name
-
           attr_accessor :file_type
-          @file_type
-
           attr_accessor :section_name
-          @section_name
-
           attr_accessor :label_name
-          @label_name
-
           attr_accessor :bank
-          @bank
-
           attr_accessor :plane_count
-          @plane_count
-
           attr_accessor :plane_order
-          @plane_order
-
           attr_accessor :map_layout
-          @map_layout
-
           attr_accessor :split
-          @split
-
           attr_accessor :split_size
-          @split_size
-
           attr_accessor :split_bank
-          @split_bank
-
           attr_accessor :sel_tab
-          @sel_tab
-
           attr_accessor :prop_count
-          @prop_count
-
           attr_accessor :tile_offset
-          @tile_offset
 
           def initialize
-            super GBTiles::GBM::Map::ObjectType::MAP_EXPORT_SETTINGS
+            super GBTiles::GBM::Map::OBJECT_TYPE[:map_export_settings]
           end
 
           def self.initFromBitString src