Skip to main content

High level Python framework for building Minecraft clients and bots

Project description

Build Status Docs Status Coverage Status

SpockBot currently supports Minecraft 1.8.8

Minecraft bot framework written in Python, currently under heavy development.

Client could loosely be called “event-driven”. By default plugins register handler functions to handle events that may or may not be emitted by other plugins. Everything is a plugin in SpockBot, including the event loop/framework itself, so you can feel free to rip out the entire back end and replace it with your framework or paradigm of choice. As long as you provide the same simple APIs, other plugins won’t know the difference.

We’re only just getting started with documentation so if you’re uncomfortable reading source code this might not be the framework for you. Or, better yet, hop on IRC and help us write some docs!

SpockBot officially supports Python 3.x and Python 2.7.x on *nix operating systems and requires cryptography. It also runs on Windows and under PyPy 2.6.x but that’s not regularly tested and could be broken at any given moment. If you support one of those use cases and SpockBot breaks for you, submit an issue with a stack trace and we’ll try to fix it.

Features

  • World Interaction (finding, placing, breaking)

  • Vanilla Physics

  • Pathfinding

  • Inventory (player, chests, etc)

  • Crafting

  • Entity Tracking

Dependencies

Installation

python3 setup.py install

Note: The cryptography library has some extra dependencies to install, you can find detailed instructions here.

Documentation

Current docs live here https://spockbot.readthedocs.org

Examples

Refer to the example bot for instructions on how to write a bot and a plugin that provides some common functionality.

Also see Extra examples and Bat bot for additional examples.

Projects Using SpockBot

Support

#spockbot on Freenode
gamingrobot or nickelpro in #mcdevs on Freenode

Contributing

Instructions for contributing to SpockBot can be found in CONTRIBUTING

Credits

Inspired by remyroy’s COPS, a Minecraft client in Python.

COPS was a service that tracked players on a minecraft server called Civcraft. It looked like this

Protocol implementation based on barneymc.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

spockbot-0.1.5.tar.gz (73.5 kB view details)

Uploaded Source

Built Distributions

spockbot-0.1.5-py3.4.egg (200.9 kB view details)

Uploaded Egg

spockbot-0.1.5-py2.py3-none-any.whl (81.8 kB view details)

Uploaded Python 2Python 3

File details

Details for the file spockbot-0.1.5.tar.gz.

File metadata

  • Download URL: spockbot-0.1.5.tar.gz
  • Upload date:
  • Size: 73.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for spockbot-0.1.5.tar.gz
Algorithm Hash digest
SHA256 6f82ed038cc408182c2a0a7066e927b441ec4114e92c6a610a2bdf3d1d6ad205
MD5 1b22ec0fc734023445de05f992bda545
BLAKE2b-256 f21429ece3b0f6b76540668fcfcf5dc968f3b28c5ef3f0188ecf37f495e15f29

See more details on using hashes here.

File details

Details for the file spockbot-0.1.5-py3.4.egg.

File metadata

  • Download URL: spockbot-0.1.5-py3.4.egg
  • Upload date:
  • Size: 200.9 kB
  • Tags: Egg
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for spockbot-0.1.5-py3.4.egg
Algorithm Hash digest
SHA256 d08a4ca0a6cdbe3140a4f5054261ff5c2087b04d17c815ebf7dcab97f803b96c
MD5 feffa346e0bc65eae4b4a939a27b4fed
BLAKE2b-256 41fa3823e692f5b3da4bffefcd13b910b1a0caa41ff150f3ab8925e780ff56c2

See more details on using hashes here.

File details

Details for the file spockbot-0.1.5-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for spockbot-0.1.5-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 4c6178e4bd1871758c2616b80ee5934ec015db1ee1cde336b799dc487957579b
MD5 951599d52f92d950737cde4a68b0673f
BLAKE2b-256 f96a29de707c6a9a61e57f0c9368bded11dd952944c2795989bb3fdb37f76fc1

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page