flammified/terrabot

An easily used library for making Terraria bots

Terrabot

Introduction

Terrabot is a Terraria bot API written in Python. It is designed to be easy to use and uses the event-listener pattern.

Installation

Install the module using pip:

pip3 install terrabot

Current features

• Joining servers
• Chatting
• Triggering various events, like joining, tiledata and itemdrops
• Parsing server data to keep classes up-to-date
• Moving the bot by teleporting

Examples

The following is a very basic bot, which will connect and handle chat.

---

from terrabot import TerraBot
from terrabot.events import Events

# Create a TerraBot object
bot = TerraBot('127.0.0.1')
event = bot.get_event_manager()


# Connect a function to an event using a decorator
@event.on_event(Events.Chat)
def chat(event_id, msg):
    # Do something with the message
    # In this case, stop the bot if the word "Stop" occurs
    print(msg)
    if "stop" in msg:
        bot.stop()


# Start the bot
bot.start()

# And wait
while bot.client.running:
    pass

More examples can be found under the 'examples' directory. Also check the wiki for more information about the inner workings of the bot and how to interface with it.

Contributing

If you want to contribute, that's great! I would really appreciate the help. Just send a pull request and i'll quickly check and accept it. These are some areas that need work:

• NPC packet parsing
• Item dropping
• Teleporting other players (>:D)
• Synchronizing packets like health and update-player-packets
• Placing tiles (!)

For information about the packets, see this link.

terrabot's Issues

Blank character name

Issue

I passed correct protocol number to method, and whatever I do it returns this error on server side (client doesn't log at all since server kicks the client.)

I am using tShock for the server.
Server's terraria version is 1.4.0.5
tShock version is 4.4.0.0

Details

Server-side log looks like this:

192.168.0.8:63469 is connecting...
Debug: Bouncer / OnGetSection rejected empty player name.
192.168.0.8:63469 was booted: Kicked: Your client sent a blank character name.
Kicked for : 'Your client sent a blank character name.'
Saving world...

Here's my entire code:

from terrabot.events import Events
from terrabot import TerraBot

# Create a TerraBot object
bot = TerraBot('192.168.0.8', name="thisisalongname2", protocol=230)
event = bot.get_event_manager()

# Connect a function to an event using a decorator


@event.on_event(Events.Chat)
def chat(event_id, msg):
    # Do something with the message
    # In this case, stop the bot if the word "Stop" occurs
    print(msg)
    bot.message("ddd?")
    if "!e498r7afdc6" in msg:
        bot.stop()


# Start the bot
bot.start()

# And wait
while bot.client.running:
    pass

Does it work with 1.4.3.6?

Would like to know if it works with 1.4.3.6

I think this is definitely a good plugin

But how do I use it?
I have used the PIP3 installation And how do I go on

This plugin can be used together with Tshock?
Thank you

1.4.4.9 server support

name says it

I think this protocol number is incorrect

terrabot/terrabot/bot.py

Line 13 in 14372aa

def __init__(self, ip, port=7777, protocol=188, name="Terrabot"):

ModuleNotFoundError: No module named 'PIL'

How to fix?

Traceback (most recent call last):
  File "C:\Users\Admin\Documents\Python\bot.py", line 1, in <module>
    from terrabot import TerraBot
  File "C:\Users\Admin\AppData\Local\Programs\Python\Python37-32\lib\site-packages\terrabot\__init__.py", line 1, in <module>
    from .bot import TerraBot
  File "C:\Users\Admin\AppData\Local\Programs\Python\Python37-32\lib\site-packages\terrabot\bot.py", line 6, in <module>
    from terrabot.util.worlddrawer import draw_world
  File "C:\Users\Admin\AppData\Local\Programs\Python\Python37-32\lib\site-packages\terrabot\util\worlddrawer.py", line 1, in <module>
    from PIL import Image, ImageDraw
ModuleNotFoundError: No module named 'PIL'

When Terrabot connects, i get a message saying...

When Terrabot connects to the server, it gets kicked because the server and terrabot are not on the same version of the game. Also, whats the TerraBot version of terraria