Giter VIP home page Giter VIP logo

tyrbot's Introduction

Tyrbot

This is a rewrite of the original Budabot in Python3.

Budabot is an in-game chat-bot for the MMORPG Anarchy Online released by Funcom in 2001.

Requirements

Tyrbot requires Python 3.6. Neither Python 3.5 or Python 3.7 will work. We are working on adding support for Python 3.7.

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 running a version of 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

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 here.
  • The official Discord API documentation can be found here.
  • The official Discord API server can be joined here.

Writing Custom Modules

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

Running in Docker

Basic commands for running the bot in docker:

docker build -t tyrbot .
docker run --rm -it --name name_of_bot -v /path/to/tyrbot:/app tyrbot

We recommend using a docker-compose setup to host a stable bot in docker.

Advanced

In more advanced cases you might not want to put credentials in the config.hjson file. Enviroment variables can instead be used. The account fields in the config file can left blank when the following enviroment variables are defined.

TYRBOT_USERNAME=myaccount
TYRBOT_PASSWORD=mypassword
TYRBOT_CHARACTER=Bot
TYRBOT_SUPERADMIN=TheBoss

tyrbot's People

Contributors

bigwheels16 avatar kristinhansen avatar minidodo1 avatar jroovers avatar teeko7 avatar dustify avatar einarf avatar hughp135 avatar nepherius avatar dependabot[bot] avatar equinitry avatar thesilentw avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.