# ![ImagicalMine](http://i.imgur.com/6Hlm8mn.gif)

## Project Addons:
- [Official Forums](http://forums.imagicalmine.me)
- [![Travis Build](https://travis-ci.org/ImagicalCorp/ImagicalMine.svg)](https://travis-ci.org/ImagicalCorp/ImagicalMine)
- [![ReadTheDocs Build](https://img.shields.io/badge/docs-latest-brightgreen.svg?style=flat)](http://imagicalmine.readthedocs.org)

## Notes

- This is a third-party build of [PocketMine-MP](https://github.com/PocketMine/PocketMine-MP). ImagicalMine is in no way affiliated with [PocketMine-MP](https://github.com/PocketMine/PocketMine-MP).
- Please read the [contributing guidelines](https://github.com/ImagicalCorp/ImagicalMine/blob/master/CONTRIBUTING.md) before submitting an issue or a pull request. Any contributions that don't match them will be closed immediately by a team member.
- Please do not use the issue tracker as a chat room. If you want to chat and ask questions, contact [@ImagicalTeam on Twitter](https://twitter.com/ImagicalTeam) or join the [official forums](http://forums.imagicalmine.net).
- We're proud to say that ImagicalMine has the best redstone system so far. Thanks for all your support!

## Acknowledgements

- The original code in ImagicalMine is from [PocketMine-MP](https://github.com/PocketMine/PocketMine-MP). All original code structure and base was written by the [PocketMine Team](https://github.com/PocketMine).
- ImagicalMine has many features that are based and taken from the [Hydreon Corporation's](https://github.com/Hydreon) [Katana](https://github.com/Hydreon/Katana) project. This includes the hunger core and experimental skin fixes for the MCPE 0.13.0 update.
- Some of the code in ImagicalMine is taken from the [Hydreon Corporation's](https://github.com/Hydreon) project. Code taken from [Steadfast2](https://github.com/Hydreon/Steadfast2) was used for an experimental skin fix during the MCPE 0.13.0 update.
- Some of the code in ImagicalMine is taken from the [@hmy2001's](https://github.com/hmy2001) project. Code taken from [PocketMine-0.13.x](https://github.com/HmyTeamOrganization/PocketMine-0.13.x) was used for an experimental skin fix during the MCPE 0.13.0 update.
- Some of the code in ImagicalMine is taken from the [iTXTech's](https://github.com/iTXTech) project. Code taken from [Genisys](https://github.com/iTXTech/Genisys) was used for a variety of bug fixes and patches and new feature updates.
- Some of the code in ImagicalMine is taken from the [ClearSkyTeam's](https://github.com/ClearSkyTeam) project. Code taken from [ClearSky](https://github.com/ClearSkyTeam/ClearSky) was used for new features and fixes.

## Can I test ImagicalMine before I download and use it?
Sure, why not? Simply join one of the servers below to see what ImagicalMine can do! You'll be amazed!<br>

| Name                                                               |            IP            | PORT      |
|--------------------------------------------------------------------|:------------------------:|-----------|
| **RumBenCraft**                                                    | **play.rumbencraft.net** | **19132** |
| **DarkRealms**                                                     | **play.dr-pvp.us**       | **19132** |
| **ImagicalMine 0.13.1 Creative (Latest build every day at 12 am)** | **WolvesFortress.de**        | **19133** |
| **InfinityBox Network  (Latest build every day at 12 - 1 - 3 pm)** | **play.infinitybox.ml**  | **19132**


**Please do not submit your server via PR. You will be banned from the Imagical Corporation and all of its repositories if you do.**<br>
### Can I see some custom-made versions that are based off ImagicalMine?
See what you can dig out on these servers:<br>

| Name            |           IP          | PORT      |
|-----------------|:---------------------:|-----------|
| **LegoCraftPE** | **play.legocraft.me** | **19132** |
Never underestimate what you can do with ImagicalMine!<br>

## What is this?

ImagicalMine is software for hosting Minecraft : Pocket Edition servers. From controlling everything you can possibly do on MCPE to everything players can ever imagine on a server, ImagicalMine is the perfect solution to hosting large-scale MCPE servers. Our goal is to make ImagicalMine the best MCPE server software out there, and can handle up to 1000 players without lag. 

## Why is the Imagical Corporation/ImagicalMine team doing this?

Because Shoghi of the PocketMine team has given us so much, we've decided to build onto the project and help out the community. Thanks to all the team members of the Imagical Corporation, the work you are seeing today is open-source and free for every human to use. It'll stay free forever and the team will try and keep it active as well as possible.

## Can I extend ImagicalMine to my own needs?

Sure you can! Check out [API Documentation](http://imagicalmine.readthedocs.org/en/latest/developers.html) to start making plugins to transform your server into something you never thought you'd be able to even do!

## Can I help out the team and contribute to ImagicalMine?

Why not? We're always looking for developers to help out with the project! Make sure you check out the [Contributing Guidelines](https://github.com/ImagicalCorp/ImagicalMine/blob/master/CONTRIBUTING.md) first though.

## Can I join the community of ImagicalMine?

Of course you can! Check out the [ImagicalMine forums](http://forums.imagicalmine.me) now!

## How do I install ImagicalMine?

Read the documentation for installing ImagicalMine [here](http://imagicalmine.readthedocs.org/en/latest/installation.html).
You can also go to the Jenkins server by clicking the picture below.<br>
 <a href="http://jenkins.imagicalmine.net:8080/job/ImagicalMine/">![Unofficial-Downloadpng](http://s4.postimg.org/8u7blm3r1/imagical.png)</a>

## I'm on a MCPE server hosting provider. How can I install ImagicalMine from there?

Some MCPE server hosting providers support ImagicalMine as a version for their customers to download. The following list shows all of the providers who support ImagicalMine as a version to download for use on their servers:
* __[HostMyServers](http://hostmyservers.com)__
* __[HostingItAll](http://hostingitall.com)__
* __[InfinityBox](http://infinitybox.ml)__

**If you are a MCPE server hosting provider and you support ImagicalMine as a version available for download and to use as part of your service, contact us and we'll happily add your business to the list.**

## What third-party libraries or protocols does ImagicalMine use?

Here's the complete list:
* __[PHP Sockets](http://php.net/manual/en/book.sockets.php)__
* __[PHP SQLite3](http://php.net/manual/en/book.sqlite3.php)__
* __[PHP BCMath](http://php.net/manual/en/book.bc.php)__
* __[PHP pthreads](http://pthreads.org/)__ by _[krakjoe](https://github.com/krakjoe)_: Threading for PHP - Share Nothing, Do Everything.
* __[PHP YAML](https://code.google.com/p/php-yaml/)__ by _Bryan Davis_: The Yaml PHP Extension provides a wrapper to the LibYAML library.
* __[LibYAML](http://pyyaml.org/wiki/LibYAML)__ by _Kirill Simonov_: A YAML 1.1 parser and emitter written in C.
* __[cURL](http://curl.haxx.se/)__: cURL is a command line tool for transferring data with URL syntax
* __[Zlib](http://www.zlib.net/)__: A Massively Spiffy Yet Delicately Unobtrusive Compression Library
* __[Source RCON Protocol](https://developer.valvesoftware.com/wiki/Source_RCON_Protocol)__
* __[UT3 Query Protocol](http://wiki.unrealadmin.org/UT3_query_protocol)__

## Quick Links

* __[Homepage](http://imagicalmine.me/)__
* __[Forums](http://forums.imagicalmine.me/)__
* __[Documentation](http://imagicalmine.readthedocs.org)__
* __[Plugin Repository](http://forums.imagicalmine.me/plugins)__
* __[Official Jenkins Server](http://jenkins.imagicalmine.net:8080/job/ImagicalMine/)__
* __[Official Twitter Account](https://twitter.com/ImagicalCorp)__
