RSokoban 0.74 → 0.76

data/NEWS

@@ -1,6 +1,38 @@
+version 0.76  2011-02-21
+
+  * All UIs
+    + save/display score
+    + program opens on the last played level
+
+  * Tk GUI
+    + you can change the skin
+    + 3 skins shipped with the software
+    + you can add your own skins
+    + skins are of any size
+    + better integration of Tk (new dependence: tk-tile library)
+
+
+version 0.75.1  2011-02-12
+
+  * Tk GUI
+    + unlimited map size
+    + auto scrolling
+    + user scrolling
+    + window size follows map size
+
+  * fix 
+    + bug#3
+    + bug#9
+
+
+version 0.74.1  2011-02-09
+
+  * Tk GUI: nicer background
+
+
 version 0.74  2011-01-31
 
-	* New: redo feature (only available with Tk GUI)
+  * New: redo feature (only available with Tk GUI)
 	
   * Tk GUI
     + add a 'next level' feature

data/README.rdoc

@@ -1,33 +1,42 @@
 = Welcome to RSokoban !
 
 RSokoban is a clone of the famous {Sokoban}[http://en.wikipedia.org/wiki/Sokoban] game.
-I wrote this program just to improve my skills in Ruby.
+I wrote this program just to improve my skills in Ruby with GUI.
 
 *Features*
 * Graphical user interface with Tk
-* Two console user interfaces (curses and straight text mode)
+* Skinning
 * 200+ levels
 * Undo/redo
 * Use xsb file format to load sets of levels
+* Additional console user interfaces (curses and straight text mode)
 
 Enjoy the game.
 
 
 == Documentation
 
-Players can look at {the wiki}[https://github.com/lkdjiin/RSokoban/wiki].
+Look at {the wiki}[https://github.com/lkdjiin/RSokoban/wiki].
 
-Developpers can look at Level, Game and TkUI.
 
+== Installing
 
-== Dependancies
+=== Installing dependencies
 
-Ruby >= 1.8.7
+You need Ruby >= 1.8.7
 
+To play with the graphical user interface you need to be sre that the following
+packages are installed on your system:
 
-== Installing RSokoban
+* libtcltk-ruby
+* libtk-img
+* tk-tile
 
-*First method*
+
+=== Installing RSokoban
+
+<b>First method, install from the sources</b>
+This is the method I recommend.
 To install RSokoban from the source, go to the RSokoban folder and build the gem:
 
  gem build rsokoban.gemspec
@@ -45,17 +54,15 @@ If you prefer using rake to build and install:
  rake build
  rake install
 
-*Second method*
+<b>Second method</b>
 Or install via RubyGem in one command (you need ruby 1.9 or higher).
-Note that I don't certify you will get the latest release:
+<em>Note that I don't certify you will get the latest release</em>:
 
  gem install RSokoban
 
-*Third method*
-Or you can play without installing it. Go to the RSokoban/bin folder and type:
-
- ./rsokoban
+== Licence
 
+GPLv3
 
 == Questions and/or Comments
 

data/TODO

@@ -1,18 +1,12 @@
-* tk: use one image for rendering, not an array (if possible ?)
-* don't restrict map size
+
+-------------------------------------------------------
+Think about:
 * gnome GUI (gtk only to be windows compatible ?)
 * give a try to rubygame ?
-* skining
-  + load skin
-  + several size of tiles or resizing ?)
-* Console UI should provide a way to know names of sets
-* save a game
-* reload a saved game
-* multi player support
-* save score
-* scoring moves and pushes
-* level preview
+* scoring moves and pushes ?
+* level preview ?
 * solver (plugin ?)
+* zoom ?
 * format fichier niveau xml (.slc)
 * other GUI(s) ?
 * mouse support

data/VERSION

@@ -1 +1 @@
-0.74
+0.76

data/bin/rsokoban

@@ -24,10 +24,21 @@ $RSOKOBAN_DATA_PATH = File.expand_path(File.dirname(__FILE__) + '/../data')
 
 require 'rsokoban'
 
+unless File.exist? File.join(RSokoban::CONFIG_FOLDER, RSokoban::CONFIG_FILE)
+	RSokoban::Install.create_config RSokoban::CONFIG_FOLDER
+end
+
+unless File.exist? RSokoban::RECORD_FOLDER
+	RSokoban::Install.create_folder RSokoban::RECORD_FOLDER
+end
+
 tk_failed=<<EOS
 Sorry, failed to load tk or tkimg library.
-Please, be sure that libtcltk-ruby and libtk-img are correctly installed on
-your system.
+Please, be sure that:
+  libtcltk-ruby
+  libtk-img
+  tk-tile
+are correctly installed on your system.
 Now trying to start with curses library:
   rsokoban --curses
 
@@ -51,6 +62,7 @@ if option[:ui] == :tk
 	begin
 		require 'tk'
 		require 'tkextlib/tkimg'
+		require 'tkextlib/tile'
 	rescue LoadError => e
 		puts tk_failed
 		option.interface = :curses
@@ -68,5 +80,30 @@ if option[:ui] == :curses
 	end
 end
 
-game = RSokoban::Game.new option[:ui]
+# Find last set
+conf = RSokoban::Config.new
+last_set = conf['set']
+conf = nil # to be GCed ?
+
+case option[:ui]
+	when :curses
+		require "rsokoban/ui/curses_console"
+		ui = RSokoban::UI::CursesConsole.new
+		game = RSokoban::GameFactory.create RSokoban::GameCurses, ui, last_set
+	when :portable
+		require "rsokoban/ui/console"
+		ui = RSokoban::UI::Console.new
+		game = RSokoban::GameFactory.create RSokoban::GamePortable, ui, last_set
+	when :tk
+		require "rsokoban/ui/tk_ui"
+		require "rsokoban/ui/tk_dialogs"
+		game = RSokoban::GameFactory.create RSokoban::GameTk, 'fake ui', last_set
+		game.ui = RSokoban::UI::TkUI.new(game)
+end
+
+at_exit do
+	conf = RSokoban::Config.new
+	conf.save_set_and_level game.set_name, game.level_number
+end
+
 game.run

data/data/big.xsb

@@ -0,0 +1,35 @@
+; Big maps test file
+
+; Some big maps without interests except for testing purposes.
+
+##############################
+#                            #
+#                            #
+#                            #
+#  @        ..               #
+#                            #
+#                      $     #
+#                            #
+#                            #
+#                            #
+#                            #
+#                            #
+#                            #
+#                            #
+#                            #
+#                            #
+#                            #
+#                            #
+#                            #
+#                            #
+#                            #
+#                            #
+#                            #
+#                            #
+#   $                        #
+#                            #
+#                            #
+#                            #
+#                            #
+##############################
+; 30x30 square

data/lib/rsokoban/config.rb

@@ -0,0 +1,34 @@
+module RSokoban
+
+	class Config
+		
+		def initialize
+			@conf = YAML.load_file File.join(CONFIG_FOLDER, CONFIG_FILE)
+		end
+		
+		def [](key)
+			@conf[key]
+		end
+		
+		def []= (key, value)
+			@conf[key] = value
+			write_config
+		end
+		
+		def save_set_and_level setname, level_number
+			@conf['set'] = setname
+			@conf['level'] = level_number
+			write_config
+		end
+		
+		private
+		
+		def write_config
+			f = File.new(File.join(CONFIG_FOLDER, CONFIG_FILE), "w")
+			f.write @conf.to_yaml
+			f.close
+		end
+		
+	end
+
+end

data/lib/rsokoban/crate.rb

@@ -2,14 +2,13 @@ require "rsokoban/moveable"
 
 module RSokoban
 
-	# I am a moveable crate.
+	# I am a positionable, moveable crate.
 	class Crate < Position
 		include RSokoban::Moveable
 		
-		# @param [Fixnum] x la coordonnée x
-		# @param [Fixnum] y la coordonnée y
-		def initialize x, y
-			super(x, y)
+		# Coordinates must be Fixnum
+		def initialize x_coord, y_coord
+			super(x_coord, y_coord)
 		end
 	end
 	

data/lib/rsokoban/exception.rb

@@ -1,7 +1,9 @@
 module RSokoban
+	# Used when we try to load a file that doesn't exist.
 	class NoFileError < ArgumentError
 	end
 	
+	# Used when we try to load a level (from a set of levels) that is out of limit.
 	class LevelNumberTooHighError < ArgumentError
 	end
 	

data/lib/rsokoban/game/game.rb

@@ -0,0 +1,153 @@
+module RSokoban
+
+	# I provide the basic API to run a game.
+	# I am user interface agnostic.
+	# @since 0.74.1
+	module Game
+		# @return [Fixnum]
+		attr_reader :level_number, :set_name
+
+		# Construct a new game that you can later run.
+		# @param [UI] the user interface associated to this game
+		# @param [String] setname The set of levels to begin with
+		def initialize ui, setname = 'microban.xsb'
+			@set_name = setname
+			@level_loader = SetLoader.new setname
+			conf = Config.new
+			@level_number = conf['level']
+			@ui = ui
+		end
+		
+		# Start the game loop.
+		# @note You must override me in a concrete class.
+		def run
+			raise NotImplementedError
+		end
+		
+		# @return [Fixnum]
+		def level_width
+			@level.width
+		end
+		
+		# @return [Fixnum]
+		def level_height
+			@level.height
+		end
+		
+		# @return [String]
+		def level_title
+			@level.title
+		end
+		
+		# Get current map of the game as an array of strings
+		# @return [Array<String>]
+		def map_as_array
+			@level.map_as_array
+		end
+		
+		# Get x coordinate of the man
+		# @return [Fixnum]
+		def man_x
+			@level.man.x
+		end
+		
+		# Get y coordinate of the man
+		# @return [Fixnum]
+		def man_y
+			@level.man.y
+		end
+		
+		# Get result of the move
+		# @param [:up|:down|:right|:left] direction
+		# @return [Object]
+		def move direction
+			@level.move direction
+		end
+		
+		# Get current move number
+		# @return [Fixnum]
+		def move_number
+			@level.move_number
+		end
+		
+		# Get result of undo last move
+		# @return [MoveResult]
+		def undo
+			@level.undo
+		end
+		
+		# Get result of redo last undone move
+		# @return [MoveResult]
+		def redo
+			@level.redo
+		end
+		
+		# Get title of the current set
+		# @return [String]
+		def set_title
+			@level_loader.title
+		end
+		
+		# Get numbers of level from the current set
+		# @return [Fixnum]
+		def set_size
+			@level_loader.size
+		end
+		
+		# @note You must override me.
+		def start_level
+			raise NotImplementedError
+		end
+	
+		# Load and start the next level of the set
+		# @return See the implementation of start_level in a descendant module (GameUI or GameGUI).
+		def next_level
+			@level_number += 1
+			start_level
+		end
+		
+		# Load a level from the current set.
+		# @param [Fixnum] num the number of the set (base 1)
+		# @return See the implementation of start_level in a descendant module (GameUI or GameGUI).
+		def load_level num
+			@level_number = num
+			start_level
+		end
+		
+		# Restart current set from level 1.
+		# @return See the implementation of start_level in a descendant module (GameUI or GameGUI).
+		def restart_set
+			@level_number = 1
+			start_level
+		end
+		
+		# Load a new set of levels and start its first level.
+		# @param [String] setname the name of the set (with .xsb extension)
+		def load_a_new_set setname 
+			@set_name = setname
+			@level_loader = SetLoader.new setname
+			@level_number = 1
+			@level = @level_loader.level(@level_number)
+		end
+		
+		# Get record for current level (in # of moves)
+		# @since 0.76
+		def record
+			@level.record
+		end
+		
+		# Update record if needed.
+		# @return true if old record is beaten.
+		# @since 0.76
+		def update_record
+			if record.nil? or move_number < record
+				@level.update_record
+				true
+			else
+				false
+			end
+		end
+		
+	end
+	
+end

data/lib/rsokoban/game/game_curses.rb

@@ -0,0 +1,11 @@
+module RSokoban
+
+	# I am a game to run in a window with the curses library
+	# @since 0.74.1
+	class GameCurses
+		include GameUI
+
+		
+	end
+
+end

data/lib/rsokoban/game/game_factory.rb

@@ -0,0 +1,23 @@
+module RSokoban
+
+	# @since 0.74.1
+	module GameFactory
+		
+		# @param [GamePortable|GameCurses|GameTk] a_class
+		# @param [UI] ui associated user interface
+		# @param [String] level_set set to start playing with
+		def self.create a_class, ui, level_set = 'microban.xsb'
+			if GamePortable == a_class
+				GamePortable.new(ui, level_set)
+			elsif GameCurses == a_class
+				GameCurses.new(ui, level_set)
+			elsif GameTk == a_class
+				GameTk.new(ui, level_set)
+			else
+				raise ArgumentError
+			end
+		end
+		
+	end
+
+end

data/lib/rsokoban/game/game_gui.rb

@@ -0,0 +1,27 @@
+module RSokoban
+
+	# I extends/implements the API of module Game, to run the game
+	# within a GUI. I don't define the user interface, you can use me
+	# to run game with Tk, Gnome, etc.
+	# @since 0.74.1
+	module GameGUI
+		include Game
+		
+		attr_writer :ui
+		
+		def initialize ui, setname = 'microban.xsb'
+			super(ui, setname)
+		end
+		
+		def run
+			@ui.run
+		end
+		
+		def start_level
+			@level = @level_loader.level(@level_number)
+			nil
+		end
+		
+	end
+
+end

data/lib/rsokoban/game/game_portable.rb

@@ -0,0 +1,10 @@
+module RSokoban
+
+	# I am a game to run in a straight console window
+	# @since 0.74.1
+	class GamePortable
+		include GameUI
+		
+	end
+
+end

data/lib/rsokoban/game/game_tk.rb

@@ -0,0 +1,11 @@
+module RSokoban
+
+	# I am a game to run with the Tk library
+	# @since 0.74.1
+	class GameTk
+		include GameGUI
+
+		
+	end
+
+end

data/lib/rsokoban/game/game_ui.rb

@@ -0,0 +1,81 @@
+module RSokoban
+
+	# I extends/implements the API of module Game, to run the game
+	# in a console window. I don't define the user interface, you can use me
+	# to run game with curses, n-curses, straight text-mode, etc.
+	# @since 0.74.1
+	module GameUI
+		include Game
+		
+		def initialize ui, setname = 'microban.xsb'
+			super(ui, setname)
+		end
+		
+		# I am the game loop for UIs.
+		def run
+			player_action = start_level
+			loop do
+				if player_action.level_number?
+					player_action = load_level player_action.action
+					next
+				elsif player_action.set_name?
+					player_action = load_a_new_set player_action.action
+					next
+				elsif player_action.quit?
+					break
+				elsif player_action.next?
+					player_action = next_level
+					next
+				elsif player_action.retry?
+					player_action = start_level
+					next
+				elsif player_action.move?
+					result = @level.move(player_action.action)
+				elsif player_action.undo?
+					result = @level.undo
+				end
+				
+				hash = {:map=>@level.map_as_array, :move=>result[:move_number]}
+				case result[:status]
+					when :win
+						update_record
+						player_action = @ui.get_action(hash.merge({:type=>:win}))
+					when :ok then player_action = @ui.get_action(hash.merge({:type=>:display}))
+					else
+						player_action = @ui.get_action(:type=>:display, :map=>@level.map_as_array, :error=>result[:message])
+				end
+				
+			end
+			true
+		end
+		
+		# @return [PlayerAction]
+		def start_level
+			begin
+				@level = @level_loader.level(@level_number)
+				@ui.get_action(get_hash_after_loading_set)
+			rescue LevelNumberTooHighError
+				@ui.get_action(:type=>:end_of_set, :map=>Map.new)
+			end
+		end
+		
+		def load_a_new_set setname 
+			begin
+				super(setname)
+				@ui.get_action(get_hash_after_loading_set)
+			rescue NoFileError
+				error = "Error, no such file : #{setname}"
+				@ui.get_action(get_hash_after_loading_set.merge({:error=>error}))
+			end
+		end
+		
+		private
+		
+		def get_hash_after_loading_set
+			{:type=>:start, :map=>@level.map_as_array, :title=>@level.title, :set=>@level_loader.title,
+						:number=>@level_number, :total=>@level_loader.size, :record => @level.record}
+		end
+		
+	end
+
+end