0.0
No commit activity in last 3 years
No release in over 3 years
Control Minecraft Pi Edition from Ruby
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Runtime

>= 0.14.0, ~> 0.14
 Project Readme

minecraft-pi

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

gem install minecraft-pi

Usage

The following code will set the block at the host player’s feet to pink wool:

require 'minecraft-pi'

mc = MinecraftPi::Client.new

x, y, z = mc.player.getPos

mc.world.setBlockWithData x, y-1, z, 35, 6

See the 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 MIT License. See LICENSE.txt for the full text.

Contributors