Budabot is a next-generation chatbot for Anarchy Online.
For all support questions and bug reports please contact me in-game (Nadychat) or via email [email protected].
There are three ways that you can obtain Budabot: Release Archives (recommended for most users), Latest Development, or Cloning the Repository (recommended for developers).
You can download the latest stable version from link below. If you want the most stable version, choose the latest GA release. If you want to test some of the newest features, choose an RC release.
https://github.com/Nadyita/Budabot/releases
You can download the very latest version from the link below. Note that this version is a development version, may not have been tested thoroughly, and may contain bugs.
https://github.com/Nadyita/Budabot/archive/master.zip
Alternatively you can clone the Budabot git repository. The advantage to doing this is that as new changes are committed you can simply do git pull to pull those changes into your copy. Note that this version is a development version, may not have been tested thoroughly, and may contain bugs. If you are planning on developing on Budabot, we recommend that you use this method.
https://github.com/Nadyita/Budabot.git
Before you are able to run the bot, you need to install the required composer packages:
composer install --no-dev
composer dumpautoload --no-devTo start the bot, run the chatbot.bat file (on linux run the chatbot.sh file). If it is your first time running the bot, 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, you will also need the EXACT org name of the org and the character that the bot runs as will need to have already been invited to the org.
You can either use the already pre-made Docker images that I provide at https://quay.io/repository/nadyita/budabot or you can build it yourself. To use the pre-made images, address them as quay.io/nadyita/budabot
In order to build the Docker image, issue
docker build -t budabot .Either way, you can then run the bot in test-mode like this:
docker run \
--rm \
-it \
-e CONFIG_LOGIN=myaccount \
-e CONFIG_PASSWORD=mypassword \
-e CONFIG_BOTNAME=Mybot \
-e CONFIG_SUPERADMIN=Myplayer \
-e CONFIG_DB_TYPE=sqlite \
-e CONFIG_DB_NAME=testdb \
-e CONFIG_DB_HOST=/tmp \
quay.io/nadyita/budabotThe database in this approach will be fresh on every start and you will expose your bot's password in the process list. Only use this for testing!
A systemd service for this type of configuration, using MariaDB in another docker container as database could look like this:
[Unit]
Description=My Cool Bot
Requires=docker.service
Requires=mariadb.service
After=docker.service
[Service]
Type=simple
ExecStartPre=-/usr/bin/docker stop "%n"
ExecStartPre=-/usr/bin/docker rm -f "%n"
ExecStart=/usr/bin/docker run \
--rm \
--name "%n" \
--env-file /etc/sysconfig/mycoolbot \
--link mariadb.service:mariadb \
quay.io/nadyita/budabot
ExecStop=-/usr/bin/docker stop "%n"
ExecReload=/usr/bin/docker stop "%n"
Restart=always
RestartSec=5
[Install]
WantedBy=multi-user.targetand the corresponding configuration file in /etc/sysconfig/mycoolbot:
CONFIG_LOGIN=myaccountname
CONFIG_PASSWORD=mypassword
CONFIG_ORG=Myorg
CONFIG_SUPERADMIN=Mychar
CONFIG_BOTNAME=Mycoolbot
CONFIG_DIMENSION=5
CONFIG_DB_TYPE=mysql
CONFIG_DB_HOST=mariadb
CONFIG_DB_NAME=my_db_name
CONFIG_DB_USER=my_db_username
CONFIG_DB_PASS=my_db_pass_for_dbuser
#CONFIG_AMQP_SERVER=127.0.0.1
#CONFIG_AMQP_USER=guest
#CONFIG_AMQP_PASSWORD=guestThis prevents passwords from showing up anywhere in the process list, but make sure you set the permissions of this file to 0600, so no one except root can see your password.
Developing the bot using Containers (Docker, Podman, etc.) is very easy. You basically run the container and mount your local checkout over /budabot.
You don't need php or composer installed for this setup since the docker image will already contain everything you need to get started.
docker run \
--rm \
-it \
-v "$(pwd)":/budabot \
-e CONFIG_LOGIN=myaccount \
-e CONFIG_PASSWORD=mypassword \
-e CONFIG_BOTNAME=Mybot \
-e CONFIG_SUPERADMIN=Myplayer \
-e CONFIG_DB_TYPE=sqlite \
-e CONFIG_DB_NAME=testdb \
-e CONFIG_DB_HOST=/tmp \
quay.io/nadyita/budabotpodman run \
--user root \
--security-opt label=disable \
-v "$(pwd)":/budabot \
--rm \
-it \
-e CONFIG_LOGIN=myaccount \
-e CONFIG_PASSWORD=mypassword \
-e CONFIG_BOTNAME=Mybot \
-e CONFIG_SUPERADMIN=Myplayer \
-e CONFIG_DB_TYPE=sqlite \
-e CONFIG_DB_NAME=testdb \
-e CONFIG_DB_HOST=/tmp \
quay.io/nadyita/budabotIn order to relay messages between orgs, you will need 1 bot in each org configured in the same way.
There are 3 ways to link the org chats together:
Pro:
- simplest solution, no additional bot or software required
Contra:
- Old Budabot versions only support links between 2 orgs
- Tell-relays suffer from the heavy rate-limiting imposed on tells
In order to configure a tell relay between bot Alice in org The First Ones and bot Bobby in the org We can read you, which will relay all messages without any prefix whatsoever between the 2 orgs, you need to do the following on Alice:
!config mod RELAY_MODULE enable all
!settings save relaytype 1
!settings save relaybot Bobby
!settings save relay_guild_abbreviation 1st
and the following on Bobby:
!config mod RELAY_MODULE enable all
!settings save relaytype 1
!settings save relaybot Alice
!settings save relay_guild_abbreviation read
This will then bridge org and private chat of both orgs together. The result looks like this:
[The First Ones] Tester: Testing 123...
[We can read you] Bobby: [1st] Tester: Testing 123
[We can read you] Tester2: Replying 123
[The First Ones] Alice: [read] Tester2: Replying 123...Notice how the name of the orgs are abbreviated as configured in the relay_guild_abbreviation setting.
Pro:
- Can link a sheer endless amount of bots/orgs together
- No external program needed
- Access control to the relay is inside Anarchy Online on the dedicated bot
Contra:
- Requires a dedicated bot for providing the private channel used as a relay
- If a bot restarts, the messages sent while it was down are not relayed retroactively
In order to configure a private-channel-relay between bot Alice in org The First Ones and bot Bobby in the org We can read you, which will relay all messages without any prefix whatsoever between the 2 orgs, we will first need to setup the bot Relayer, providing the dedicated private channel.
!config mod PRIVATE_CHANNEL_MODULE enable all
!adduser Alice
!adduser Bobby
Once the Relayer has been setup, they will auto-invite Alice and Bobby, but for now they won't join until we configure them to.
Alice's configuration looks like this:
!config mod RELAY_MODULE enable all
!settings save relaytype 2
!settings save relaybot Relayer
!settings save relay_guild_abbreviation 1st
Bobby's configuration looks like this:
!config mod RELAY_MODULE enable all
!settings save relaytype 2
!settings save relaybot Relayer
!settings save relay_guild_abbreviation read
Notice how they are identical except for the relay_guild_abbreviation. If you then either restart Alice and Bobby or !invite them again on the Relayer, they will start relaying messages.
Pro:
- Can link an endless amount of bots/orgs together with literally no delay
- Multiple relay networks can be managed simultaneously
- Messages are kept between bot restarts, configurable on the AMQP server
- Allows to link non-AO-bots to the network as well
Contra:
- Access control to the relay is outside Anarchy Online on the AMQP server
- Requires a dedicated AMQP server
In order to configure a private-channel-relay between bot Alice in org The First Ones and bot Bobby in the org We can read you, which will relay all messages without any prefix whatsoever between the 2 orgs, we will first need to setup the AMQP server. If you don't know what this actually is, don't do it. Period.
We start by creating 2 users, each with a unique username and password. For simplicity, we are also assuming that you are using RabbitMQ, but any AMQP server will work.
rabbitmq@host:~$ rabbitmqctl add_vhost /my_relay
Adding vhost "/my_relay" ...
rabbitmq@host:~$ rabbitmqctl add_user alice
Adding user "alice" ...
Password: ******
rabbitmq@host:~$ rabbitmqctl set_permissions --vhost /my_relay alice budabot budabot budabot
Setting permissions for user "alice" in vhost "/my_relay" ...
rabbitmq@host:~$ rabbitmqctl add_user bobby
Adding user "alice" ...
Password: ******
rabbitmq@host:~$ rabbitmqctl set_permissions --vhost /my_relay bob budabot budabot budabot
Setting permissions for user "bob" in vhost "/my_relay" ...Now you will need to change the bots' configuration to connect to the AMQP server using your vhost /my_relay:
$vars['amqp_server'] = "your server";
$vars['amqp_port'] = 5672;
$vars['amqp_user'] = "alice/bobby";
$vars['amqp_password'] = "your password";
$vars['amqp_vhost'] = "/my_relay";Restart the bots and check the logs if the connection is established. Now it's time to make your bots use this conection:
Alice's configuration looks like this:
!config mod RELAY_MODULE enable all
!settings save relaytype 3
!settings save relaybot budabot
!settings save relay_guild_abbreviation 1st
Bobby's configuration looks like this:
!config mod RELAY_MODULE enable all
!settings save relaytype 3
!settings save relaybot budabot
!settings save relay_guild_abbreviation read
Notice how they are identical except for the relay_guild_abbreviation. Relaying should start immediately after changing the settings.
The value for relaybot has to mimic the AMQP exchange you want your network to use.