stack_wars 0.1.0

data/README.md

@@ -0,0 +1,70 @@
+Stack Wars is an abstract board game currently being developed by Gregory Brown
+(@seacreature) and Jia Wu (@sindhri)
+
+The game itself can be played on Chess or Go board as long as you have some
+stackable objects available to you (coins or bingo markers work fine). However,
+the goal of this project is to build a computerized version so that anyone can
+play without any special equipment.
+
+See the RULES.txt file for an explanation of how the game works, and
+follow the instructions below.
+
+## To try out the game
+
+First install the `stack_wars` Ruby gem
+
+    $ gem install stack_wars
+
+Next, step through a sample game to get a sense of how things work
+
+    $ stack_wars demo
+
+If the demo made sense, start up your own game. Make sure to have a friend
+to share the keyboard with, as there are no bots yet. Rudimentary online
+games can be done via tmux or screen, but only if you already know
+how to use those tools and have a shared server handy ;)
+
+    $ stack_wars
+
+If the demo didn't make sense, you can review the rules once more:
+(uses the `less` command line tool)
+
+    $ stack_wars rules
+
+If things still don't make sense, you may want to wait until this project is
+farther along before playing with it further. But I'm happy to answer whatever
+questions you might have: gregory.t.brown@gmail.com
+
+_Please note that right now this game has a very rudimentary command line
+interface and has not been tested on any platforms other than Ruby 1.9.2 /
+Mac OS X 10.6. If you are trying this game out now, please make sure you
+feel comfortable diving into the source code if things don't work as 
+expected._
+
+## To contribute to this project
+
+There is a lot to be done on this project, and I'd be happy to accept contributions. 
+If you'd like to help out, here's where to start:
+
+    0) Make sure you've got a working install of Ruby 1.9.2 handy
+    1) Fork the project on github: https://github.com/sandal/stack_wars
+    2) Install Bundler if necessary (gem install bundler) [*]
+    3) Run bundle install [*]
+    4) Run ruby tests/suite.rb and verify tests are passing
+    5) Run ruby examples/sample_game.rb and make sure it works as expected
+
+    [*] Feel free to skip bundler instructions if you know what you're doing and
+    would rather not use Bundler, there are no runtime dependencies on it.
+
+Once you have gone through those steps, please email me at
+gregory.t.brown@gmail.com letting me know that you'd like to contribute to the
+project. If you had any trouble with the setup process, you can let me know at
+that time. 
+
+I will eventually post a roadmap publicly, but it's a bit early for that now. If
+you get in touch with me, I'll work with you to figure out what you can work on
+based on your interests and the needs of the project.
+
+_NOTE: Contributors retain copyright to their work but must agree to release their
+contributions under the [GNU Affero GPL version
+3](http://www.gnu.org/licenses/agpl.html)_

data/RULES.txt

@@ -0,0 +1,113 @@
+Stack Wars is an abstract board game played on a two dimensional grid, similar
+to a Chess or Go board. The game is currently still being play tested / 
+balanced, but the rules below should give you enough to try it out on your own.
+
+== Board layout + setup
+
+The board represents a battlefield that two players must
+fight for control over, with the goal of invading each other's bases. The ASCII
+representation below shows a standard 9x9 grid representing the battlefield.
+
+       0      1      2      3      4      5      6      7      8
+     WWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWW
+  0  (___)--(___)--(___)--(___)--(___)--(___)--(___)--(___)--(___)
+       |      |      |      |      |      |      |      |      |
+  1  (___)--(___)--(___)--(___)--(___)--(___)--(___)--(___)--(___)
+       |      |      |      |      |      |      |      |      |
+  2  (___)--(___)--(___)--(___)--(___)--(___)--(___)--(___)--(___)
+       |      |      |      |      |      |      |      |      |
+  3  (___)--(___)--(___)--(___)--(___)--(___)--(___)--(___)--(___)
+       |      |      |      |      |      |      |      |      |
+  4  (___)--(___)--(___)--(___)--(___)--(___)--(___)--(___)--(___)
+       |      |      |      |      |      |      |      |      |
+  5  (___)--(___)--(___)--(___)--(___)--(___)--(___)--(___)--(___)
+       |      |      |      |      |      |      |      |      |
+  6  (___)--(___)--(___)--(___)--(___)--(___)--(___)--(___)--(___)
+       |      |      |      |      |      |      |      |      |
+  7  (___)--(___)--(___)--(___)--(___)--(___)--(___)--(___)--(___)
+       |      |      |      |      |      |      |      |      |
+  8  (___)--(___)--(___)--(___)--(___)--(___)--(___)--(___)--(___)
+     BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB
+
+The battlefield starts off empty (as shown above), with each player holding a
+number of armies in reserve equal to three times the width of the battlefield.
+For example, on a 9x9 grid, each player starts off with 27 armies, on a 13x13
+each player starts off with 39 armies, and so on.
+
+== Possible turn actions 
+
+Black starts the game, and then play alternates as each player takes one of the
+following actions per turn.
+
+  - FORTIFY a CONTROLLED territory by adding a single army from reserves
+  - MOVE a single army from a CONTROLLED territory to an adjacent
+    UNCLAIMED territory
+  - ATTACK a single enemy territory adjacent to one of the player's 
+    CONTROLLED territories
+  - INVADE the enemy base (may be a MOVE or ATTACK, details explained later)
+
+Throughout the game, the following territories are considered to be CONTROLLED
+by the active player:
+
+  1) Anything that lies on the BASELINE (i.e. boundary line between the 
+     battlefield and the player's base). This works out to any territory 
+     in row 0 for white, and any territory in row N for black, where N is
+     the last row of the board.
+
+  2) Any territory which has at least one of the active player's army fortified
+     within it.
+
+Some restrictions apply to how turns play out, depending on game conditions:
+
+  * In order to FORTIFY a position, the active player must have at least one
+    army in reserves.
+
+  * Adjacent territories are a single edge away horizontally or vertically,
+    but not diagonally. E.g. adjacent territories to (2,2) are:
+    (2,1), (2,3), (1,2), (3,2). You cannot MOVE, ATTACK, or INVADE diagonally
+    at any point in time.
+
+  * Two or more armies within a single territory form a STACK. If moving from
+    a STACK to another position, only a single army is moved, not the 
+    entire STACK.
+
+  * You can only carry out an ATTACK from a territory which does not contain
+    a STACK (i.e. a position with a single army)
+
+  * If an ATTACK on an enemy territory causes that territory to becomes 
+    unoccupied, you must immediately move the army you attacked with 
+    into that territory.
+
+  * Whenever an army is removed from the battlefield via an ATTACK, 
+    it is immediately removed from play, and does not count for or against
+    either player's score, nor does it get returned to the either player's
+    reserves.
+
+== Gaining Points
+
+An INVASION is carried out by moving one of the active player's armies into an
+adjacent territory which is part of the enemy's BASELINE. This can be done via a
+MOVE or an ATTACK. As soon as the active player's army is moved onto the
+baseline, it is removed from play, and the active player gets one point added to
+their score.
+
+== Ending the game
+
+At the exact moment that one player has no armies in play as well as no armies
+in reserve, the game immediately ends. If one player has more points than the
+other, the player with the greater amount of points. If instead each player 
+has an equal number of points, the game ends in a draw.
+
+Alteratively, both players have the option of resigning at any time. Because
+this is a game in which it may be obvious who the winner is well ahead of the
+standard end game conditions, it should not be considered impolite to resign
+when the battle is no longer interesting.
+
+== Questions / Suggestions?
+
+Email gregory.t.brown@gmail.com
+
+== Implementation
+
+You can find the source code for this game at:
+http://github.com/sandal/stack_wars

data/bin/stack_wars

@@ -0,0 +1,63 @@
+#!/usr/bin/env ruby
+
+# NOTE: This script is just a proof of concept.
+# This game will eventually have a GUI of some sort
+
+require_relative "../lib/stack_wars"
+
+def play_game
+  field = StackWars::Battlefield.new
+  game  = StackWars::Game.new(field)
+
+  client = StackWars::TextClient.new(game)
+
+  message = catch(:game_over) do
+    loop do
+      system "clear"
+      puts field
+
+      puts
+      puts "Current Score: #{game.active_player.color}: "+
+           "#{game.active_player.successful_invasions}, "+
+           "#{game.opponent.color}: "+
+           "#{game.opponent.successful_invasions}"
+
+      print "#{game.active_player.color}:#{game.active_player.reserves} > "
+
+      begin
+        move = yield
+
+        if move[/resign/i]
+          throw :game_over, "#{game.active_player.color} resigned"
+        else
+          client.play(move)
+        end
+      rescue StackWars::Errors::ParseError
+        puts "invalid command, press enter to continue"
+        gets
+      rescue StackWars::Errors::IllegalMove
+        puts "that move is illegal, press enter to continue"
+        gets
+      end
+    end
+  end
+
+  puts field
+  puts message
+end
+
+case ARGV[0]
+when "rules"
+  system("less #{File.dirname(__FILE__)}/../RULES.txt")
+when "demo"
+  file = "#{File.dirname(__FILE__)}/../example/sample-moves.txt"
+  moves = File.foreach(file) 
+  play_game do
+    move = moves.next 
+    puts "#{move}\nhit enter to continue"
+    $stdin.gets
+    move
+  end
+else
+  play_game { $stdin.gets }
+end

data/example/sample-moves.txt

@@ -0,0 +1,190 @@
+3 8
+6 0
+6 8
+6 0 6 1
+6 8 6 7
+6 1 6 2
+6 7 6 6
+6 2 6 3
+6 6 6 5
+6 3
+6 5
+6 3 6 4
+6 5 5 5
+6 4 7 4
+6 5 6 6
+7 4 7 5
+5 5
+7 5
+5 5 5 6 
+7 5 7 6
+7 8
+6 3 7 3
+8 8
+7 3 7 4
+8 8
+7 4 8 4
+8 8 8 7
+8 4 8 5
+5 5 5 4
+8 5
+7 8 7 7
+8 5 8 6
+7 7 7 6
+8 6 7 6
+5 4 5 3
+8 5
+5 3 5 2
+8 5 8 6
+5 2
+7 6 6 6
+5 2 5 1
+6 6 5 6
+4 8 
+7 5
+5 8
+7 5 7 6
+5 2
+7 6
+8 7 7 7
+7 6 6 6
+7 8
+6 6
+6 8
+5 6
+5 8 5 7
+5 6 4 6
+5 8
+4 6
+5 1 5 0
+4 6 3 6
+5 2 5 1
+3 6
+5 2
+3 6 3 7
+5 1 5 0
+3 7 3 8
+3 8
+3 6
+5 8 5 7
+3 6 3 7
+5 7 5 8
+3 7 3 8
+3 8
+5 0
+6 8 6 7
+7 6 7 7
+7 8 7 7
+5 6 5 7
+5 8 5 7
+6 6 5 6
+5 7 5 6
+6 6 5 6
+5 2 4 2
+4 6
+4 8 4 7
+4 6 3 6
+4 7 4 6
+5 6 4 6
+3 8 3 7
+3 6 2 6
+4 2 4 1
+3 6 3 7
+3 8
+2 6 2 7
+3 8 3 7
+2 7 3 7
+4 8
+4 6
+6 7 5 7
+4 6 5 6
+5 8
+3 7
+3 8
+3 7 3 6
+5 2
+8 6
+5 2 4 2
+8 6 7 6
+7 8
+3 6
+3 8 3 7
+3 6 2 6
+3 7 3 6
+2 6 3 6
+3 8
+7 5
+4 2
+7 5 6 5
+4 1 4 0
+4 0
+4 2 4 1
+4 0 4 1
+4 2 4 1
+6 5 6 6
+6 8
+6 6
+6 8 6 7
+6 6 6 5
+5 2 5 1
+5 0 5 1
+4 1 5 1
+3 6
+4 8 4 7
+4 6 4 7
+5 7 4 7
+3 6 2 6
+2 8
+2 6
+2 8 2 7
+2 6 1 6
+2 7 2 6
+1 6 2 6
+3 8 3 7
+3 6 2 6
+3 7 2 7
+2 6 1 6
+2 7 2 6
+1 6 2 6
+4 7 3 7
+2 6
+3 7 2 7
+2 6 1 6
+2 7 2 6
+1 6 2 6
+5 8 5 7
+2 6 2 7
+5 7 4 7
+2 7
+4 7 3 7
+2 7 1 7
+3 7 2 7
+1 7 2 7
+7 8 6 8
+2 7
+6 8 5 8
+2 7
+5 8 4 8
+2 7 2 8
+4 8 3 8
+2 7 2 8
+5 1 5 0
+7 6 7 7
+6 7 7 7
+2 7 2 8
+3 8 3 7
+5 6 5 7
+3 7 3 6
+5 7 5 8
+3 6 4 6
+7 5 7 6
+7 7 7 8
+6 6 6 7
+4 6 5 6
+6 5 6 6
+5 6 6 6
+7 6 6 6
+7 8 7 7
+6 7 7 7
+8 8 8 7
+8 6 8 7

data/example/sample_game.rb

@@ -0,0 +1,31 @@
+require_relative "../lib/stack_wars"
+
+field = StackWars::Battlefield.new
+game  = StackWars::Game.new(field)
+moves = File.foreach("#{File.dirname(__FILE__)}/sample-moves.txt")
+
+client = StackWars::TextClient.new(game)
+
+message = catch(:game_over) do
+  loop do
+    system "clear"
+    puts field
+
+    puts
+    puts "Current Score: #{game.active_player.color}: "+
+         "#{game.active_player.successful_invasions}, "+
+         "#{game.opponent.color}: "+
+         "#{game.opponent.successful_invasions}"
+
+    command = moves.next
+    print "#{game.active_player.color}:#{game.active_player.reserves} > #{command}"
+    client.play(command)
+
+
+    puts "hit enter to continue"
+    gets
+  end
+end
+
+puts field
+puts message