This Gitbook is for documenting the phBot plugin API.

What is Python?

From Wikipedia:

Python is a widely used general-purpose, high-level programming language. Its design philosophy emphasizes code readability, and its syntax allows programmers to express concepts in fewer lines of code than would be possible in languages such as C++ or Java.

Python 3.4 was chosen for the plugin system because it is easy to learn and does not require a compiler. Simply save your script inside the Plugins folder and launch the bot. Done!

Where can I get help?

There is a forum section dedicated to plugins where you can publish your plugins and get help if you require it. https://projecthax.com/forumdisplay.php?f=50

What can I do with the plugin system?

I have made many functions available to Python. These functions allow you to get all players near you, get all NPCs/teleporters near you, and much more. You can do anything you want with the data. It's all up to you.

For example, a chat API is available; with this you can send messages to all nearby players.

What do I need to get started?

You'll need the new stable release of phBot and the python34 scripts which you can get by clicking here. It comes with an example script named example.py, which can be deleted.

phBot Links

Learning Python