minecraft-pi 0.12.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d5b5ed60a8685816376d1654eacbaf8f0ac0ba03
+  data.tar.gz: d18b7763ab930175507706c5551cd96ef3357f14
+SHA512:
+  metadata.gz: 1c5eedd31aa445c81a61361735a3108c6bf1944836b86a3a2535a239ace1ad244f03aeff91998ae0beafbb60e65a57784474bef1018ac7a28f17b5ab3159cd23
+  data.tar.gz: b31bef5c294e7f7e71cfc7de25f13b79040138714d9006c88b89d7b1643290107725866a33cb8547ac570de9f24faf33feb06bce210adbc4b55dd830ec0d549f

data/.gitignore

@@ -0,0 +1,54 @@
+
+# Created by https://www.gitignore.io/api/ruby
+
+### Ruby ###
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/LICENSE.txt

@@ -0,0 +1,21 @@
+
+The MIT License (MIT)
+Copyright © 2016 Chris Olstrom <chris@olstrom.com>
+
+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.org

@@ -0,0 +1,56 @@
+#+TITLE: minecraft-pi
+#+LATEX: \pagebreak
+
+* Overview
+
+  ~minecraft-pi~ is a low-level interface to the Minecraft Pi Edition API for
+  Ruby. It covers the known API, and should map directly to the documentation
+  included with MCPI (minus the bits that are python-specific).
+
+* Notable Features
+
+  - All methods have =Contracts= defined, and conform to them.
+  - Where appropriate, most methods have automatic retry behaviour.
+  - The undocumented =Entity= API is supported, making it easier to work with multiplayer sessions.
+
+* Supported Versions
+
+  ~minecraft-pi~ is tested with the official =0.1.1= release, and the unofficial =0.6.1= patches.
+
+* Installation
+
+  #+BEGIN_SRC shell
+    gem install minecraft-pi
+  #+END_SRC
+
+* Usage
+
+  The following code will set the block at the host player's feet to pink wool:
+
+  #+BEGIN_SRC ruby
+    require 'minecraft-pi'
+
+    mc = MinecraftPi::Client.new
+
+    x, y, z = mc.player.getPos
+
+    mc.world.setBlockWithData x, y-1, z, 35, 6
+  #+END_SRC
+
+  See the [[https://colstrom.github.io/minecraft-pi/doc/][documentation]] for more information.
+
+* Known Issues
+
+  - =EventsBlock#hits= has been observed to cause crashes with some patched
+    versions of MCPI. This has been observed on a client with community-provided
+    patches applied, enabling surivival mode and fullscreen support. This does
+    not occur with the official =0.1.1= release.
+
+* License
+
+  The ~minecraft-pi~ gem is available under the [[https://tldrlegal.com/license/mit-license][MIT License]]. See ~LICENSE.txt~
+  for the full text.
+
+* Contributors
+
+  - [[https://colstrom.github.io/][Chris Olstrom]] | [[mailto:chris@olstrom.com][e-mail]] | [[https://twitter.com/ChrisOlstrom][Twitter]]

data/lib/minecraft-pi.rb

@@ -0,0 +1,12 @@
+require_relative 'minecraft-pi/camera'
+require_relative 'minecraft-pi/camera_mode'
+require_relative 'minecraft-pi/chat'
+require_relative 'minecraft-pi/client'
+require_relative 'minecraft-pi/entity'
+require_relative 'minecraft-pi/error'
+require_relative 'minecraft-pi/events'
+require_relative 'minecraft-pi/events_block'
+require_relative 'minecraft-pi/player'
+require_relative 'minecraft-pi/socket'
+require_relative 'minecraft-pi/world'
+require_relative 'minecraft-pi/world_checkpoint'

data/lib/minecraft-pi/camera.rb

@@ -0,0 +1,26 @@
+require 'contracts'
+require_relative 'socket'
+require_relative 'camera_mode'
+
+module MinecraftPi
+  class Camera
+    include ::Contracts::Core
+    include ::Contracts::Builtin
+
+    Contract Socket => Camera
+    def initialize(socket)
+      @socket = socket
+      self
+    end
+
+    Contract None => CameraMode
+    def mode
+      @mode ||= CameraMode.new @socket
+    end
+
+    Contract RespondTo[:to_f], RespondTo[:to_f], RespondTo[:to_f] => nil
+    def setPos(x, y, z)
+      @socket.write "camera.setPos(#{x.to_f},#{y.to_f},#{z.to_f})"
+    end
+  end
+end

data/lib/minecraft-pi/camera_mode.rb

@@ -0,0 +1,30 @@
+require 'contracts'
+require_relative 'socket'
+
+module MinecraftPi
+  class CameraMode
+    include ::Contracts::Core
+    include ::Contracts::Builtin
+
+    Contract Socket => CameraMode
+    def initialize(socket)
+      @socket = socket
+      self
+    end
+
+    Contract RespondTo[:to_i] => nil
+    def setNormal(entity)
+      @socket.write "camera.mode.setNormal(#{entity.to_i})"
+    end
+
+    Contract RespondTo[:to_i] => nil
+    def setFollow(entity)
+      @socket.write "camera.mode.setFollow(#{entity.to_i})"
+    end
+
+    Contract None => nil
+    def setFixed
+      @socket.write 'camera.mode.setFixed()'
+    end
+  end
+end

data/lib/minecraft-pi/chat.rb

@@ -0,0 +1,20 @@
+require 'contracts'
+require_relative 'socket'
+
+module MinecraftPi
+  class Chat
+    include ::Contracts::Core
+    include ::Contracts::Builtin
+
+    Contract Socket => Chat
+    def initialize(socket)
+      @socket = socket
+      self
+    end
+
+    Contract RespondTo[:to_s] => nil
+    def post(message)
+      @socket.write "chat.post(#{message})"
+    end
+  end
+end

data/lib/minecraft-pi/client.rb

@@ -0,0 +1,60 @@
+require 'contracts'
+require_relative 'camera'
+require_relative 'chat'
+require_relative 'entity'
+require_relative 'events'
+require_relative 'player'
+require_relative 'socket'
+require_relative 'world'
+
+module MinecraftPi
+  class Client
+    include ::Contracts::Core
+    include ::Contracts::Builtin
+
+    Contract KeywordArgs[
+               address: Optional[RespondTo[:to_s]],
+               port: Optional[RespondTo[:to_i]]
+             ] => Client
+    def initialize(address: 'localhost', port: 4711)
+      @address = address.to_s
+      @port = port.to_i
+      self
+    end
+
+    Contract None => Socket
+    def socket
+      @socket ||= Socket.new(address: @address, port: @port)
+    end
+
+    Contract None => Camera
+    def camera
+      @camera ||= Camera.new socket
+    end
+
+    Contract None => Chat
+    def chat
+      @chat ||= Chat.new socket
+    end
+
+    Contract None => Entity
+    def entity
+      @entity ||= Entity.new socket
+    end
+
+    Contract None => Events
+    def events
+      @events ||= Events.new socket
+    end
+
+    Contract None => Player
+    def player
+      @player ||= Player.new socket
+    end
+
+    Contract None => World
+    def world
+      @world ||= World.new socket
+    end
+  end
+end

data/lib/minecraft-pi/entity.rb

@@ -0,0 +1,43 @@
+require 'contracts'
+require_relative 'socket'
+
+module MinecraftPi
+  class Entity
+    include ::Contracts::Core
+    include ::Contracts::Builtin
+
+    Contract Socket => Entity
+    def initialize(socket)
+      @socket = socket
+      self
+    end
+
+    Contract RespondTo[:to_i] => ArrayOf[Float]
+    def getPos(entity)
+      @socket
+        .request("entity.getPos(#{entity.to_i})")
+        .split(',')
+        .map(&:to_f)
+    end
+
+    Contract RespondTo[:to_i], RespondTo[:to_f], RespondTo[:to_f], RespondTo[:to_f] => nil
+    def setPos(entity, x, y, z)
+      @socket
+        .write("entity.setPos(#{entity.to_i},#{x.to_f},#{y.to_f},#{z.to_f})")
+    end
+
+    Contract RespondTo[:to_i] => ArrayOf[Fixnum]
+    def getTile(entity)
+      @socket
+        .request("entity.getTile(#{entity.to_i})")
+        .split(',')
+        .map(&:to_i)
+    end
+
+    Contract RespondTo[:to_i], RespondTo[:to_i], RespondTo[:to_i], RespondTo[:to_i] => nil
+    def setTile(entity, x, y, z)
+      @socket
+        .write("entity.setTile(#{entity.to_i},#{x.to_i},#{y.to_i},#{z.to_i})")
+    end
+  end
+end

data/lib/minecraft-pi/error.rb

@@ -0,0 +1,10 @@
+module MinecraftPi
+  class Error < ::RuntimeError
+  end
+
+  class FailError < Error
+  end
+
+  class SetBlockError < Error
+  end
+end

data/lib/minecraft-pi/events.rb

@@ -0,0 +1,26 @@
+require 'contracts'
+require_relative 'events_block'
+require_relative 'socket'
+
+module MinecraftPi
+  class Events
+    include ::Contracts::Core
+    include ::Contracts::Builtin
+
+    Contract Socket => Events
+    def initialize(socket)
+      @socket = socket
+      self
+    end
+
+    Contract None => EventsBlock
+    def block
+      @block ||= EventsBlock.new @socket
+    end
+
+    Contract None => nil
+    def clear
+      @socket.write 'events.clear()'
+    end
+  end
+end

data/lib/minecraft-pi/events_block.rb

@@ -0,0 +1,23 @@
+require 'contracts'
+require_relative 'socket'
+
+module MinecraftPi
+  class EventsBlock
+    include ::Contracts::Core
+    include ::Contracts::Builtin
+
+    Contract Socket => EventsBlock
+    def initialize(socket)
+      @socket = socket
+      self
+    end
+
+    Contract None => ArrayOf[ArrayOf[Fixnum]]
+    def hits
+      @socket
+        .request('events.block.hits()')
+        .split('|')
+        .map { |event| event.split(',').map(&:to_i) }
+    end
+  end
+end

data/lib/minecraft-pi/player.rb

@@ -0,0 +1,41 @@
+require 'contracts'
+require_relative 'socket'
+
+module MinecraftPi
+  class Player
+    include ::Contracts::Core
+    include ::Contracts::Builtin
+
+    Contract Socket => Player
+    def initialize(socket)
+      @socket = socket
+      self
+    end
+
+    Contract None => ArrayOf[Float]
+    def getPos
+      @socket
+        .request('player.getPos()')
+        .split(',')
+        .map(&:to_f)
+    end
+
+    Contract RespondTo[:to_f], RespondTo[:to_f], RespondTo[:to_f] => nil
+    def setPos(x, y, z)
+      @socket.write "player.setPos(#{x.to_f},#{y.to_f},#{z.to_f})"
+    end
+
+    Contract None => ArrayOf[Fixnum]
+    def getTile
+      @socket
+        .request('player.getTile()')
+        .split(',')
+        .map(&:to_i)
+    end
+
+    Contract RespondTo[:to_i], RespondTo[:to_i], RespondTo[:to_i] => nil
+    def setTile(x, y, z)
+      @socket.write "player.setTile(#{x.to_i},#{y.to_i},#{z.to_i})"
+    end
+  end
+end

data/lib/minecraft-pi/socket.rb

@@ -0,0 +1,44 @@
+require 'contracts'
+require 'socket'
+require_relative 'error'
+
+module MinecraftPi
+  class Socket
+    include ::Contracts::Core
+    include ::Contracts::Builtin
+
+    Contract KeywordArgs[
+               address: Optional[RespondTo[:to_s]],
+               port: Optional[RespondTo[:to_i]]
+             ] => Socket
+    def initialize(address: 'localhost', port: 4711)
+      @socket = ::TCPSocket.new address.to_s, port.to_i
+      self
+    end
+
+    Contract RespondTo[:to_s] => nil
+    def write(message)
+      message.to_s.tap do |m|
+        STDERR.puts m
+        @socket.puts m
+      end
+      nil
+    end
+
+    Contract None => String
+    def read
+      @socket.gets.chomp.tap { |reply| STDERR.puts "=> #{reply}" }
+    end
+
+    Contract RespondTo[:to_s], Maybe[RespondTo[:to_i]] => String
+    def request(message, attempt = 1)
+      write message.to_s
+      read.tap { |reply| raise FailError if reply == 'Fail' }
+
+    rescue FailError
+      STDERR.puts "retry #{attempt}"
+      sleep 0.1
+      request(message, attempt.to_i + 1)
+    end
+  end
+end

data/lib/minecraft-pi/world.rb

@@ -0,0 +1,78 @@
+require 'contracts'
+require_relative 'error'
+require_relative 'socket'
+require_relative 'world_checkpoint'
+
+module MinecraftPi
+  class World
+    include ::Contracts::Core
+    include ::Contracts::Builtin
+
+    Contract Socket => World
+    def initialize(socket)
+      @socket = socket
+      self
+    end
+
+    Contract None => WorldCheckpoint
+    def checkpoint
+      @checkpoint ||= WorldCheckpoint.new @socket
+    end
+
+    # TODO: Should return a collection
+    def getPlayerIds
+      @socket.request 'world.getPlayerIds()'
+    end
+
+    Contract RespondTo[:to_i], RespondTo[:to_i], RespondTo[:to_i] => Fixnum
+    def getBlock(x, y, z)
+      @socket.request("world.getBlock(#{x.to_i},#{y.to_i},#{z.to_i})").to_i
+    end
+
+    Contract RespondTo[:to_i], RespondTo[:to_i], RespondTo[:to_i] => ArrayOf[Fixnum]
+    def getBlockWithData(x, y, z)
+      @socket
+        .request("world.getBlockWithData(#{x.to_i},#{y.to_i},#{z.to_i})")
+        .split(',')
+        .map(&:to_i)
+    end
+
+    Contract RespondTo[:to_i], RespondTo[:to_i], RespondTo[:to_i], RespondTo[:to_i], RespondTo[:to_i] => nil
+    def setBlock(x, y, z, id, attempt = 1)
+      @socket.write "world.setBlock(#{x.to_i},#{y.to_i},#{z.to_i},#{id.to_i})"
+      raise SetBlockError if getBlock(x, y, z) != id
+    rescue SetBlockError
+      STDERR.puts "retry #{attempt}"
+      setBlock(x, y, z, id, attempt.to_i + 1)
+    end
+
+    Contract RespondTo[:to_i], RespondTo[:to_i], RespondTo[:to_i], RespondTo[:to_i], RespondTo[:to_i], RespondTo[:to_i] => nil
+    def setBlockWithData(x, y, z, id, data, attempt = 1)
+      @socket.write "world.setBlock(#{x.to_i},#{y.to_i},#{z.to_i},#{id.to_i},#{data.to_i})"
+      raise SetBlockError if getBlockWithData(x, y, z) != [id.to_i, data.to_i]
+    rescue SetBlockError
+      STDERR.puts "retry #{attempt}"
+      setBlockWithData(x, y, z, id, data, attempt.to_i + 1)
+    end
+
+    Contract RespondTo[:to_i], RespondTo[:to_i], RespondTo[:to_i], RespondTo[:to_i], RespondTo[:to_i], RespondTo[:to_i], RespondTo[:to_i] => nil
+    def setBlocks(x1, y1, z1, x2, y2, z2, id)
+      @socket.write "world.setBlocks(#{x1},#{y1},#{z1},#{x2},#{y2},#{z2},#{id})"
+    end
+
+    Contract RespondTo[:to_i], RespondTo[:to_i], RespondTo[:to_i], RespondTo[:to_i], RespondTo[:to_i], RespondTo[:to_i], RespondTo[:to_i], RespondTo[:to_i] => nil
+    def setBlocksWithData(x1, y1, z1, x2, y2, z2, id, data)
+      @socket.write "world.setBlocks(#{x1.to_i},#{y1.to_i},#{z1.to_i},#{x2.to_i},#{y2.to_i},#{z2.to_i},#{id.to_i},#{data.to_i})"
+    end
+
+    Contract RespondTo[:to_i], RespondTo[:to_i] => Fixnum
+    def getHeight(x, z)
+      @socket.request("world.getHeight(#{x.to_i},#{z.to_i})").to_i
+    end
+
+    Contract Enum[:world_immutable, :nametags_visible], Bool => nil
+    def setting(setting, status)
+      @socket.write "world.setting(#{setting},#{status ? 1 : 0})"
+    end
+  end
+end

data/lib/minecraft-pi/world_checkpoint.rb

@@ -0,0 +1,25 @@
+require 'contracts'
+require_relative 'socket'
+
+module MinecraftPi
+  class WorldCheckpoint
+    include ::Contracts::Core
+    include ::Contracts::Builtin
+
+    Contract Socket => WorldCheckpoint
+    def initialize(socket)
+      @socket = socket
+      self
+    end
+
+    Contract None => nil
+    def save
+      @socket.write 'world.checkpoint.save()'
+    end
+
+    Contract None => nil
+    def restore
+      @socket.write 'world.checkpoint.restore()'
+    end
+  end
+end

data/minecraft-pi.gemspec

@@ -0,0 +1,16 @@
+Gem::Specification.new do |gem|
+  gem.name        = 'minecraft-pi'
+  gem.version     = `git describe --tags --abbrev=0`.chomp
+  gem.licenses    = 'MIT'
+  gem.authors     = ['Chris Olstrom']
+  gem.email       = 'chris@olstrom.com'
+  gem.homepage    = 'https://github.com/colstrom/minecraft-pi'
+  gem.summary     = 'Control Minecraft Pi Edition from Ruby'
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  gem.require_paths = ['lib']
+
+  gem.add_runtime_dependency 'contracts', '~> 0.14', '>= 0.14.0'
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: minecraft-pi
+version: !ruby/object:Gem::Version
+  version: 0.12.3
+platform: ruby
+authors:
+- Chris Olstrom
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: contracts
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+description: 
+email: chris@olstrom.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- LICENSE.txt
+- README.org
+- lib/minecraft-pi.rb
+- lib/minecraft-pi/camera.rb
+- lib/minecraft-pi/camera_mode.rb
+- lib/minecraft-pi/chat.rb
+- lib/minecraft-pi/client.rb
+- lib/minecraft-pi/entity.rb
+- lib/minecraft-pi/error.rb
+- lib/minecraft-pi/events.rb
+- lib/minecraft-pi/events_block.rb
+- lib/minecraft-pi/player.rb
+- lib/minecraft-pi/socket.rb
+- lib/minecraft-pi/world.rb
+- lib/minecraft-pi/world_checkpoint.rb
+- minecraft-pi.gemspec
+homepage: https://github.com/colstrom/minecraft-pi
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Control Minecraft Pi Edition from Ruby
+test_files: []
+has_rdoc: