minecraft-pi-ruby 0.0.1

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/README.md

@@ -0,0 +1,142 @@
+#Minecraft-Pi Ruby
+
+##Please note
+This project is still in the early stages of development. It is not ready for use
+with students and has not yet been pushed to RubyGems.
+
+##Overview
+
+This is a Ruby gem to allow access to the Minecraft Pi Edition API from Ruby.
+The aim is that the syntax is clear for fledgling coders to read and
+understand as they work towards creating their own scripts.
+
+All the fun of Minecraft Pi Edition and all the goodness of Ruby! With Sonic Pi, 
+KidsRuby and Minecraft, there really is no reason not to show you students the 
+joy of Ruby programming!
+
+##Introduction
+The Pi Edition of Minecraft needs to be running for the gem to make a connection. Then you can use Ruby 
+code such as:
+```
+Minecraft.world do
+  say "Hello from Ruby!"
+    
+  position1 = Position.new(0,10,0)
+  position2 = Position.new(10,20,10)
+  make_cuboid(position1, position2, Block::DIAMOND_BLOCK)
+  sleep 2
+  make_cuboid(position1, position2, Block::AIR)
+  
+  10.times do |counter|
+    set_block(counter, 20, 0, Block::STONE)
+    set_block(counter, 20, 9, Block::STONE)
+    set_block(0, 20, counter, Block::STONE)
+    set_block(9, 20, counter, Block::STONE)
+  end
+  
+  say "Bye from Ruby!"  
+end
+```
+
+You can also instantiate a Minecraft object instead of writing script inside Ruby blocks.
+For example:
+```
+mc = Minecraft.new
+mc.say 'Hello to Steve!'
+mc.make_cuboid(16,18,16,20,20,20,Block::TNT,1)
+mc.say 'Now go and click on the TNT!'
+```
+##Installation
+
+TODO
+
+##Usage
+
+So far, only the following commands have been implemented
+
+- `say "message"` to display a message on the screen
+- `set_camera_mode` to either `:fixed`, `:normal` or `:follow` 
+- `set_block` takes 3 values for the x, y and z location, or a Position (`Position.new(x,y,z)`)
+- `set_blocks` is the same as `make_cuboid`. It takes 2 Positions and an ID for the block (see below), or 
+two sets of x,y,z coordinates followed by the block ID. For example: `make_cuboid(0,0,0,20,20,20,Block::OBSIDIAN)`.
+- `get_ground_height(x,z)` or just `ground_height(x,z)` return the height of the ground at the (x,z) location
+- `set_player_position(x,y,z)` or `set_player_position(Position)` moves the player to that position
+
+###Block IDs
+
+Blocks can be set using and ID in the form Block::NAME. For example Block::TNT.
+
+The blocks are:
+
+-  AIR                 numerical value is 0
+-  STONE               numerical value is 1
+-  GRASS               numerical value is 2
+-  DIRT                numerical value is 3
+-  COBBLESTONE         numerical value is 4
+-  WOOD_PLANKS         numerical value is 5
+-  SAPLING             numerical value is 6
+-  BEDROCK             numerical value is 7
+-  WATER_FLOWING       numerical value is 8
+-  WATER               numerical value is WATER_FLOWING
+-  WATER_STATIONARY    numerical value is 9
+-  LAVA_FLOWING        numerical value is 10
+-  LAVA                numerical value is LAVA_FLOWING
+-  LAVA_STATIONARY     numerical value is 11
+-  SAND                numerical value is 12
+-  GRAVEL              numerical value is 13
+-  GOLD_ORE            numerical value is 14
+-  IRON_ORE            numerical value is 15
+-  COAL_ORE            numerical value is 16
+-  WOOD                numerical value is 17
+-  LEAVES              numerical value is 18
+-  GLASS               numerical value is 20
+-  LAPIS_LAZULI_ORE    numerical value is 21
+-  LAPIS_LAZULI_BLOCK  numerical value is 22
+-  SANDSTONE           numerical value is 24
+-  BED                 numerical value is 26
+-  COBWEB              numerical value is 30
+-  GRASS_TALL          numerical value is 31
+-  WOOL                numerical value is 35
+-  FLOWER_YELLOW       numerical value is 37
+-  FLOWER_CYAN         numerical value is 38
+-  MUSHROOM_BROWN      numerical value is 39
+-  MUSHROOM_RED        numerical value is 40
+-  GOLD_BLOCK          numerical value is 41
+-  IRON_BLOCK          numerical value is 42
+-  STONE_SLAB_DOUBLE   numerical value is 43
+-  STONE_SLAB          numerical value is 44
+-  BRICK_BLOCK         numerical value is 45
+-  TNT                 numerical value is 46
+-  BOOKSHELF           numerical value is 47
+-  MOSS_STONE          numerical value is 48
+-  OBSIDIAN            numerical value is 49
+-  TORCH               numerical value is 50
+-  FIRE                numerical value is 51
+-  STAIRS_WOOD         numerical value is 53
+-  CHEST               numerical value is 54
+-  DIAMOND_ORE         numerical value is 56
+-  DIAMOND_BLOCK       numerical value is 57
+-  CRAFTING_TABLE      numerical value is 58
+-  FARMLAND            numerical value is 60
+-  FURNACE_INACTIVE    numerical value is 61
+-  FURNACE_ACTIVE      numerical value is 62
+-  DOOR_WOOD           numerical value is 64
+-  LADDER              numerical value is 65
+-  STAIRS_COBBLESTONE  numerical value is 67
+-  DOOR_IRON           numerical value is 71
+-  REDSTONE_ORE        numerical value is 73
+-  SNOW                numerical value is 78
+-  ICE                 numerical value is 79
+-  SNOW_BLOCK          numerical value is 80
+-  CACTUS              numerical value is 81
+-  CLAY                numerical value is 82
+-  SUGAR_CANE          numerical value is 83
+-  FENCE               numerical value is 85
+-  GLOWSTONE_BLOCK     numerical value is 89
+-  BEDROCK_INVISIBLE   numerical value is 95
+-  STONE_BRICK         numerical value is 98
+-  GLASS_PANE          numerical value is 102
+-  MELON               numerical value is 103
+-  FENCE_GATE          numerical value is 107
+-  GLOWING_OBSIDIAN    numerical value is 246
+-  NETHER_REACTOR_CORE numerical value is 247

data/lib/blocks.rb

@@ -0,0 +1,74 @@
+module Block
+  AIR                 = 0
+  STONE               = 1
+  GRASS               = 2
+  DIRT                = 3
+  COBBLESTONE         = 4
+  WOOD_PLANKS         = 5
+  SAPLING             = 6
+  BEDROCK             = 7
+  WATER_FLOWING       = 8
+  WATER               = WATER_FLOWING
+  WATER_STATIONARY    = 9
+  LAVA_FLOWING        = 10
+  LAVA                = LAVA_FLOWING
+  LAVA_STATIONARY     = 11
+  SAND                = 12
+  GRAVEL              = 13
+  GOLD_ORE            = 14
+  IRON_ORE            = 15
+  COAL_ORE            = 16
+  WOOD                = 17
+  LEAVES              = 18
+  GLASS               = 20
+  LAPIS_LAZULI_ORE    = 21
+  LAPIS_LAZULI_BLOCK  = 22
+  SANDSTONE           = 24
+  BED                 = 26
+  COBWEB              = 30
+  GRASS_TALL          = 31
+  WOOL                = 35
+  FLOWER_YELLOW       = 37
+  FLOWER_CYAN         = 38
+  MUSHROOM_BROWN      = 39
+  MUSHROOM_RED        = 40
+  GOLD_BLOCK          = 41
+  IRON_BLOCK          = 42
+  STONE_SLAB_DOUBLE   = 43
+  STONE_SLAB          = 44
+  BRICK_BLOCK         = 45
+  TNT                 = 46
+  BOOKSHELF           = 47
+  MOSS_STONE          = 48
+  OBSIDIAN            = 49
+  TORCH               = 50
+  FIRE                = 51
+  STAIRS_WOOD         = 53
+  CHEST               = 54
+  DIAMOND_ORE         = 56
+  DIAMOND_BLOCK       = 57
+  CRAFTING_TABLE      = 58
+  FARMLAND            = 60
+  FURNACE_INACTIVE    = 61
+  FURNACE_ACTIVE      = 62
+  DOOR_WOOD           = 64
+  LADDER              = 65
+  STAIRS_COBBLESTONE  = 67
+  DOOR_IRON           = 71
+  REDSTONE_ORE        = 73
+  SNOW                = 78
+  ICE                 = 79
+  SNOW_BLOCK          = 80
+  CACTUS              = 81
+  CLAY                = 82
+  SUGAR_CANE          = 83
+  FENCE               = 85
+  GLOWSTONE_BLOCK     = 89
+  BEDROCK_INVISIBLE   = 95
+  STONE_BRICK         = 98
+  GLASS_PANE          = 102
+  MELON               = 103
+  FENCE_GATE          = 107
+  GLOWING_OBSIDIAN    = 246
+  NETHER_REACTOR_CORE = 247
+end

data/lib/connection.rb

@@ -0,0 +1,31 @@
+require 'socket'
+
+class Connection
+  def initialize (server = 'localhost', port = 4711)
+    begin
+      @socket = TCPSocket.new server, port
+    rescue
+      puts "Error connecting to Minecraft. Is it running?\n\n"
+      @socket.close if @socket
+      abort("#{$!}")
+    end
+  end
+  
+  def send_command(command)
+    if @socket
+      @socket.puts command
+    else
+      puts "Not connected to Minecraft Pi! Is it running?"
+    end
+  end
+  
+  def send_with_response(command)
+    send_command command
+    return @socket.gets.chomp
+  end
+  
+  
+  def Connection.finalize(id)
+    @socket.close if @socket
+  end
+end

data/lib/minecraft-pi-ruby.rb

@@ -0,0 +1,87 @@
+require_relative 'connection'
+require_relative 'position'
+require_relative 'blocks'
+
+class Minecraft
+  include Block
+  
+  def initialize(connection = nil)
+    @connection = connection
+    @connection ||= Connection.new
+  end
+
+  class << self
+    def control(&script)
+      mc = self.new
+      mc.instance_eval(&script)
+    end
+    
+    alias_method :world, :control
+  end
+  
+  def say(message)
+    @connection.send_command "chat.post(#{message})"
+  end
+  
+  def set_camera_mode(mode)
+    @connection.send_command 'camera.mode.setNormal' if mode == :normal
+    @connection.send_command 'camera.mode.setFixed' if mode == :fixed
+    @connection.send_command 'camera.mode.setFollow' if mode == :follow
+  end
+  
+  def set_block(*args)
+    command = "world.setBlock("
+    case args.length
+    when 2
+      command = command + "#{args[0]},#{args[1]})"
+    when 3
+      command += "#{args[0]},#{args[1]},#{args[2]})"
+    when 4
+      command += "#{args[0]},#{args[1]},#{args[2]},#{args[3]})"
+    when 5
+      command += "#{args[0]},#{args[1]},#{args[2]},#{args[3]},#{args[4]})"
+    else
+      return
+    end
+    @connection.send_command command
+  end
+  
+  def set_blocks(*args)
+    command = "world.setBlocks("
+    case args.length
+    when 3
+      command += "#{args[0]},#{args[1]},#{args[2]})"
+    when 4
+      command += "#{args[0]},#{args[1]},#{args[2]},#{args[3]})"
+    when 7
+      command += "#{args[0]},#{args[1]},#{args[2]},#{args[3]},#{args[4]},#{args[5]},#{args[6]})"
+    when 8
+      command += "#{args[0]},#{args[1]},#{args[2]},#{args[3]},#{args[4]},#{args[5]},#{args[6]},#{args[7]})"
+    else
+      return
+    end
+    @connection.send_command command
+  end
+  alias_method :make_cuboid, :set_blocks
+  
+  def get_ground_height(x,z)
+    return  @connection.send_with_response "world.getHeight(#{x},#{z})"
+    #return s
+  end
+  alias_method :ground_height, :get_ground_height
+  
+  def set_player_position(*args)
+    command = "player.setPos("
+    case args.length
+    when 1
+      command += "#{args[0].x},#{args[0].y},#{args[0].z})"
+    when 3
+      command += "#{args[0]},#{args[1]},#{args[2]})"
+    else
+      return
+    end
+    @connection.send_command command
+  end
+  
+end
+    

data/lib/position.rb

@@ -0,0 +1,52 @@
+class Position
+
+  attr_accessor :x, :y, :z
+  
+  def initialize (x,y,z)
+    @x=x
+    @y=y
+    @z=z
+  end
+
+  def to_s
+    "#{@x},#{@y},#{@z}"
+  end
+  
+  
+  def eql?(position)
+    self.class.equal?(position.class) &&
+      @x == position.x &&
+      @y == position.y &&
+      @z == position.z
+  end
+  alias == eql?
+  
+  def +(position)
+    @x+=position.x
+    @y+=position.y
+    @z+=position.z
+    self
+  end
+  
+  def -(position)
+    @x-=position.x
+    @y-=position.y
+    @z-=position.z
+    self
+  end
+
+  def *(scale)
+    if scale.is_a?(Numeric)
+      @x*=scale
+      @y*=scale
+      @z*=scale
+    elsif scale.is_a?(Position)
+      @x*=scale.x
+      @y*=scale.y
+      @z*=scale.z
+    end
+    
+    self
+  end
+
+end

data/minecraft-pi-ruby.gemspec

@@ -0,0 +1,12 @@
+$:.push File.expand_path("../lib", __FILE__)
+Gem::Specification.new do |s|
+	s.name = 'minecraft-pi-ruby'
+	s.description = 'Control Minecraft Pi Edition using the Ruby programming language.'
+	s.version = '0.0.1'
+	s.date = '2014-10-26'
+	s.summary = 'Minecraft Pi Edition Ruby'
+	s.homepage = 'https://github.com/eaglestone/minecraft-pi-ruby'
+	s.authors = ["Tim Eaglestone"]
+	s.email = ["tim.eaglestone@gmail.com"]
+	s.files = `git ls-files`.split("\n")
+end

data/test.rb

@@ -0,0 +1,29 @@
+require_relative "lib/minecraft-pi-ruby"
+
+Minecraft.world do
+  say "Hello from Ruby!"
+    
+  position1 = Position.new(0,10,0)
+  position2 = Position.new(10,20,10)
+  make_cuboid(position1, position2, Block::DIAMOND_BLOCK)
+  sleep 2
+  make_cuboid(position1, position2, Block::AIR)
+  
+  10.times do |counter|
+    set_block(counter, 20, 0, Block::STONE)
+    set_block(counter, 20, 9, Block::STONE)
+    set_block(0, 20, counter, Block::STONE)
+    set_block(9, 20, counter, Block::STONE)
+  end
+  
+  say "Bye from Ruby!"  
+end
+
+
+mc = Minecraft.new
+mc.say 'Hello to Steve!'
+mc.set_player_position(16,16,16)
+sleep 2
+mc.set_player_position(Position.new(28,18,28))
+mc.make_cuboid(16,18,16,20,20,20,Block::TNT,1)
+mc.say 'Now go and click on the TNT!'

data/test/minecraft_spec.rb

@@ -0,0 +1,63 @@
+require 'minitest/autorun'
+require_relative '../lib/minecraft-pi-ruby'
+require_relative '../lib/position'
+
+describe Minecraft do
+
+  before do
+    @conn = MiniTest::Mock.new
+    @mc = Minecraft.new(@conn)
+  end
+  
+  it "can be created" do
+    Minecraft.new.must_be_instance_of Minecraft
+  end
+  
+  it "can have control called on an instant of the class" do
+    Minecraft.must_respond_to 'control'
+  end
+  
+  it "responds to world being called on an instance" do
+    Minecraft.must_respond_to 'world'
+  end
+  
+  it "should call the cameraFollow API with the right protocol" do
+    @conn.expect :send_command, :return_value, ['camera.mode.setNormal']
+    @mc.set_camera_mode :normal
+        
+    assert @conn.verify
+  end
+  
+  it "should send the setBock(x,y,z,id) message" do
+    @conn.expect :send_command, :return_value, ['world.setBlock(1,2,3,4)']
+    @mc.set_block(1,2,3,4)
+    
+    assert @conn.verify
+  end
+  
+  it "should send the setBlock(x,y,z,id) message when called with a Position" do
+    @conn.expect :send_command, :return_value, ['world.setBlock(1,2,3,4)']
+    @mc.set_block(Position.new(1,2,3),4)
+    @conn.verify
+  end
+  
+  it "should handle the setBlocks with two positions given" do
+    @conn.expect :send_command, :return_value, ['world.setBlocks(0,0,0,10,10,10,1)']
+    @mc.set_blocks(Position.new(0,0,0),Position.new(10,10,10),1)
+    assert @conn.verify
+  end
+  
+  it "should handle setBlocks with individual coords" do
+    @conn.expect :send_command, :return_value, ['world.setBlocks(0,0,0,3,3,3,2)']
+    @mc.set_blocks(0,0,0,3,3,3,2)
+    assert @conn.verify
+  end
+  
+  it "gets the ground level" do
+    @conn.expect :send_with_response, 10, ['world.getHeight(4,5)']
+    height = @mc.get_ground_height(4,5)
+    assert @conn.verify
+    height.must_be_kind_of(Numeric)
+  end
+  
+end

data/test/position_spec.rb

@@ -0,0 +1,34 @@
+require 'minitest/autorun'
+require_relative '../lib/position'
+
+describe Position do
+  before do
+    @pos = Position.new(1,2,3)
+  end
+  it "initialises with 3 integers for x, y and z" do
+    @pos.x.must_equal 1
+    @pos.y.must_equal 2
+    @pos.z.must_equal 3
+  end    
+  
+  it "returns to_s in a format for sending to server" do
+    @pos.to_s.must_equal "1,2,3"
+  end
+  
+  it "is equal to another Position if the coords are the same" do
+    Position.new(1,2,3).must_equal @pos
+  end
+  
+  it "adds the dimensions with another position object" do
+    (@pos + @pos).must_equal Position.new(2,4,6)
+  end
+  
+  it "subtracts the dimensions with another position object" do
+    (@pos - @pos).must_equal Position.new(0,0,0)
+  end
+  
+  it "does scalar multiplication" do
+    (@pos*4).must_equal Position.new(4,8,12)
+  end
+
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: minecraft-pi-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Tim Eaglestone
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-26 00:00:00.000000000 Z
+dependencies: []
+description: Control Minecraft Pi Edition using the Ruby programming language.
+email:
+- tim.eaglestone@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- README.md
+- lib/blocks.rb
+- lib/connection.rb
+- lib/minecraft-pi-ruby.rb
+- lib/position.rb
+- minecraft-pi-ruby.gemspec
+- test.rb
+- test/minecraft_spec.rb
+- test/position_spec.rb
+homepage: https://github.com/eaglestone/minecraft-pi-ruby
+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.23
+signing_key: 
+specification_version: 3
+summary: Minecraft Pi Edition Ruby
+test_files: []