gbtiles 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 97a49bd0073aef2d833face9db66ac7c62df636a
-  data.tar.gz: c638da12fe1905251672f1c62e0c9d9cd2914a6e
+  metadata.gz: 4444836258ce775a299eda72809988b34fb9a204
+  data.tar.gz: e351147feef1937f31ec4594b24530404782d54e
 SHA512:
-  metadata.gz: 5ab4781f3315bebb776744732f7a871bfb3d8e26306d7c4cff0210f035ae45cd76318ad098fd00a102a2b4dd50353aba8df613f613699617d858bbf29a079ec7
-  data.tar.gz: f4be161743f2bca7758fa9dc66144164b72e9a38ff84c810062f2d7345276b88c0b2210297603400c2cf39202f3c1ee56105c37aa9222d1b277f4b22e67c1c93
+  metadata.gz: f0e0e924baf471a0e6f6686488c2754c742b65a184c9ea48d877b970c6f7d94599d4f51d28eebf78f757d8c4af23ed6108c87ddb89a82100119bcb33c7431639
+  data.tar.gz: 1cc5072725025d7e8cd399d6b9db66f4f02b26a6f185c550115e182704c7374545213f6c0dfc0c0d0d6f44c690680034ad7a3b6d6c3df49a374f4dcdfaa83b51

data/README.md

@@ -1,6 +1,8 @@
 # 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)
+[![Build Status](https://travis-ci.org/bashaus/gbtiles.svg?branch=master)](https://travis-ci.org/bashaus/gbtiles)
+[![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)
@@ -9,52 +11,37 @@ and `.GBM` files created with
 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 
+<small>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.**
+generate the basics for tiles and maps.</small>
 
-## Installation
-
-    gem install gbtiles
+Also converts `.MOD` tracker files setup for the Game Boy for use with 
+[AntonioND's GBT Player](https://github.com/AntonioND/gbt-player).
 
-## 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
+## Installation
 
-Omitting the input file `.gbm` file will default to `STDIN`. Omitting the
-output file `.s` will default to `STDOUT`.
+Install globally:
 
-### GBM (GBMB files)
+    gem install gbtiles
 
-Converts a Map Builder file `*.gbm` to an ASM file `*.s` and generates 
-a C file `*.h` for convenience.
+Include in your `Gemfile`:
 
-    gbm convert --output "sample.s" sample.gbm
+    gem "gbtiles", "~> 0.2.0"
 
-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`.
+## Usage
 
-## Contributors
+To view help information for each of the commands, simply type one of the 
+following:
 
-* @bashaus -- [Bashkim Isai](http://www.bashkim.com.au/)
+    # Converts .GBM files to different formats for the Game Boy
+    gbm convert --help
+    
+    # Converts .GBR files to different formats for the Game Boy
+    gbr convert --help
 
-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.
+    # Converts .MOD files to different formats for the Game Boy
+    gbt convert --help

data/bin/gbt

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+require "gli"
+include GLI::App
+
+require "gbtiles/version"
+require "gbtiles/gbt/cli/convert"
+
+program_desc "Converts .MOD 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/gbm/cli/convert.rb

@@ -2,13 +2,16 @@ require "gbtiles/helpers/data_type"
 require "gbtiles/gbm/import/gbm_file"
 require "gbtiles/gbm/export/asm/asm"
 
-desc "Convert a file from GBM format"
+desc "Converts .GBM files to different formats for the Game Boy"
 arg_name "input"
 command :convert do |c|
 
   c.desc "Output filename [*.s]"
   c.flag :output
 
+  c.desc "ROM Bank"
+  c.flag :bank
+
   c.desc "Layer type of the map [bkg, win, sprite]"
   c.flag :layer,
     :must_match => [:bkg, :win, :sprite],
@@ -39,6 +42,11 @@ command :convert do |c|
 
     # Do export
     export = GBTiles::GBM::Export::ASM::ASM.new
+
+    if !options[:bank].nil? then
+      export.bank = options[:bank].to_i
+    end
+
     export.map_set = import.map_set
     export.layer = options[:layer]
     export.write(output_file)

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

@@ -12,7 +12,7 @@
 // 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 %>
+#define <%= map_export_settings.label_name %>Bank <%= bank %>
 
 // Extern: <%= map_export_settings.label_name %>
 extern unsigned char <%= map_export_settings.label_name %>[];

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

@@ -9,6 +9,7 @@ module GBTiles
         class ASM
           include ERB::Util
 
+          attr_accessor :bank
           attr_accessor :map_set
           attr_accessor :layer
 
@@ -23,6 +24,8 @@ module GBTiles
             if @layer.nil? then
               raise "Missing required layer (bkg, win, sprite)"
             end
+
+            @bank ||= @map_set.map_export_settings.first.bank
           end
 
           def render_s

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

@@ -6,7 +6,7 @@
 ; <%= map_set.producer.first.name %> (v<%= map_set.producer.first.version %>)
 ; <%= map_set.producer.first.info %>
 
-.area _CODE_<%= map_export_settings.bank -%>
+.area _CODE_<%= bank -%>
 
 <% map_set.map.each do |map| -%>
 <% map_tile_data = map_set.map_tile_data(map.master_id).first -%>

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

@@ -82,7 +82,7 @@ module GBTiles
             object.object_id = object_id
             object.master_id = master_id
 
-            import.map_set.objects.push object
+            import.map_set.objects << object
           end
 
           import

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

@@ -21,9 +21,7 @@ module GBTiles
               number = 0.chr + number # Convert from 24-bit to 32-bit
               number = number.unpack("N").first # Unpack integer
 
-              object.records.push(
-                GBTiles::GBM::Map::Objects::MapTileDataRecord.initFromBitString(number)
-              )
+              object.records << GBTiles::GBM::Map::Objects::MapTileDataRecord.initFromBitString(number)
             end
 
             object

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

@@ -2,13 +2,16 @@ require "gbtiles/helpers/data_type"
 require "gbtiles/gbr/import/gbr_file"
 require "gbtiles/gbr/export/asm/asm"
 
-desc "Convert a file from GBR format"
+desc "Converts .GBR files to different formats for the Game Boy"
 arg_name "input"
 command :convert do |c|
 
   c.desc "Output filename [*.s]"
   c.flag :output
 
+  c.desc "ROM Bank"
+  c.flag :bank
+
   c.action do |global_options,options,args|
     # Prepare input file
     if !args[0].nil? then
@@ -34,6 +37,11 @@ command :convert do |c|
 
     # Do export
     export = GBTiles::GBR::Export::ASM::ASM.new
+
+    if !options[:bank].nil? then
+      export.bank = options[:bank].to_i
+    end
+
     export.tile_set = import.tile_set
     export.write(output_file)
     output_file.close

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

@@ -9,7 +9,7 @@
  */
 
 // Helpers
-#define <%= tile_export.label_name %>Bank <%= tile_export.bank %>
+#define <%= tile_export.label_name %>Bank <%= bank %>
 #define <%= tile_export.label_name %>Count <%= tile_export.upto - tile_export.from + 1 %>
 
 // Extern

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

@@ -7,6 +7,7 @@ module GBTiles
         class ASM
           include ERB::Util
 
+          attr_accessor :bank
           attr_accessor :tile_set
 
           def initialize
@@ -16,6 +17,8 @@ module GBTiles
             if @tile_set.nil? then
               raise "Missing required tile set"
             end
+
+            @bank ||= @tile_set.tile_export.first.bank
           end
 
           def render_s

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

@@ -6,7 +6,7 @@
 ; <%= tile_set.producer.first.name %> (v<%= tile_set.producer.first.version %>)
 ; <%= tile_set.producer.first.info %>
 
-.area _CODE_<%= tile_export.bank %>
+.area _CODE_<%= bank %>
 
 .globl _<%= tile_export.label_name %>
 .dw _<%= tile_export.label_name %>

data/lib/gbtiles/gbr/import/gbr_file.rb

@@ -75,7 +75,7 @@ module GBTiles
 
             object.object_id = object_id
 
-            import.tile_set.objects.push object
+            import.tile_set.objects << object
           end
 
           import

data/lib/gbtiles/gbr/tile_set/objects/tile_data.rb

@@ -59,7 +59,7 @@ module GBTiles
                 bitmask >>= 1
               end
 
-              tile.push(sprintf("0x%02x,0x%02x", byte_0, byte_1))
+              tile << sprintf("0x%02x,0x%02x", byte_0, byte_1)
             end
 
             tile.join(",")

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

@@ -0,0 +1,58 @@
+require "gbtiles/helpers/data_type"
+require "gbtiles/gbt/import/mod_file"
+require "gbtiles/gbt/export/asm/asm"
+
+desc "Converts .MOD files to different formats for the Game Boy"
+arg_name "input"
+command :convert do |c|
+
+  c.desc "Output filename [*.s]"
+  c.flag :output
+
+  c.desc "ROM Bank"
+  c.default_value 2
+  c.flag :bank
+
+  c.desc "Label"
+  c.flag :label
+
+  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::GBT::Import::MODFile.open(input_file)
+    input_file.close
+
+    # Do export
+    export = GBTiles::GBT::Export::ASM::ASM.new
+    export.bank = options[:bank].to_i
+    export.mod_data = import.mod_data
+
+    if !options[:label].nil? then
+      # Use label from CLI
+      export.label = options[:label]
+    elsif !options[:output].nil? then
+      # Use filename
+      export.label = File.basename(options[:output], ".*")
+    end
+
+    export.write(output_file)
+    output_file.close
+  end
+end

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

@@ -0,0 +1,11 @@
+/**
+ * .H created with
+ * GBTiles Ruby Gem (v<%= GBTiles::VERSION %>) - GBT
+ */
+
+// Helpers
+#define <%= label %>Bank <%= bank %>
+#define <%= label %>Count <%= mod_data.song_length %>
+
+// Extern
+extern unsigned char <%= label %>[];

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

@@ -0,0 +1,63 @@
+require "gbtiles/gbt/export/asm/converter"
+require "erb"
+
+module GBTiles
+  module GBT
+    module Export
+      module ASM
+        class ASM
+          include ERB::Util
+
+          attr_accessor :bank
+          attr_accessor :label
+          attr_accessor :mod_data
+          attr_accessor :converter
+
+          def initialize
+            @converter = GBTiles::GBT::Export::ASM::Converter.new
+          end
+
+          def prerender
+            if !@bank.is_a? Numeric then
+              raise "Bank must be numeric"
+            end
+
+            if @mod_data.nil? then
+              raise "Missing required mod data"
+            end
+
+            @label ||= mod_data.name
+          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_filename = "#{File.basename(output_stream.path, ".s")}.h"
+              header_path = "#{File.dirname(File.expand_path(output_stream.path))}/#{header_filename}"
+              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/gbt/export/asm/asm.s.erb

@@ -0,0 +1,20 @@
+; .S created with
+; GBTiles Ruby Gem (v<%= GBTiles::VERSION %>) - GBT
+
+.area _CODE_<%= bank -%>
+
+<% for i in 0..(mod_data.pattern_table.max) do %>
+<%= "_#{label}#{i}" %>:
+<% for j in 0..63 -%>
+.db <%= converter.convert(mod_data.patterns[i].rows[j]) %>
+<% end -%>
+<% end -%>
+
+.globl <%= "_#{label}" %>
+.dw <%= "_#{label}" %>
+
+<%= "_#{label}" %>:
+<% for i in 0..(mod_data.song_length - 1) -%>
+.dw <%= "_#{label}#{i}" %>
+<% end -%>
+.dw 0x0000