tmx 0.0.1 → 0.1.0

data/README.markdown

@@ -1,92 +0,0 @@
-# README
-## WHAT IS THIS
-
-Eventually, a usable TMX map loader that works with Gosu and doesn't care 
-whether you're using Chingu or some home-grown game engine of your own
-devising.
-
-### WHY ON EARTH
-
-I like Chingu and a TMX loader already exists for it, but it's just not the
-right tool for what I want to do. Hopefully others will find this useful as
-well. :)
-
-### WHAT IS MISSING
-
-Here's what's not: so far, map data is loaded and layers, object groups and
-tile sets are created. 
-
-Validating the XML document to its DTD would be nice too, but I'll be buggered
-if I can get Nokogiri to actually load the DTD. There is inadequate or no
-documentation on this topic. Probably we'll just have mysterious failures on
-unsupported or erroneous TMX files, which is not ideal.
-
-Possible consideration for the future: move the dependency on Gosu into a
-separate, mixable, matchable module. Maybe add explicit Chingu support too.
-Handle tile set creation and drawing ops the same way we do object creation:
-define a callback hook and let the user take care of it. Awesome.
-
-Help is welcome, obviously.
-
-## INSTALL
-
-Don't do it yet. The API is so unstable it does not have a half life but a
-quarter life.
-
-### PREREQUISITES
-
-* ruby >= 1.9.1 (probably)
-* nokogiri
-
-## LICENSE
-
-This software is available under the terms of the MIT license for no better
-reason than that this is the license of Gosu itself. This means that you are
-technically allowed to use my hard work as part of your proprietary,
-commercial product with no obligation to give anything back but credit where
-it's due. Use your discretion on that one.
-
-The full license is reproduced here for posterity:
-
-> Copyright © 2009–2010 Eris
-> 
-> 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.
-
-## AUTHORS
-
-* Eris <eris.discord@gmail.com>
-* your name here!
-
-## SEE ALSO
-
-* [Gosu][], a 2D game development library for Ruby and C++
-* [Chingu][], a higher level game library built on top of Gosu
-* [Chipmunk][], a 2D rigid body physics engine in C
-* [chipmunk-ffi][], more up-to-date Ruby bindings for Chipmunk
-* [Tiled][], a flexible tile map editor and the origin of the TMX format (I
-  think).
-
-[chingu]: http://github.com/ippa/chingu
-[chipmunk]: http://code.google.com/p/chipmunk-physics
-[chipmunk-ffi]: http://github.com/shawn42/chipmunk-ffi
-[gosu]: http://libgosu.org
-[tiled]: http://mapeditor.org/

data/Rakefile

@@ -1,11 +0,0 @@
-require 'rspec/core/rake_task'
-require "bundler/gem_tasks"
-
-desc 'Default: run specs.'
-task :default => :spec
-
-desc "Run specs"
-RSpec::Core::RakeTask.new do |t|
-# t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
-  # Put spec opts in a file named .rspec in root
-end

data/data/test.tmx

@@ -1,62 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<map version="1.0" orientation="orthogonal" width="16" height="16" tilewidth="16" tileheight="16">
- <properties>
-  <property name="bg1" value="#402010"/>
-  <property name="bg2" value="#100000"/>
-	<property name="fg1" value="#00ff0000"/>
-	<property name="fg2" value="#10ff0000"/>
-  <property name="display_name" value="Test Map"/>
- </properties>
- <tileset firstgid="1" name="debug" tilewidth="16" tileheight="16">
-  <image source="test-tiles.png"/>
- </tileset>
- <layer name="background" width="16" height="16" opacity="0.75">
-  <data encoding="base64" compression="gzip">
-   H4sIAAAAAAAAA2NgGAXogInK5rGh0aNgFAwWAADxvIrYAAQAAA==
-  </data>
- </layer>
- <layer name="obstacle" width="16" height="16">
-  <data encoding="base64" compression="gzip">
-   H4sIAAAAAAAAA82T4QqAIAyEZ1Jakb3/27YjB2MMMfvjwSHMfTp1BiIqg47sTOPKk/EXvWeCAnupLmqMDR7aa95RnVQumfye+vV6GM+PfEtgV/b9g5/p/UR4u+jEe3ncSTIx9Ia9J4/H3pvDezUmwwvbw0uN0h+658Stv4t59NIDVh+CwAAEAAA=
-  </data>
- </layer>
- <objectgroup name="doors" width="16" height="16">
-  <object name="door1" type="Door" x="128" y="208" width="16" height="32">
-   <properties>
-    <property name="image" value="door.png"/>
-    <property name="target" value="door2"/>
-   </properties>
-  </object>
-  <object name="door2" type="Door" x="64" y="32" width="16" height="32">
-   <properties>
-    <property name="image" value="door.png"/>
-    <property name="target" value="door1"/>
-   </properties>
-  </object>
- </objectgroup>
- <objectgroup name="objects" width="16" height="16">
-  <properties>
-   <property name="what_is_this" value="it's boxes ok"/>
-  </properties>
-  <object name="cardboard_box" type="Box" x="160" y="160" width="32" height="32">
-   <properties>
-    <property name="image" value="tid:16"/>
-   </properties>
-  </object>
-  <object name="stone_block" type="Box" x="192" y="32" width="32" height="32">
-   <properties>
-    <property name="image" value="tid:16"/>
-   </properties>
-  </object>
-  <object name="dude" type="Dude" x="80" y="144" width="16" height="32">
-   <properties>
-    <property name="image" value="dude.png"/>
-   </properties>
-  </object>
- </objectgroup>
- <layer name="foreground" width="16" height="16" opacity="0.75">
-  <data encoding="base64" compression="gzip">
-   H4sIAAAAAAAAA2NgGAWjYPABRiBmIoAJATYCeCD1EwMo1U8MAADF4i9MAAQAAA==
-  </data>
- </layer>
-</map>

data/examples/example-chingu.rb

@@ -1,114 +0,0 @@
-require 'chingu'
-require 'tmx'
-require 'opengl' # Chingu needs it for retrofy
-
-class Float
-  INFINITY = 1.0 / 0.0 unless const_defined? :INFINITY
-end
-
-class Box < Chingu::GameObject
-  # "It's just a box."
-  
-  # (Chingu takes care of everything we need here (it's magic))
-end
-
-class Door < Chingu::GameObject
-  # this ought to take you somewhere else
-end
-
-class Dude < Chingu::GameObject
-	# maybe your player logic goes here
-end
-
-class MapState < Chingu::GameState
-  has_trait :viewport
-  
-  def initialize map_name, *rest
-    super *rest
-    
-    # load our map
-    @map = TMX::Map.new $window, map_name,
-      :on_object => method(:create_chingu_object)
-    @banner = Gosu::Image.from_text $window,
-      @map.properties[:display_name],
-      'Helvetica', 24
-    
-    $window.caption = 'tmx demo - %s' % @map.properties[:display_name]
-  end
-  
-  def create_chingu_object name, group, properties
-    map = group.map
-    obj_class = Kernel.const_get properties[:type] rescue nil
-    
-    # assert that the object is a valid type
-    raise TypeError, "#{properties[:type]} is not a game object" \
-      unless obj_class.is_a? Class \
-      and    obj_class.ancestors.include? Chingu::BasicGameObject
-    
-    # load image
-    image_name = properties[:image]
-    image = case image_name
-      when /^tid:(\d+)$/
-        # a tile from the map's tile set
-        map.tile_set[Integer($1)]
-      when nil
-        # default image
-        Gosu::Image['default']
-      else
-        # image as named
-        Gosu::Image[File.join 'data', image_name]
-      end
-    
-    # convert TMX properties to what Chingu is expecting
-    properties.merge! \
-      :image    => image.retrofy,
-      :x        => properties[:x] + properties[:width]  / 2,
-      :y        => properties[:y] + properties[:height] / 2,
-      :factor_x => properties[:width].to_f  / image.width,
-      :factor_y => properties[:height].to_f / image.height,
-      :zorder   => 1
-    
-    # create and return the game object
-    obj_class.create properties
-  end
-  
-  def update
-    super
-    # move the map opposite the mouse pointer, with lag
-    viewport.x = 0.9 * viewport.x + 0.1 * ($window.mouse_x - $window.width  + @map.width  / 2)
-    viewport.y = 0.9 * viewport.y + 0.1 * ($window.mouse_y - $window.height + @map.height / 2)
-  end
-  
-  def draw
-    super
-    
-    fill_gradient \
-      :from   => @map.properties[:bg1],
-      :to     => @map.properties[:bg2],
-      :zorder => -Float::INFINITY
-    
-    # map is not a game object
-    @map.draw -viewport.x, -viewport.y
-    
-    fill_gradient \
-      :from   => @map.properties[:fg1],
-      :to     => @map.properties[:fg2],
-      :zorder => Float::INFINITY
-    
-    @banner.draw 8, 8, Float::INFINITY
-  end
-end
-
-class MapWindow < Chingu::Window
-  def initialize
-    super 400, 200, false
-    
-    # global inputs for our demo
-    self.input = { :escape => :close }
-    
-    # load that map
-    push_game_state MapState.new('data/test.tmx')
-  end
-end
-
-MapWindow.new.show

data/lib/tmx/coder.rb

@@ -1,39 +0,0 @@
-module Tmx
-  module Coder
-    # default coders
-    autoload :Base64, 'tmx/coder/base64'
-    autoload :Gzip,   'tmx/coder/gzip'
-    
-    def self.encode str, *encodings
-      encodings.reject(&:nil?).reduce(str) do |data, encoding|
-        find_coder(encoding).encode(data)
-      end
-    end # encode
-    
-    def self.decode str, *encodings
-      encodings.reject(&:nil?).reverse.reduce(str) do |data, encoding|
-        find_coder(encoding).decode(data)
-      end
-    end # decode
-    
-    def self.find_coder name
-      const_name = name.to_s.capitalize.gsub /(?:\b|_)([a-z])/, &:upcase
-      if const_defined? const_name
-        const_get const_name
-      else
-        raise NameError, "unknown coder #{name}"
-      end
-    end # find_coder
-    
-    def self.register_coder name, mod
-      const_name = name.to_s.capitalize.gsub /(?:\b|_)([a-z])/, &:upcase
-      if not const_defined? const_name
-        const_set const_name, mod
-      else
-        raise NameError, "coder #{name} already registered"
-      end
-    end # register_coder
-    
-  end # Coder
-  
-end

data/lib/tmx/coder/base64.rb

@@ -1,13 +0,0 @@
-module Tmx
-  module Coder
-    module Base64
-      def self.encode str
-        ::Base64.strict_encode64 str
-      end
-      
-      def self.decode str
-        ::Base64.decode64 str
-      end
-    end # Base64
-  end
-end

data/lib/tmx/coder/gzip.rb

@@ -1,21 +0,0 @@
-module Tmx
-  module Coder
-    module Gzip
-      def self.encode str
-        buffer = String.new
-        writer = Zlib::GzipWriter.new(StringIO.new(buffer))
-        writer << str
-        writer.close
-        buffer
-      end
-      
-      def self.decode str
-        reader = Zlib::GzipReader.new(StringIO.new(str))
-        output = reader.read
-        reader.close
-        output
-      end
-      
-    end # Gzip
-  end
-end

data/lib/tmx/map/tile_cache.rb

@@ -1,83 +0,0 @@
-module Tmx
-  # WARNING this is currently deprecated and not actually used
-  class Map::TileCache
-    def initialize map
-      @map = WeakRef.new map
-      
-      @tile_cache = []
-      @map_cache  = []
-      
-      @layer_count = 0
-      
-      @columns,    @rows        = 0, 0
-      @tile_width, @tile_height = 0, 0
-    end # initialize
-    
-    def rebuild!
-      rebuild_tile_set!
-      rebuild_map!
-    end
-    
-    def rebuild_tile_set!
-      raise RuntimeError, "tile set information has been discarded" if @map.tile_sets.nil?
-      
-      @tile_cache.clear
-      @map.tile_sets.each_value do |tile_set|
-        @tile_cache[tile_set.range] = tile_set.tiles
-      end
-    end
-    
-    def rebuild_map!
-      raise RuntimeError, "layer information has been discarded" if @map.layers.nil?
-      
-      @map_cache.clear
-      
-      @layer_count = @map.layers.count
-      
-      @columns,    @rows        = @map.columns,    @map.rows
-      @tile_width, @tile_height = @map.tile_width, @map.tile_height
-      
-      @map.layers.each_value.with_index do |layer, layer_index|
-        (0...@rows).each do |y|
-          (0...@columns).each do |x|
-            index   = _tile_index layer_index, x, y
-            tile_id = layer[x, y]
-            @map_cache[index] = @tile_cache[tile_id]
-          end
-        end
-      end
-    end # rebuild_map!
-    
-    def draw x_off, y_off, z_off, x_range, y_range
-      x_range = [x_range.min, 0].max .. [x_range.max, @columns  - 1].min
-      y_range = [y_range.min, 0].max .. [y_range.max, @rows     - 1].min
-      
-      y_range.each do |y|
-        tile_y_off = y_off + y * @tile_height
-        
-        x_range.each do |x|
-          tile_x_off = x_off + x * @tile_width
-          
-          range = _tile_range x, y
-          @map_cache[range].each.with_index do |image, z|
-            next if image.nil?
-            image.draw tile_x_off, tile_y_off, z_off + z
-          end
-          
-        end
-      end
-    end # draw
-    
-    protected
-    
-    def _tile_index layer_index, x, y
-      y * @columns * @layer_count + x * @layer_count + layer_index
-    end
-    
-    def _tile_range x, y
-      first = _tile_index 0, x, y
-      first...(first + @layer_count)
-    end
-    
-  end
-end