Skip to main content

A minimalistic Discord bot for Albion Online's killboard.

Project description

ao_killboard.py

A minimalistic Discord bot for Albion Online's killboard.

Getting Started

Prerequisites

Built with:

Getting the bot via pip

pip install ao-killboard

Getting the bot via Docker Hub

docker pull unresolvedexternal/ao-killboard

Getting the bot via Git

git clone https://github.com/antze-k/ao-killboard-py
python3 -mpip install -r ao-killboard-py/requirements.txt

Change your working directory to cd ao-killboard-py/src/antze and run the bot with either of those, depending on your system setup:

  • python3 ao_killboard.py
  • python ao_killboard.py
  • ao_killboard.py
  • ./ao_killboard.py

The documentation will refer to ao_killboard.py further for simplicity.

Creating a bot account and setting it up for your server (guild)

Configure and run

Set up three parameters (guild, token and channel) either using environment variables or using command line arguments.

  • "guild" is your Albion Online guild identifier (as seen in https://albiononline.com/en/killboard/guild/<ID>)
  • "token" is your bot token obtained in the previous step
  • "channel" is the Discord channel ID the bot will post messages into (check this article if you need to know how to obtain it)

You can always run ao_killboard.py --help to check the available options.

Running the bot manually using command line arguments

ao_killboard.py --guild <GUILD-ID> --token <DISCORD-TOKEN> --channel <123456789>

or, to enable debug logging:

ao_killboard.py --guild <GUILD-ID> --token <DISCORD-TOKEN> --channel <123456789> --debug

Replace the <PLACEHOLDERS> with their respective values, omitting angle brackets.

Running the bot using environment values and a batch script (Windows)

Paste the following into a file with a name like "start-bot.cmd":

@echo off
set AO_KILLBOARD_GUILD=<GUILD-ID>
set AO_KILLBOARD_TOKEN=<DISCORD-TOKEN>
set AO_KILLBOARD_CHANNEL=<123456789>
ao_killboard.py %*

Replace the <PLACEHOLDERS> with their respective values, omitting angle brackets. To enable debug logging, add set AO_KILLBOARD_DEBUG=1 before the last line.

Running the bot using environment values and a shell script (POSIX-like OS)

Paste the following into a file with a name like "start-bot.sh":

AO_KILLBOARD_GUILD=<GUILD-ID>
AO_KILLBOARD_TOKEN=<DISCORD-TOKEN>
AO_KILLBOARD_CHANNEL=<123456789>
exec ao_killboard.py "$@"

Replace the <PLACEHOLDERS> with their respective values, omitting angle brackets. Set the execute bit by running chmod +x start-bot.sh. To enable debug logging, add AO_KILLBOARD_DEBUG=1 before the last line.

Running the bot using Docker

docker run --rm -d --env 'AO_KILLBOARD_GUILD=<GUILD-ID>' --env 'AO_KILLBOARD_TOKEN=<DISCORD-TOKEN>' --env 'AO_KILLBOARD_CHANNEL=<123456789>' unresolvedexternal/ao-killboard

or, to enable debug logging:

docker run --rm -d --env 'AO_KILLBOARD_GUILD=<GUILD-ID>' --env 'AO_KILLBOARD_TOKEN=<DISCORD-TOKEN>' --env 'AO_KILLBOARD_CHANNEL=<123456789>' --env 'AO_KILLBOARD_DEBUG=1' unresolvedexternal/ao-killboard

Replace the <PLACEHOLDERS> with their respective values, omitting angle brackets. You might also want to add --name ao-killboard or any other Docker switches you would prefer.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ao-killboard-0.1.2.tar.gz (9.5 kB view hashes)

Uploaded source

Built Distribution

ao_killboard-0.1.2-py3-none-any.whl (9.6 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page