h3m 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in h3m.gemspec
+gemspec

data/README.md

@@ -0,0 +1,44 @@
+# H3m
+
+Simple parser for Heroes of Might and Magic III map format. Currently can extract info about map name, description, difficulty, size, subterranean presence and minimal required game version (to be continued, see TODO).
+
+## Usage
+
+Usage example:
+
+    >> require "h3m"
+    >> m = H3m::Map.new("path/to/map/file.h3m")
+
+    >> m.name
+    => "Map name"
+
+    >> m.description
+    => "Map description"
+    
+    >> # Version can be :SoD, :AB or :RoE
+    >> m.version
+    => :SoD
+
+    >> # Size can be :S, :M, :L and :XL
+    >> m.size
+    => :M
+
+    >> m.has_subterranean?
+    => false
+
+    >> # Difficulty can be :easy, :normal, :hard, :expert and :impossible
+    >> m.difficulty
+    => :normal
+
+
+## TODO
+
+1. players and alliances
+2. victory and lose conditions
+3. minimap image generation
+
+## License
+
+Copyright (C) 2013 Maxim Andryunin
+
+Released under the [MIT License](http://www.opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,5 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec

data/h3m.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'h3m/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "h3m"
+  spec.version       = H3m::VERSION
+  spec.authors       = ["Maxim Andryunin"]
+  spec.email         = ["maxim.andryunin@gmail.com"]
+  spec.description   = %q{This gem will can extract info about players, teams, map size and version, win conditions of Heroes 3 map}
+  spec.summary       = %q{Extract some info from Heroes of Might and Magic 3 map (.h3m)}
+  spec.homepage      = "https://github.com/andryunin/h3m"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "bindata"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rspec", ">= 2.0.0"
+  spec.add_development_dependency "rake"
+end

data/lib/h3m.rb

@@ -0,0 +1,7 @@
+require "h3m/version"
+require "zlib"
+
+module H3m
+  autoload :Map,       "h3m/map.rb"
+  autoload :MapRecord, "h3m/records.rb"
+end

data/lib/h3m/map.rb

@@ -0,0 +1,77 @@
+module H3m
+
+  class MapError < StandardError
+  end
+  
+  class Map
+    # Map representation
+    #
+    # Example:
+    #   >> map = H3m::Map.new("some-map-file.h3m")
+    #   >> map.version
+    #   => :SoD
+
+    attr_reader :path
+
+    def initialize(path)
+      @path = path
+      @gzip_file = File.new(path)
+    end
+
+    def file
+      @file ||= Zlib::GzipReader.new(@gzip_file)
+    end
+
+    # Get extension 
+    # @return [Symbol] :SoD, :AB or :RoE
+    def version
+      @version ||= case record.heroes_version
+        when 0x0E then :RoE
+        when 0x15 then :AB
+        when 0x1C then :SoD
+        else
+          raise MapError, "unknown map version"
+      end
+    end
+
+    def size
+      @size ||= case record.map_size
+        when 36  then :S
+        when 72  then :M
+        when 108 then :L
+        when 144 then :XL
+        else
+          raise MapError, "unknown map size"
+      end
+    end
+
+    def name
+      record.map_name
+    end
+
+    def description
+      record.map_desc
+    end
+
+    def difficulty
+      @difficulty ||= case record.map_difficulty
+        when 0 then :easy
+        when 1 then :normal
+        when 2 then :hard
+        when 3 then :expert
+        when 4 then :impossible
+        else
+          raise MapError, "unknown map difficulty"
+      end
+    end
+
+    def has_subterranean?
+      record.map_has_subterranean != 0
+    end
+
+    def record
+      @record ||= H3m::MapRecord.read(file)
+    end
+  end
+
+end

data/lib/h3m/records.rb

@@ -0,0 +1,49 @@
+require 'bindata'
+
+module H3m
+
+  class PlayerRecord < BinData::Record
+    endian :little
+
+    uint8 :max_level
+
+    uint8 :can_be_human
+    uint8 :can_be_computer
+    uint8 :computer_behaviour
+
+    uint8  :has_town_on_start
+    uint16 :can_have_town_types
+    uint8  :has_random_town
+    uint8  :has_main_town
+
+    uint8 :main_town_has_hero, onlyif: :has_main_town?
+    uint8 :main_town_type,     onlyif: :has_main_town?
+    uint8 :main_town_coord_x,  onlyif: :has_main_town?
+    uint8 :main_town_coord_y,  onlyif: :has_main_town?
+    uint8 :main_town_coord_z,  onlyif: :has_main_town?
+
+    def has_main_town?
+      has_main_town.nonzero?
+    end
+  end
+
+  class MapRecord < BinData::Record
+    endian :little
+
+    uint32 :heroes_version
+    uint8  :map_has_hero
+    uint32 :map_size
+    uint8  :map_has_subterranean
+
+    uint32 :map_name_size
+    string :map_name, read_length: :map_name_size
+
+    uint32 :map_desc_size
+    string :map_desc, read_length: :map_desc_size
+
+    uint8  :map_difficulty
+
+    array  :players, type: :player_record, initial_length: 8
+  end
+
+end

data/lib/h3m/version.rb

@@ -0,0 +1,3 @@
+module H3m
+  VERSION = "0.1.0"
+end

data/spec/map_spec.rb

@@ -0,0 +1,54 @@
+require "spec_helper"
+
+describe H3m::Map do
+
+  before :all do
+    @files  = Dir.glob("spec/resources/SoD_*.h3m")
+    @params = @files.map do |path|
+      filename = File.basename(path, ".h3m")
+      version, size = filename.split("_").map(&:to_sym)
+      {version: version, size: size}
+    end
+
+  end
+
+  it "should return correct version" do
+    @files.each_with_index do |path, index|
+      params = @params[index]
+      map = H3m::Map.new(path)
+      map.version.should == params[:version]
+    end
+  end
+
+  it "should return correct size" do
+    @files.each_with_index do |path, index|
+      params = @params[index]
+      map = H3m::Map.new(path)
+      map.size.should == params[:size]
+    end
+  end
+
+  it "should return correct name and description" do
+    map = H3m::Map.new("spec/resources/test_1.h3m")
+
+    map.name.should == "test map name"
+    map.description.should == "test map desc"
+  end
+
+  it "should correctly determine subterranean presence" do
+    map = H3m::Map.new("spec/resources/test_1.h3m")
+    map.has_subterranean?.should == true
+
+    map = H3m::Map.new("spec/resources/test_2.h3m")
+    map.has_subterranean?.should == false
+  end
+
+  it "should correctly determine map difficulty" do
+    map = H3m::Map.new("spec/resources/test_1.h3m")
+    map.difficulty.should == :normal
+
+    map = H3m::Map.new("spec/resources/test_2.h3m")
+    map.difficulty.should == :impossible
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require "h3m"
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: h3m
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Maxim Andryunin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bindata
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem will can extract info about players, teams, map size and version,
+  win conditions of Heroes 3 map
+email:
+- maxim.andryunin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- README.md
+- Rakefile
+- h3m.gemspec
+- lib/h3m.rb
+- lib/h3m/map.rb
+- lib/h3m/records.rb
+- lib/h3m/version.rb
+- spec/map_spec.rb
+- spec/resources/SoD_L.h3m
+- spec/resources/SoD_M.h3m
+- spec/resources/SoD_S.h3m
+- spec/resources/SoD_XL.h3m
+- spec/resources/test_1.h3m
+- spec/resources/test_2.h3m
+- spec/spec_helper.rb
+homepage: https://github.com/andryunin/h3m
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Extract some info from Heroes of Might and Magic 3 map (.h3m)
+test_files:
+- spec/map_spec.rb
+- spec/resources/SoD_L.h3m
+- spec/resources/SoD_M.h3m
+- spec/resources/SoD_S.h3m
+- spec/resources/SoD_XL.h3m
+- spec/resources/test_1.h3m
+- spec/resources/test_2.h3m
+- spec/spec_helper.rb