minecraft_api 0.0.1

data/.gitignore

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

data/README.md

@@ -0,0 +1,4 @@
+minecraft_api
+==================
+
+An API for the Raspberry Pi version of minecraft

data/lib/block_type.rb

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

data/lib/minecraft_api.rb

@@ -0,0 +1,79 @@
+require 'socket'
+require 'io/wait'
+
+class MinecraftApi
+
+  def initialize(host = 'localhost', port = 4711)
+    @socket = TCPSocket.new host, port
+  end
+
+  # The other api's have a method like this
+  # I haven't seen it be invoked yet. Perhaps it is not needed
+  def drain()
+    while @socket.ready?
+      puts "**** READ A CHARACTER [#{@socket.gets}]"
+    end
+  end
+
+  def send(data)
+    drain()
+    @socket.puts "#{data}"
+  end
+
+  def send_and_receive(data)
+    send(data)
+    @socket.gets.chomp
+  end
+
+  def get_block_type(x,y,z)
+    response = send_and_receive("world.getBlock(#{x},#{y},#{z})")
+    BlockType.find(response.to_i) 
+  end
+
+  def set_block(x,y,z,block_type)
+    send("world.setBlock(#{x},#{y},#{z},#{block_type.id})")
+  end
+
+  def set_blocks(x1,y1,z1,x2,y2,z2,block_type)
+    send("world.setBlocks(#{x1},#{y1},#{z1},#{x2},#{y2},#{z2},#{block_type.id})")
+  end
+
+  def get_height(x,z)
+    send_and_receive("world.getHeight(#{x},#{z})").to_i
+  end
+
+  def checkpoint_save
+    send("word.checkpoint.save()")
+  end
+
+  def checkpoint_restore
+    send("word.checkpoint.restore()")
+  end
+
+  def chat_post(message)
+    send("chat.post(#{message})")
+  end
+
+  def camera_mode(mode,x=nil,y=nil,z=nil)
+    case mode
+    when :normal then send("camera.mode.setNormal()")
+    when :third_person then send("camera.mode.setThirdPerson()")
+    when :fixed then send("camera.mode.setFixed()")
+    when :position then send("camera.mode.setPos(#{x},#{y},#{z})")
+    else raise RuntimeError.new("valid camera settings are: :normal, :third_person, :fixed, and :position")
+    end
+  end
+
+  def player_set_tile(x,y,z)
+    send("player.setTile(#{x},#{y},#{z})")
+  end
+
+  def player_get_tile
+    response = send_and_receive("player.getTile()")
+    response.split(',').map { |s| s.to_i }
+  end    
+
+  def close
+    @socket.close
+  end
+end

data/minecraft_api.gemspec

@@ -0,0 +1,12 @@
+$:.push File.expand_path("../lib", __FILE__)
+Gem::Specification.new do |s|
+  s.name          = 'minecraft_api'
+  s.description   = 'An API for the Raspberry Pi version of Minecraft'
+  s.version       = '0.0.1'
+  s.date          = '2013-01-25'
+  s.summary       = 'Minecraft API'
+  s.homepage      = 'https://github.com/nhajratw/minecraft_api'
+  s.authors       = ["Nayan Hajratwala"]
+  s.email         = ["nayan@chikli.com"]
+  s.files         = `git ls-files`.split("\n")
+end

data/spec/block_type_spec.rb

@@ -0,0 +1,10 @@
+require 'block_type'
+
+describe 'BlockType' do
+
+  it 'is equivalent to another block type with the same id' do
+    bt1 = BlockType.new(0)
+    bt2 = BlockType.new(0)
+    bt1.should eq(bt2)
+  end
+end

data/spec/minecraft_api_spec.rb

@@ -0,0 +1,92 @@
+require 'minecraft_api'
+
+describe "Minecraft server" do
+
+  before(:each) do
+    @mcapi = MinecraftApi.new('10.0.1.129', 4711)
+  end
+
+  after(:each) do
+    @mcapi.close
+  end
+
+  it "returns a 'Fail' when a bad command is sent" do
+    response = @mcapi.send_and_receive 'junk'
+    response.should eq('Fail')
+  end
+
+  it "can create a block" do
+    @mcapi.set_block(0,0,0,BlockType::WOOD)
+    block_type = @mcapi.get_block_type(0,0,0)
+    block_type.should eq(BlockType::WOOD)
+  end
+
+  it "can create a block of a different type" do
+    @mcapi.set_block(0,0,0,BlockType::SAND)
+    block_type = @mcapi.get_block_type(0,0,0)
+    block_type.should eq(BlockType::SAND)
+  end
+
+  it "can create multiple blocks" do
+    @mcapi.set_blocks(0,0,0,2,2,2,BlockType::SAND)
+    # need to figure out assertion here.
+    # The assertions on each vector come too fast and end up returning
+    # types of 0.
+  end
+
+  it "can get the height of the world" do
+    y = @mcapi.get_height(5,5)
+    y.should eq(2)
+  end
+
+  it "can checkpoint save" do
+    @mcapi.checkpoint_save
+  end
+
+  it "can checkpoint restore" do
+    @mcapi.checkpoint_restore
+  end
+
+  it "can send chats" do
+    @mcapi.chat_post("hello")
+  end
+
+  describe "Camera API" do
+    it "can be set to normal" do
+      @mcapi.camera_mode(:normal)
+    end
+
+    it "can be set to third person" do
+      @mcapi.camera_mode(:third_person)
+    end
+
+    it "can be set to fixed" do
+      @mcapi.camera_mode(:fixed)
+    end
+
+    it "can be set to a certain position" do
+      @mcapi.camera_mode(:position,10,20,30)
+    end
+
+    it "throws an error when an invalid mode is specified" do
+      expect {
+        @mcapi.camera_mode(:fake)
+      }.to raise_error(RuntimeError, "valid camera settings are: :normal, :third_person, :fixed, and :position")
+    end
+  end
+
+  describe "Player API" do
+    it "can put the player on a particular tile" do
+      @mcapi.player_set_tile(20,40,60)
+      vector = @mcapi.player_get_tile
+      vector.should eq([20,40,60])
+    end
+
+    it "can put the player somewhere else" do
+      @mcapi.player_set_tile(-5,10,15)
+      vector = @mcapi.player_get_tile
+      vector.should eq([-5,10,15])
+    end
+  end
+
+end

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: minecraft_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Nayan Hajratwala
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-25 00:00:00.000000000 Z
+dependencies: []
+description: An API for the Raspberry Pi version of Minecraft
+email:
+- nayan@chikli.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- README.md
+- lib/block_type.rb
+- lib/minecraft_api.rb
+- minecraft_api.gemspec
+- spec/block_type_spec.rb
+- spec/minecraft_api_spec.rb
+homepage: https://github.com/nhajratw/minecraft_api
+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 API
+test_files: []