Tyrbot

Tyrbot is an in-game chatbot for the MMORPG Anarchy Online released by Funcom in 2001.

This is a rewrite of Budabot in Python 3.

Quickstart

1. Download the bot: https://github.com/Budabot/Tyrbot/archive/master.zip
2. Unzip the bot to a location on your computer
3. Run start.bat
4. The first time you run the bot it will ask some questions. You will need four pieces of information: username, password, character name, and superadmin. For any other question you can simply press <Enter> to use the default value.

Requirements

Tyrbot requires Python 3.6. We recommend either version 3.6.6. or 3.9.1 as we have tested these versions most extensively.

We have tested also test Python versions 3.7.9 and 3.8.7. We do not recommend Python 3.8 as it has known issues with Tyrbot, specifically regarding SSL. If you see SSL errors in your logs, or if the Discord module or websocket relay does not work, consider using a different Python version.

Installation

Tyrbot is now ready for general use and is recommended over Budabot or any other bot for all new installations.

Currently there are no releases for Tyrbot but you can download the bot from here which will always have the very latest changes: https://github.com/Budabot/Tyrbot/archive/master.zip

Then simply unzip the bot somewhere before starting it.

Upgrade

If you are already running Tyrbot and simply want to upgrade to the latest version, follow these steps:

1. Download the latest version from here: https://github.com/Budabot/Tyrbot/archive/master.zip
2. Unzip the bot to a new location (do not just unzip it over the top of the old installation)
3. From the old installation, copy the ./conf, ./data, and optionally, the ./logs directories to the new installation
4. If you have any custom modules, copy the ./modules/custom/ directory over as well
5. Start the bot and verify everything works and that all of your data has carried over
6. In a few rare cases, the bot may not start because the config file format changed between versions and you may need to compare your config.hjson to the template version and make changes accordingly
7. You can now delete the old installation

If you want to upgrade from Budabot, follow the instructions here: https://github.com/Budabot/Tyrbot/wiki/Migrating-From-Budabot

Starting Tyrbot

To start the bot, run either start.bat or start.sh.

If it is your first time running the bot, or if the config.json file does not exist, it will take you through the configuration wizard to configure the bot. You will need to have a character name that you you want to run the bot as along with the username and password for the account that has that character. If you want to run this bot as an org bot, the character that the bot runs as will need to already be a member of that org.

Support

If you need help or support with Tyrbot, join our discord channel: https://discord.gg/2x9WesJ

Discord Module Setup

If you would like to connect your bot to your Discord server, follow this guide: https://github.com/Budabot/Tyrbot/wiki/Discord-Setup

• The library used to build the module can be found https://discordpy.readthedocs.io/en/latest/index.html.
• The official Discord API documentation can be found https://discordapp.com/developers/docs/intro.
• The official Discord API server can be joined at https://discord.gg/discord-api.

Writing Custom Modules

See the Wiki page: https://github.com/Budabot/Tyrbot/wiki/Writing-Custom-Modules

Running in Docker

See the Wiki page: https://github.com/Budabot/Tyrbot/wiki/Docker