gbtiles 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ead8106729b3a84988e0fec3f04c932a1aa870df
+  data.tar.gz: a0e02dfa4cca73ae5253ede1e000ab12311efcd8
+SHA512:
+  metadata.gz: fb813f183e1c213ff6b82991c49dd999c4179a5134a4a1e333f4e701a9bfc032decd53ea5fded7b17d023e027aa3693a76057b3575186fd78faaeda408fab8c9
+  data.tar.gz: 10b070b7f0ce28e32d00255517a1d1c1ac5e69385a2637930eefedf8382cfa127e919247dae4c04dde605743680c263eb76212b85633c7c0490cb8eb73d354a7

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2014 Bashkim Isai
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,48 @@
+# GBTiles
+
+Version 0.0.1
+
+Converts `.GBR` files created with 
+[Harry Mulder's Tile Designer (GBTD)](http://www.devrs.com/gb/hmgd/gbtd.html)
+and `.GBM` files created with 
+[Harry Mulder's Map Builder (GBMB)](http://www.devrs.com/gb/hmgd/gbmb.html)
+to different formats for use with the Game Boy and 
+[GBDK](http://gbdk.sourceforge.net/).
+
+**N.B.: Not all of the functionality provided by Harry Mulder's GBR and GBM 
+file format specification have been implemented; however there is enough to 
+generate the basics for tiles and maps.**
+
+## Installation
+
+    gem install gbtiles
+
+## Usage
+
+### Help
+
+To view help information for the GBR or GBM commands, simply type one of the 
+following:
+
+    gbr --help
+    gbm --help
+
+### GBR (GBTD files)
+
+Converts a Tile Designer file `*.gbr` to an ASM file `*.s` and generates 
+a C file `*.h` for convenience.
+
+    gbr convert --output "sample.s" sample.gbr
+
+### GBM (GBMB files)
+
+Converts a Map Builder file `*.gbm` to an ASM file `*.s` and generates 
+a C file `*.h` for convenience.
+
+    gbm convert --output "sample.s" sample.gbm
+
+## Contributors
+
+* @bashaus -- [Bashkim Isai](http://www.bashkim.com.au/)
+
+If you fork this project and create a pull request add your GitHub username, your full name and website to the end of list above.

data/bin/gbm

@@ -0,0 +1,27 @@
+#!/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"
+
+version GBTiles::VERSION
+
+pre do |global,command,options,args|
+  true
+end
+
+post do |global,command,options,args|
+  true
+end
+
+on_error do |exception|
+  true
+end
+
+exit run(ARGV)

data/bin/gbr

@@ -0,0 +1,27 @@
+#!/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"
+
+version GBTiles::VERSION
+
+pre do |global,command,options,args|
+  true
+end
+
+post do |global,command,options,args|
+  true
+end
+
+on_error do |exception|
+  true
+end
+
+exit run(ARGV)

data/lib/gbtiles/data_type.rb

@@ -0,0 +1,73 @@
+module GBTiles
+  module DataType
+    def self.string(src, length = nil)
+      if !length.nil? then
+        string = src.slice(0, length)
+      else
+        string = src
+      end
+
+      if !string.nil? then
+        string = string.split(/\0/).first
+      end
+
+      if !string.nil?
+        string = string.unpack("A*")[0]
+      end
+
+      string
+    end
+
+    def self.string!(src, length = nil)
+      if !length.nil? then
+        string = src.slice!(0, length)
+      else 
+        string = src
+      end
+
+      self.string(string, length)
+    end
+
+    # WORD
+    # LITTLE ENDIAN
+    # 2 BYTES
+    def self.word(src)
+      src.slice(0, 2).unpack("v*")[0]
+    end
+
+    def self.word!(src)
+      self.word(src.slice!(0, 2))
+    end
+
+    # BYTE
+    # 1 BYTE
+    def self.byte(src)
+      src.slice(0, 1).unpack("C*")[0]
+    end
+
+    def self.byte!(src)
+      self.byte(src.slice!(0, 1))
+    end
+
+    # BOOLEAN
+    # 1 BYTE
+    def self.boolean(src)
+      src.slice!(0, 1).unpack("C")[0].eql? 1
+    end
+
+    def self.boolean!(src)
+      self.boolean(src.slice!(0, 1))
+    end
+
+    # LITTLE ENDIAN
+    # 32 BIT INTEGER
+    # 4 BYTES
+    def self.long(src)
+      src.slice(0, 4).unpack("V*")[0]
+    end
+
+    def self.long!(src)
+      self.long(src.slice!(0, 4))
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+require "gbtiles/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.flag :output
+
+  c.action do |global_options,options,args|
+    # Prepare input file
+    if !args[0].nil? then
+      # Use file
+      input_file = File.open(args[0], "rb")
+    else
+      # Use STDIN
+      input_file = $stdin
+    end
+
+    # Prepare output file
+    if !options[:output].nil? then
+      # Use file
+      output_file = File.open(options[:output], "w")
+    else
+      # Use STDOUT
+      output_file = $stdout
+    end
+
+    # Do import
+    import = GBTiles::GBM::Import::GBMFile.open(input_file)
+    input_file.close
+
+    # Do export
+    export = GBTiles::GBM::Export::ASM::ASM.new
+    export.map_set = import.map_set
+    export.write(output_file)
+    output_file.close
+  end
+end

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

@@ -0,0 +1,19 @@
+<% map_export_settings = map_set.map_export_settings.first -%>
+/**
+ * .H created with
+ * 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.maps.each do |map| -%>
+// Helper: Map dimensions
+#define <%= map_export_settings.label_name %>Width <%= map.width %>
+#define <%= map_export_settings.label_name %>Height <%= map.height %>
+#define <%= map_export_settings.label_name %>Bank <%= map_export_settings.bank %>
+
+// Extern: <%= map_export_settings.label_name %>
+extern unsigned char <%= map_export_settings.label_name %>[];
+<% end %>

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

@@ -0,0 +1,52 @@
+require "erb"
+
+module GBTiles
+  module GBM
+    module Export
+      module ASM
+        class ASM
+          include ERB::Util
+
+          attr_accessor :map_set
+          @map_set
+
+          def initialize
+          end
+
+          def prerender
+            if @map_set.nil? then
+              raise "Missing required map"
+            end
+          end
+
+          def render_s
+            prerender
+
+            template = File.open(File.join(__dir__, "asm.s.erb"), "r").read
+
+            ERB.new(template, nil, "-").result(binding)
+          end
+
+          def render_h
+            prerender
+
+            template = File.open(File.join(__dir__, "asm.h.erb"), "r").read
+
+            ERB.new(template, nil, "-").result(binding)
+          end
+
+          def write output_stream
+            output_stream.write(render_s)
+
+            if output_stream.is_a? File then
+              header_path = "#{File.basename(output_stream.path, ".s")}.h"
+              header_stream = File.open(header_path, "w")
+              header_stream.write(render_h)
+              header_stream.close
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+<% map_export_settings = map_set.map_export_settings.first -%>
+; .S created with
+; 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 %>
+
+.area _CODE_<%= map_export_settings.bank -%>
+
+<% map_set.maps.each do |map| -%>
+<% map_tile_data = map_set.map_tile_data(map.master_id).first -%>
+
+; Map <%= "(#{map.name})" unless map.name.nil? %>
+
+.globl _<%= map_export_settings.label_name %>
+.dw _<%= map_export_settings.label_name %>
+
+_<%= map_export_settings.label_name %>:
+<% (1..map.height).each do |row| -%>
+<% row_tile_data = map_tile_data.row(map.width, row) -%>
+<% if !row_tile_data.nil? -%>
+.db <%= map_tile_data
+    .row(map.width, row)
+    .map {|x| sprintf("0x%02x", x.tile_number) }
+    .join(',')
+%>
+<% end -%>
+<% end -%>
+<% end %>

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

@@ -0,0 +1,82 @@
+module GBTiles
+  module GBM
+    module Import
+      class GBMFile
+
+        OBJECT_MARKER = "HPJMTL"
+
+        attr_accessor :version
+        @version
+
+        attr_accessor :map_set
+        @map_set
+
+        def initialize()
+          @map_set = GBTiles::GBM::Map::MapSet.new
+        end
+
+        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"
+          end
+
+          # Version number
+          import.version = file.read(1)
+
+          if import.version != "1" then
+            raise "Invalid file, can only import version number 1"
+          end
+
+          # For each object
+          while !file.eof?
+            # Check the marker
+            marker = GBTiles::DataType.string(file.read(6))
+
+            if !OBJECT_MARKER.eql? marker then
+              raise "Malformed file, expected marker #{OBJECT_MARKER}, got #{marker}"
+            end
+
+            object_type = GBTiles::DataType.word(file.read(2))
+            object_id   = GBTiles::DataType.word(file.read(2))
+            master_id   = GBTiles::DataType.word(file.read(2))
+            object_crc  = GBTiles::DataType.long(file.read(4))
+            object_len  = GBTiles::DataType.long(file.read(4))
+            object_data = file.read(object_len)
+
+            case object_type
+            when GBTiles::GBM::Map::ObjectType::PRODUCER
+              object = GBTiles::GBM::Map::Objects::Producer.initFromBitString object_data
+
+            when GBTiles::GBM::Map::ObjectType::MAP
+              object = GBTiles::GBM::Map::Objects::Map.initFromBitString object_data
+
+            when GBTiles::GBM::Map::ObjectType::MAP_TILE_DATA
+              object = GBTiles::GBM::Map::Objects::MapTileData.initFromBitString object_data
+
+            when GBTiles::GBM::Map::ObjectType::MAP_SETTINGS
+              object = GBTiles::GBM::Map::Objects::MapSettings.initFromBitString object_data
+
+            when GBTiles::GBM::Map::ObjectType::MAP_EXPORT_SETTINGS
+              object = GBTiles::GBM::Map::Objects::MapExportSettings.initFromBitString object_data
+
+            else
+              object = GBTiles::GBM::Map::Objects::Unknown.new object_type
+              object.object_data = object_data
+
+            end
+
+            object.object_id = object_id
+            object.master_id = master_id
+
+            import.map_set.objects.push object
+          end
+
+          import
+        end
+      end
+    end
+  end
+end