Home · Adding a phBot plugin
Adding a plugin to phBot
Plugin installation in four steps, plus where to look when the plugin does not show up.
First, check which tab it is in
phBot keeps plugins in two separate tabs, and they are installed in completely different ways. If you cannot find one, you may be looking in the wrong tab.
Embedded — built-in plugins
These ship inside phBot. Nothing to download, nothing to copy: open the Embedded tab, tick the Enabled box next to the plugin, done. Plugins like xNsyLMobile, AutoStyria and DonateGP live here.
Plugins — externally added
.py files you downloaded from somewhere show up in this tab. They have to be copied into phBot's folder — the steps below are for those.
Adding an external plugin
Installing a plugin you downloaded takes four steps:
- Find the Plugins folder — the
Pluginsfolder inside your phBot installation, for exampleC:\phBot\Plugins. - Copy the file in — drop the
.pyfile straight into that folder. Do not create a subfolder; phBot only reads files at the root. - Restart phBot — the plugin list is only scanned at startup, so close the program completely and open it again.
- Tick it in the list — open the Plugins tab and tick the box next to it. It is now running.
None of this applies to NsyL Companion. The plugin is embedded: just tick xNsyLMobile in the Embedded tab.
If the plugin will not load
Almost every case comes down to three causes:
The file is in the wrong place
A plugin inside a subfolder is invisible to phBot. The file has to sit directly in Plugins.
Version mismatch
An old plugin calling a function a newer phBot no longer provides will fail to load. The Log tab names the line that broke.
Plugin permission
Some server-specific phBot builds refuse external plugins and only run embedded ones. Copying a file there changes nothing.
What a plugin is for
Plugins do the jobs phBot's own interface does not. Common examples:
- Remote control and sending alerts to a phone
- Exporting drop, sale and death records
- Automating quests, events or caravan runs
Frequently asked
What is the difference between the Embedded and Plugins tabs?
Plugins on the Embedded tab ship inside phBot; you just tick the box. The Plugins tab is for .py files you add yourself, which have to be copied into the Plugins folder.
Where do I download the NsyL Companion plugin?
You don't. The plugin ships embedded in phBot: it sits on the Embedded tab under the name xNsyLMobile, and ticking it is all you need to do.
The plugin is not in the list — what should I do?
For embedded plugins, update phBot — the list ships with the phBot version. If it is a plugin you added yourself, make sure the file ends in .py and sits directly inside the Plugins folder, then close phBot completely and open it again.
I ticked the plugin but nothing happens
Look at phBot's Log tab. If the plugin failed to load, the reason is written there. The most common cause is the plugin not matching that phBot version.
Can I use the same plugin on several characters?
Yes. Each character uses its own Plugin Key, and the plugin runs on all of them at once.
Watch your character from your phone
The NsyL Companion plugin ships with phBot. Setup takes two minutes.
Setup guide