PHBot xControl Plugin 1.9.1: Installation and Usage Guide
PLUGIN · PHBOT
Download files only from sources you trust. SROFind does not virus-scan uploads.
PHBot xControl Plugin 1.9.1: Installation and Usage Guide
xControl is a PHBot plugin that allows players to control selected character actions through in-game chat commands. Depending on server compatibility and configuration, it can start or stop the bot, initiate tracing or following, request teleportation, change profiles, and perform several inventory-related actions.
This guide is based on the supplied xControl.py source file, which identifies the plugin version as 1.9.1.
1. What does xControl do?
Key features include:
- Starting and stopping the bot
- Starting or stopping trace
- Following a party member while maintaining a specified distance
- Attempting to use a Return Scroll
- Initiating teleportation through an NPC
- Changing training positions and radius
- Loading saved profiles
- Equipping, unequipping, or using items
- Selecting a PVP Cape
- Leaving a party
- Sending messages through supported chat channels
Availability may vary depending on the server, game version, inventory, and PHBot configuration.
2. Installation
- Obtain the xControl plugin file.
- Open the
Pluginsfolder in your PHBot installation directory. - Place
xControl.pyin that folder. - Open PHBot and navigate to the plugins section.
- Use the option to reload plugins.
- Check whether the xControl tab appears and the plugin loads successfully.
The supplied source identifies the plugin as version 1.9.1. Menu labels may differ between PHBot versions.
3. Configure a command leader
The xControl interface includes a list for adding and removing leader characters.
- Log into the game with your character.
- Open the xControl tab in PHBot.
- Enter the in-game name of the character allowed to send commands.
- Click Add.
- Confirm that the character appears in the list.
To remove a character, select it and click Remove.
Only add characters you trust. The source processes chat commands from names in the configured leader list. The source also contains a separate path for messages received through Discord.
4. Basic commands
Commands are sent through in-game chat.
| Command | Function |
|---|---|
START |
Starts the bot. |
STOP |
Stops the bot. |
TRACE |
Attempts to trace the character who sent the message. |
TRACE CharacterName |
Attempts to trace the specified character. |
NOTRACE |
Stops tracing. |
RETURN |
Attempts to use a Return Scroll or initiate resurrection if the character is dead. |
GETPOS |
Sends your current position details in a private message. |
DC |
Disconnects from the game. |
Example: TRACE LeaderName
Replace LeaderName with the actual in-game character name.
5. Follow a party member
Unlike trace, FOLLOW attempts to maintain a specified distance from a party member.
FOLLOW: Attempts to follow the sender at the default distance.FOLLOW CharacterName: Attempts to follow the specified party member.FOLLOW CharacterName 15: Attempts to maintain a distance of approximately 15 units.NOFOLLOW: Stops following.
Example:
FOLLOW LeaderName 15
The plugin checks whether the target is in the party. Following may not work as expected if the target cannot be detected.
6. Teleport commands
The TP command attempts to teleport between the specified source and destination.
Example:
TP Jangan Donwhang
Enter the source NPC or teleport name first, followed by the destination. Names must match the teleport data available on your server.
The command may fail if the teleport data is unavailable or the relevant NPC cannot be detected nearby. Test it in a safe location first.
7. Training area commands
xControl can change several PHBot training settings through chat.
SETPOS: Uses the current position as the training location.SETPOS 1152 -125: Sets the specified X and Y coordinates.SETRADIUS 25: Sets the training radius to 25.SETRADIUS: Resets the radius to 35 in the supplied source.SETSCRIPT: Resets the training script path.SETSCRIPT FilePath: Changes the training script path.SETAREA AreaName: Selects a saved training area.MOVEON 20: Attempts random movement within the specified radius.
Coordinates, area names, and script paths must match your server and PHBot setup.
8. Profiles, items, and additional commands
| Command | Description |
|---|---|
PROFILE |
Attempts to load the default profile. |
PROFILE ProfileName |
Attempts to load the specified profile. |
EQUIP ItemName |
Attempts to equip a matching inventory item. |
UNEQUIP ItemName |
Attempts to unequip a matching item. |
USE ItemName |
Attempts to use a matching inventory item. |
CAPE |
Attempts to use the default yellow PVP Cape. |
CAPE red |
Selects the red PVP Cape. |
CAPE off |
Attempts to remove the PVP Cape. |
ZERK |
Attempts to activate berserker mode. |
GETOUT |
Attempts to leave the party. |
SIT |
Toggles sitting or standing. |
JUMP |
Produces a visual effect. |
MOUNT |
Attempts to summon the default horse. |
DISMOUNT |
Attempts to dismount the default mount. |
REVERSE return |
Attempts to return to the last return location. |
REVERSE death |
Attempts to return to the last death location. |
REVERSE player CharacterName |
Attempts to reverse to the specified player. |
REVERSE zone ZoneName |
Attempts to reverse to the specified zone. |
Reverse commands depend on server support. The presence of a command does not guarantee that it will work on every private server.
9. Sending chat messages
The CHAT command can send messages through supported chat channels.
Examples:
CHAT party HelloCHAT guild HelloCHAT all HelloCHAT private CharacterName Hello
Supported message types in the source include all, private, party, guild, union, note, stall, and global. Availability depends on the server and applicable chat restrictions.
10. Troubleshooting
The xControl tab does not appear
- Confirm that the file is in the correct
Pluginsdirectory. - Reload plugins in PHBot.
- Check the PHBot log for the plugin load message.
A command does not respond
- Make sure the sender is in the configured leader list.
- Check command spelling and required parameters.
- Verify whether the target must be in the party or within detection range.
- Review the PHBot log.
Teleportation fails
- Check that the source and destination names match the server's teleport data.
- Make sure the NPC is nearby and the teleport data is available.
REVERSE does not work
- Verify that your server supports the relevant reverse feature.
- Check whether the command is blocked by the server's chat filter.
Conclusion
xControl provides chat-based control for selected PHBot actions. After installation, test basic commands such as START, STOP, and GETPOS first. Check server compatibility before using teleportation, inventory, or reverse commands.
Version note: This guide is based on the supplied xControl.py source, which identifies version 1.9.1. Commands and behavior may differ in other versions.
- Developer
- JellyBitz
External links
Downloads
xControl.py
xControl.py · 25.0 KB
Download
