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 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)
- https://discordpy.readthedocs.io/en/latest/discord.html
- https://discordpy.readthedocs.io/en/latest/discord.html#inviting-your-bot (you don't have to add any specific permissions here, if you choose to add Send Messages permission manually for your channel)
- Setting permissions (scroll down to Channel Permissions)
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>
Replace the 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_GUILD=<123456789>
ao_killboard.py %*
Replace the with their respective values, omitting angle brackets.
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_GUILD=<123456789>
exec ao_killboard.py "$@"
Replace the with their respective values, omitting angle brackets. Set the execute bit by running chmod +x start-bot.sh
.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for ao_killboard-0.1.1.post1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f827e273d64422ea6b48225256504a8dc1c55bb9aa653da9e154835da0eb6389 |
|
MD5 | 93eca45557c345aed27fb805b0494c1c |
|
BLAKE2b-256 | e3200aaa5492f6d3c829689a5cc8764236ecc3e8f552cb9f7e8732be840bdff7 |