Skip to content
A PHP library for all things Minecraft: Java Edition.
PHP C++
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

Phpcraft Build Status

A PHP library for all things Minecraft: Java Edition.

Prerequisites

You'll need PHP (CLI), Composer, and Git.

Instructions

  • Debian: apt-get -y install php-cli composer git
  • Windows:
    1. Install Cone, which will install the latest PHP with it.
    2. Run cone get composer as administrator.
    3. Install Git for Windows.

Table of Contents

Using Phpcraft as a library

Thanks to Composer, using Phpcraft as a library is really easy. Just head into your project folder and run:

composer require craft/core --no-suggest --ignore-platform-reqs

Next, we'll run a self check:

php vendor/craft/core/selfcheck.php

If any dependencies are missing, follow the instructions, and then run the self check again.

Finally, you can require "vendor/autoload.php"; to use Phpcraft's many APIs.

In addition to the CLI utilities above and the "Projects using Phpcraft" section below serving up great example code, there's also the docs and wiki for you to read.

Modules

You can use modules to extend the functionality of Phpcraft:

Projects using Phpcraft

Thanks

  • Thanks to wiki.vg and the people who're maintaining it.
  • Thanks to Jetbrains for providing me with an open-source license for PhpStorm — it's a lovely PHP IDE, and made working on this project much easier.

Phpcraft is not partnered or associated with Microsoft or Mojang.

You can’t perform that action at this time.