.bmp file format of Heroes of Might and Magic: Ruby parsing library

Application

Heroes of Might and Magic

File extension

bmp

KS implementation details

License: CC0-1.0

This page hosts a formal specification of .bmp file format of Heroes of Might and Magic using Kaitai Struct. This specification can be automatically translated into a variety of programming languages to get a parsing library.

Usage

Runtime library

All parsing code for Ruby generated by Kaitai Struct depends on the Ruby runtime library. You have to install it before you can parse data.

The Ruby runtime library can be installed from RubyGems:

gem install kaitai-struct

Code

Parse a local file and get structure in memory:

data = HeroesOfMightAndMagicBmp.from_file("path/to/local/file.bmp")

Or parse structure from a string of bytes:

bytes = "\x00\x01\x02..."
data = HeroesOfMightAndMagicBmp.new(Kaitai::Struct::Stream.new(bytes))

After that, one can get various attributes from the structure by invoking getter methods like:

data.magic # => get magic

Ruby source code to parse .bmp file format of Heroes of Might and Magic

heroes_of_might_and_magic_bmp.rb

Download

# This is a generated file! Please edit source .ksy file and use kaitai-struct-compiler to rebuild

require 'kaitai/struct/struct'

unless Gem::Version.new(Kaitai::Struct::VERSION) >= Gem::Version.new('0.9')
  raise "Incompatible Kaitai Struct Ruby API: 0.9 or later is required, but you have #{Kaitai::Struct::VERSION}"
end

class HeroesOfMightAndMagicBmp < Kaitai::Struct::Struct
  def initialize(_io, _parent = nil, _root = self)
    super(_io, _parent, _root)
    _read
  end

  def _read
    @magic = @_io.read_u2le
    @width = @_io.read_u2le
    @height = @_io.read_u2le
    @data = @_io.read_bytes((width * height))
    self
  end
  attr_reader :magic
  attr_reader :width
  attr_reader :height
  attr_reader :data
end