gaminator 0.0.5

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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Tomasz Werbicki
+
+MIT License
+
+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.

data/README.md

@@ -0,0 +1,80 @@
+# Gaminator
+
+A simple wrapper around Curses intended for writing ASCII games
+
+Post game submissions here: https://gist.github.com/4684252
+
+## Usage
+
+The Gaminator::Runner class implements the base methods used to
+run the game, the event loop being the most important. Initialize
+it like so:
+
+```
+# If you want the game to fill the whole screen
+Gaminator::Runner.new(SkiGame).run
+
+# If you want the game to have a set size (in rows/cols)
+Gaminator::Runner.new(SkiGame, :rows => 30, :cols => 80).run
+```
+
+The Game that is run by the GameRunner has to implement the
+following methods:
+
+* objects - the array of objects that are displayed on the screen
+* input_map - the mapping between the keyboard keys and game actions
+* tick - the method that is called for every loop cycle
+* exit_message - the message displayed when the game is finished
+* textbox_content - the message displayed at the bottom of the game window
+* wait? - determine whether to wait for input before next tick
+* sleep_time - the time interval beteen two event loop cycles
+
+The objects that are displayed on the screen have to implement the following
+interface:
+
+* x - the x position of the object
+* y - the y position of the object
+* char (optional) - the text representation of the object
+* color (optional) - the color of the object
+* texture (optional) - an array of string representing a row in a bigger shape
+* colors (optional) - an array of arrays (rows) of Curses color constants,
+  the texture will be colored accordingly
+
+You have to define either char or texture method on each object.
+
+Available colors:
+
+```
+Curses::COLOR_WHITE
+Curses::COLOR_RED
+Curses::COLOR_BLUE
+Curses::COLOR_GREEN
+Curses::COLOR_CYAN
+Curses::COLOR_MAGENTA
+Curses::COLOR_YELLOW
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem "gaminator", :git => "git://github.com/futuresimple/gaminator.git"
+
+Execute:
+
+    $ bundle
+
+And put following lines on top of your script file:
+
+    require "bundler/setup"
+    require "gaminator"
+
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/gaminator.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gaminator/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "gaminator"
+  gem.version       = Gaminator::VERSION
+  gem.authors       = ["Tomasz Werbicki", "Pawel Obrok"]
+  gem.email         = ["tomasz@werbicki.net", "pawel.obrok@gmail.com"]
+  gem.description   = "A simple wrapper around Curses for writing ASCII-art games"
+  gem.summary       = "See https://github.com/futuresimple/gaminator/blob/master/README.md"
+  gem.homepage      = "https://github.com/futuresimple/gaminator"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/lib/gaminator.rb

@@ -0,0 +1,5 @@
+require "gaminator/version"
+require "gaminator/runner"
+
+module Gaminator
+end

data/lib/gaminator/runner.rb

@@ -0,0 +1,139 @@
+# encoding: utf-8
+
+require "curses"
+
+module Gaminator
+  class Runner
+    include Curses
+
+    def initialize(game_class, options = {})
+      if options[:rows] && options[:cols]
+        resizeterm(options[:rows], options[:cols])
+      end
+
+      init_screen
+      start_color
+      cbreak
+      noecho
+      stdscr.nodelay = 1
+      curs_set(0)
+
+      [
+        COLOR_WHITE, COLOR_RED, COLOR_BLUE, COLOR_GREEN, COLOR_CYAN,
+        COLOR_MAGENTA, COLOR_YELLOW
+      ].each do |color|
+        init_pair(color, color, COLOR_BLACK)
+      end
+
+      @plane_width = cols
+      @plane_height = lines - 5
+      @plane = Window.new(@plane_height, @plane_width, 0, 0)
+      @plane.box("|", "-")
+
+      @textbox_width = cols
+      @textbox_height = 5
+      @textbox = Window.new(@textbox_height, @textbox_width, @plane_height, 0)
+      @textbox.box("|", "-")
+
+      @game = game_class.new(@plane_width - 2, @plane_height - 2)
+    end
+
+    def run
+      begin
+        loop do
+          tick_game
+
+          render_objects
+          render_textbox
+
+          @plane.refresh
+          @textbox.refresh
+
+          handle_input
+
+          clear_plane
+          clear_textbox
+
+          sleep(@game.sleep_time)
+        end
+      ensure
+        close_screen
+        puts
+        puts @game.exit_message
+        puts
+      end
+    end
+
+    private
+
+    def handle_input
+      if @game.wait?
+        @textbox.timeout = -1
+      else
+        @textbox.timeout = 0
+      end
+      char = @textbox.getch
+      action = @game.input_map[char]
+      if action && @game.respond_to?(action)
+        @game.send(action)
+      end
+    end
+
+    def tick_game
+      @game.tick
+    end
+
+    def render_objects
+      @game.objects.each do |object|
+        render_object(object)
+      end
+    end
+
+    def render_object(object)
+      color = object.respond_to?(:color) ? object.color : COLOR_WHITE
+      texture = object.texture if object.respond_to?(:texture)
+      texture ||= [object.char]
+
+      texture.each.with_index do |row,row_index|
+        row.each_char.with_index do |pixel,pixel_index|
+          x = object.x + 1 + pixel_index
+          y = object.y + 1 + row_index
+          next if x < 1 || x >= @plane_width
+          next if y < 1 || y >= @plane_height
+
+          if object.respond_to?(:colors) && object.colors
+            color = object.colors[row_index][pixel_index]
+          end
+
+          @plane.setpos(y,x)
+          @plane.attron(color_pair(color) | A_NORMAL) do
+            @plane.addstr(pixel)
+          end
+        end
+      end
+    end
+
+    def render_textbox
+      @textbox.setpos(2, 3)
+      @textbox.addstr(@game.textbox_content)
+    end
+
+    def clear_plane
+      1.upto(@plane_height - 2) do |y|
+        1.upto(@plane_width - 2) do |x|
+          @plane.setpos(y, x)
+          @plane.addstr(" ")
+        end
+      end
+    end
+
+    def clear_textbox
+      1.upto(@textbox_height - 2) do |y|
+        1.upto(@textbox_width - 2) do |x|
+          @textbox.setpos(y, x)
+          @textbox.addstr(" ")
+        end
+      end
+    end
+  end
+end

data/lib/gaminator/version.rb

@@ -0,0 +1,3 @@
+module Gaminator
+  VERSION = "0.0.5"
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: gaminator
+version: !ruby/object:Gem::Version
+  version: 0.0.5
+  prerelease: 
+platform: ruby
+authors:
+- Tomasz Werbicki
+- Pawel Obrok
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-23 00:00:00.000000000 Z
+dependencies: []
+description: A simple wrapper around Curses for writing ASCII-art games
+email:
+- tomasz@werbicki.net
+- pawel.obrok@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gaminator.gemspec
+- lib/gaminator.rb
+- lib/gaminator/runner.rb
+- lib/gaminator/version.rb
+homepage: https://github.com/futuresimple/gaminator
+licenses: []
+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: See https://github.com/futuresimple/gaminator/blob/master/README.md
+test_files: []
+has_rdoc: