ifmapper 0.8.5 → 0.9

data/HISTORY.txt

@@ -1,3 +1,113 @@
+v0.9 - What's new:
+
+       - Fixed a very idiotic bug in Cut algorithm.  It was basically destroying
+	 all cut connections right after they were cut.
+
+       - Editing rooms' names or objects now results in a much, much
+	 faster redraw of the map, even if map is very complex.
+
+       - You can now display and edit a location's description.  This
+	 description is often used by the the automapper during transcript
+	 mapping to determine the uniqueness of a room, albeit the main 
+	 use of editing a room description is to allow creation of 
+	 new games (currently, Inform).
+
+       - You can now optionally avoid displaying the task or description
+	 section on rooms.
+	 This is mainly to allow you to read maps that have walkthru tasks
+	 in them without giving away the game.
+
+       - IFMapper now supports the concept of closed but unlocked doors.  
+	 These will be displayed as a white square between connections.
+	 The main interest of placing these doors is for creation
+	 of new Inform games, not so much for solving games.
+
+       - You can now select exit stubs.  Useful for deleting them when
+	 automapper detects them incorrectly.
+
+       - Saving and Loading a map will now verify the integrity of the map
+	 is correct.  This prevets autosave from saving a corrupt map if
+	 there is a bug in the program.
+
+       - CTRL-Selection is a toggle selection.  That is, if you click once
+	 on something already selected, it is deselected.
+
+       - Automapper improvements
+         * Automapper will now deal with complex commands involving 'then'
+	   a tad better.
+	 * An additional fix to dark rooms.  Looking in a dark room would
+	   result in the dark room being created, even if the room had
+	   already been tagged as dark.  Fixed.
+	 * When choosing an up/down/in/out/random move direction, a new
+	   connection will not be generated if there is already a similar
+	   n/s/e/w/etc. link between the two rooms.  This helps to simplify
+	   some maps.
+	 * Automapper now will try to automatically remove stub exits that
+	   are not really exits if the user tries to move in that direction
+	   and fails.
+	 * Automapping was incorrectly reporting a maze when a new exit
+	   would point in the same direction as a visited up/down or in/out
+	   exit.
+	 * Room descriptions are now compared (and stored) without \n at the
+	   end of each line.  This helps with comparing descriptions with any
+	   description the user typed manually.
+	 * Automapper will no longer crash if a link is attempted between
+	   two rooms in different sections, nor will it corrupt your map as
+	   it did before.
+	 * Automapper is now a tad smarter in not considering words such
+	   as open/close in descriptions.  This helps the automapper not
+	   get confused if a door which is part of the room description 
+	   changes state.
+
+       - Inform support.
+
+	 * You can now read an inform file and automap it, with
+	   some limitations.
+	   The main limitation deals with how doors are handled, as Inform
+	   offers an almost infinite number of ways of dealing with doors,
+	   including the use of at least one of 4 popular libraries.  Some
+	   code will actually resolve issues of where doors lead to within,
+	   for example, the "Enter" or "Exit" command, making parsing .inf
+	   files impossible without writing a full inform compiler.
+	   A second limitation is that Inform allows doors that exist only 
+	   on one "side" of a room.  These exits will be ignored.
+	   The inform automapper should prove compatible with most door 
+	   libraries, but will probably choke on a lot of hand-coded code.
+
+	 * You can now export a map as an Inform .inf (source code) file.
+	   This can be helpful at the beginning of designing a game to place
+	   all objects/characters, doors and room descriptions easily.
+	   Obviously, these source code files will later get hacked heavily
+	   manually to provide the real game functionality.  
+	   IFMapper just gives you a start, helping you design
+	   the landscape a tad more easily.
+	   Doors are created in Inform using Andrew MacKinnon's easydoors 
+	   Inform extension.
+
+	   NOTE:  A word of warning about reading Inform or TADS maps.
+	   Since these file formats have no concept of 'sections', they
+	   can lead to some **HUGE** maps.  The original Adventure, for
+	   example, results in a 100x100 map.  These huge maps may run
+	   into memory issues and currently make the path-finding algorithm
+	   work extremely slow.
+
+        - TADS 3 support
+
+	  * NOTE:  TADS 2 is currently *NOT* supported.
+
+	  * You can now read a TADS 3 file and automap it, with some
+	    limitations.
+	    Basically, TADS 3 templates are currently *NOT* supported.
+	    Instead, the standard library templates are kind of hard-coded
+	    in the reader.
+	    TADS 3's standard lib is more sensible than Inform when it 
+	    comes to doors, so it should hopefully lead to less 
+	    problems there.
+
+	  * You can now export a TADS 3 (.t) file.  Same concept as Inform,
+	    albeit doors are created using TADS3 standard door classes.
+
+
 
 v0.8.5 - This is mainly a bug fix release.
 	 

data/IFMapper.gemspec

@@ -2,7 +2,7 @@ require "rubygems"
 
 spec = Gem::Specification.new do |spec|
 	spec.name = "ifmapper"
-	spec.version = '0.8.5'
+	spec.version = '0.9'
 	spec.author = "Gonzalo Garramuno" 
 	spec.email = 'ggarram@advance.dsl.com.ar'
 	spec.homepage = 'http://www.rubyforge.org/projects/ifmapper/'

data/TODO.txt

@@ -1,7 +1,11 @@
 
+- Ability to remove stub exits if moving in a certain direction fails.
+  Need to trap 'fail' messages for moving such as:
+       You can't go that way.
+ 
+
 - Add SVG output
 - Do Printing
-- Cleanup code (lots of ugly and duplicated code 
-  between PDF/PS output)
+- Cleanup code 
 - Improve window scrolling (seems like an FXRuby bug)
 - Add Undo (at least for delete)

data/lib/IFMapper/Connection.rb

@@ -13,6 +13,7 @@ class Connection
   FREE        = 0
   LOCKED_DOOR = 1
   SPECIAL     = 2
+  CLOSED_DOOR = 3
 
   # Direction constants
   BOTH = 0
@@ -73,7 +74,7 @@ class Connection
 	dirB = Room::DIRECTIONS[idx] if idx
       end
     end
-    "#{a} #{dirA.upcase}<->#{b} #{dirB.upcase}"
+    "#{a} #{dirA}<->#{b} #{dirB}"
   end
 end
 

data/lib/IFMapper/FXConnection.rb

@@ -60,7 +60,7 @@ class FXConnection < Connection
   # window is open, copy the connection data to it.
   #
   def selected=(value)
-    @@win.copy_from(self) if value and @@win
+    @@win.copy_from(self) if value and @@win and @@win.shown?
     @selected = value
   end
 
@@ -205,6 +205,37 @@ class FXConnection < Connection
     return dc.drawBSpline( p )
   end
 
+  #
+  # Draw a door
+  #
+  def draw_door(dc, zoom, x1, y1, x2, y2)
+    v = [ (x2-x1), (y2-y1) ]
+    t = 10 * zoom / Math.sqrt(v[0]*v[0]+v[1]*v[1])
+    v = [ (v[0]*t).to_i, (v[1]*t).to_i ]
+    m = [ (x2+x1)/2, (y2+y1)/2 ]
+    x1, y1 = [m[0] + v[1], m[1] - v[0]]
+    x2, y2 = [m[0] - v[1], m[1] + v[0]]
+    if @type == LOCKED_DOOR
+      # Locked door
+      dc.drawLine(x1, y1, x2, y2)
+    else
+      # open door
+      v = [ v[0] / 3, v[1] / 3]
+      x1, y1 = x1.to_i, y1.to_i
+      x2, y2 = x2.to_i, y2.to_i
+      pts = []
+      pts << FXPoint.new(x1 - v[0], y1 - v[1])
+      pts << FXPoint.new(x1 + v[0], y1 + v[1])
+      pts << FXPoint.new(x2 + v[0], y2 + v[1])
+      pts << FXPoint.new(x2 - v[0], y2 - v[1])
+      pts << pts[0]
+      width = dc.lineWidth
+      dc.lineWidth = 0
+      dc.drawLines(pts)
+      dc.lineWidth = width
+    end
+  end
+
   #
   # Draw a complex connection
   #
@@ -219,18 +250,11 @@ class FXConnection < Connection
     x2, y2 = [p[-1].x, p[-1].y]
     draw_arrow(dc, zoom, x1, y1, x2, y2)
 
-    if @type == LOCKED_DOOR
+    if @type == LOCKED_DOOR or @type == CLOSED_DOOR
       t = p.size / 2
       x1, y1 = [ p[t].x, p[t].y ]
       x2, y2 = [ p[t-2].x, p[t-2].y ]
-
-      v = [ (x2-x1), (y2-y1) ]
-      t = 10 * zoom / Math.sqrt(v[0]*v[0]+v[1]*v[1])
-      v = [ (v[0]*t).to_i, (v[1]*t).to_i ]
-      m = [ (x2+x1)/2, (y2+y1)/2 ]
-      x1, y1 = [m[0] + v[1], m[1] - v[0]]
-      x2, y2 = [m[0] - v[1], m[1] + v[0]]
-      dc.drawLine(x1, y1, x2, y2)
+      draw_door(dc, zoom, x1, y1, x2, y2)
     end
   end
 
@@ -245,14 +269,8 @@ class FXConnection < Connection
       x2, y2 = @roomB.corner(self, zoom)
       dc.drawLine( x1, y1, x2, y2 )
       draw_arrow(dc, zoom, x1, y1, x2, y2)
-      if @type == LOCKED_DOOR
-	v = [ (x2-x1)*0.25, (y2-y1)*0.25 ]
-	t = 10 * zoom / Math.sqrt(v[0]*v[0]+v[1]*v[1])
-	v = [ (v[0]*t).to_i, (v[1]*t).to_i ]
-	m = [ (x2+x1)/2, (y2+y1)/2 ]
-	x1, y1 = [m[0] + v[1], m[1] - v[0]]
-	x2, y2 = [m[0] - v[1], m[1] + v[0]]
-	dc.drawLine(x1, y1, x2, y2)
+      if @type == LOCKED_DOOR or @type == CLOSED_DOOR
+	draw_door(dc, zoom, x1, y1, x2, y2)
       end
     else
       # Complex connection in progress or "stub" exit

data/lib/IFMapper/FXConnectionDialogBox.rb

@@ -6,10 +6,18 @@ class FXConnectionDialogBox < FXDialogBox
 
   TYPE_TEXT = [
     'Free',
+    'Door',
     'Locked',
     'Special',
   ]
 
+  TYPE_NUM = [
+    Connection::FREE,        # free
+    Connection::CLOSED_DOOR, # door
+    Connection::LOCKED_DOOR, # locked
+    Connection::SPECIAL,     # special
+  ]
+
   DIR_TEXT = [
     'Both',
     'A to B',
@@ -28,7 +36,7 @@ class FXConnectionDialogBox < FXDialogBox
 
   def copy_to()
     @conn.dir       = @dir.currentNo
-    @conn.type      = @type.currentNo
+    @conn.type      = TYPE_NUM[ @type.currentNo ]
     @conn.exitAtext = @exitA.currentNo
     @conn.exitBtext = @exitB.currentNo
 
@@ -41,7 +49,7 @@ class FXConnectionDialogBox < FXDialogBox
     self.title = title
 
     @dir.currentNo   = conn.dir
-    @type.currentNo  = conn.type || 0
+    @type.currentNo  = TYPE_NUM.index(conn.type) || 0
     @exitA.currentNo = conn.exitAtext
     @exitB.currentNo = conn.exitBtext
     @conn = conn

data/lib/IFMapper/FXMap.rb

@@ -53,13 +53,6 @@ class FXMap < Map
     end
   end
 
-  #
-  # Fit all rooms in map, adjusting map size if needed
-  #
-  def fit
-    super
-    create_pathmap
-  end
 
   #
   # Jump to a certain section #
@@ -241,10 +234,10 @@ class FXMap < Map
     b = c.roomB
 
     dirA = a.exits.index(c)
-    raise "connection not found #{c} at #{a}" unless dirA
+    raise "A connection not found #{c} at #{a}" unless dirA
 
     dirB = b.exits.rindex(c)
-    raise "connection not found #{c} at #{b}" unless dirB
+    raise "B connection not found #{c} at #{b}" unless dirB
 
     vA = FXRoom::DIR_TO_VECTOR[dirA]
     vB = FXRoom::DIR_TO_VECTOR[dirB]
@@ -284,6 +277,12 @@ class FXMap < Map
       return false
     end
 
+    if (pA[0] - pB[0]).abs > 30 or
+	(pA[1] - pB[1]).abs > 30
+      c.failed = true
+      return
+    end
+
     # No, okay, we need to do true A* path finding
     c.failed = false
     aStar    = AStar.new
@@ -433,7 +432,7 @@ class FXMap < Map
       @sections[@section].connections.each { |c|
 	a = c.roomA
 	b = c.roomB
-	next if not b  # Complex connection in progress
+	next if not b and @complexConnection
 
 	if c.gpts.size > 0
 	  2.times { |t|
@@ -467,7 +466,15 @@ class FXMap < Map
 	  }
 	else
 	  x1, y1 = a.corner(c, 1, a.exits.index(c))
-	  x2, y2 = b.corner(c, 1, b.exits.rindex(c))
+	  if b
+	    x2, y2 = b.corner(c, 1, b.exits.rindex(c))
+	  else
+	    dir = a.exits.index(c)
+	    v = FXRoom::DIR_TO_VECTOR[dir]
+	    x2 = x1 + v[0] * WS
+	    y2 = y1 + v[1] * HS
+	  end
+
 	  x1, x2 = x2, x1 if x2 < x1
 	  y1, y2 = y2, y1 if y2 < y1
 	  if x1 == x2
@@ -530,6 +537,7 @@ class FXMap < Map
       # Then, create an off-screen image with that same size for double
       # buffering
       @image.destroy
+      GC.start
       @image = FXBMPImage.new(@window.getApp, nil, IMAGE_SHMI|IMAGE_SHMP, 
 			      width, height)
       @image.create
@@ -731,7 +739,7 @@ class FXMap < Map
 
   # Self-explanatory.
   def zoom_out
-    if @zoom > 0.25
+    if @zoom > 0.1
       self.zoom -= 0.1
     end
   end
@@ -1136,13 +1144,16 @@ class FXMap < Map
 	draw
 	return
       else
-	if event.state & SHIFTMASK == 0 and
-	    event.state & CONTROLMASK == 0
+	if event.state & SHIFTMASK == 0
 	  clear_selection
 	end
 	# Select the stuff
 	selection.update_properties(self)
-	selection.selected = true
+	if event.state & CONTROLMASK == 0
+	  selection.selected ^= true # toggle selection
+	else
+	  selection.selected  = true
+	end
       end
     end
     draw(sender, sel, event)
@@ -1315,11 +1326,10 @@ class FXMap < Map
     self.zoom = 0.8
   end
 
-
   #
-  # Handle deleting selected rooms and/or connections
+  # Handle 'cutting' any selected rooms and/or connections
   #
-  def delete_selected
+  def _cut_selected
     rooms = @sections[@section].rooms.find_all { |r| r.selected }
     conns = @sections[@section].connections.find_all { |c| c.selected }
     ############################
@@ -1343,6 +1353,22 @@ class FXMap < Map
     conns.each { |c| clean_path(c) }
     # Remove connections from current section in map
     @sections[@section].connections -= conns
+
+    return conns
+  end
+
+  def cut_selected
+    _cut_selected
+    modified = true
+    draw
+  end
+
+  #
+  # Handle deleting selected rooms and/or connections
+  #
+  def delete_selected
+    conns = _cut_selected
+
     # Remove room exits pointing to any removed connection
     conns.each { |c|
       a = c.roomA
@@ -1354,10 +1380,8 @@ class FXMap < Map
       end
     }
 
-    # Recreate pathmap.  We need to recreate pathmap for all paths
-    # as the removal of one path may help shorten the path of another.
-    create_pathmap
-    draw()
+    modified = true
+    draw
   end
 
   #
@@ -1705,12 +1729,7 @@ class FXMap < Map
   #
   def draw_background(dc, event = nil)
     dc.foreground = @options['BG Color']
-    
-    if event
-      dc.fillRectangle(event.rect.x, event.rect.y, event.rect.w, event.rect.h)
-    else
-      dc.fillRectangle(0,0, @canvas.width, @canvas.height)
-    end
+    dc.fillRectangle(0,0, @canvas.width, @canvas.height)
   end
 
   #
@@ -1794,6 +1813,22 @@ class FXMap < Map
     draw
   end
 
+  #
+  # Draw a single room (callback used when editing room dialog box)
+  #
+  def draw_room(room)
+    idx = @sections[@section].rooms.index(room)
+    return unless idx
+
+    dc = FXDCWindow.new(@canvas)
+    dc.font = @font
+    data = { }
+    data['font']    = @font
+    data['objfont'] = @objfont
+    room.draw(dc, @zoom, idx, @options, data)
+    dc.end
+  end
+
   #
   # Draw map
   #
@@ -1846,6 +1881,11 @@ class FXMap < Map
     end
 
     status "Saving '#{@filename}'..."
+
+    # Make sure we save a valid map.  This is mainly a fail-safe
+    # in case of an autosave due to a bug.
+    verify_integrity
+
     @version = FILE_FORMAT_VERSION
     begin
       f = File.open(@filename, "wb")