Package: ao-killboard
ao_killboard.pyA minimalistic Discord bot for Albion Online's killboard.Getting StartedPrerequisitesPython >= 3.6orDockerBuilt with:discord.pyhttpxGetting the bot via pippip install ao-killboardGetting the bot via Docker Hubdocker pull unresolvedexternal/ao-killboardGetting the bot via Gitgit clone https://github.com/antze-k/ao-killboard-py
python3 -mpip install -r ao-killboard-py/requirements.txtChange your working directory tocd ao-killboard-py/src/antzeand run the bot with either of those, depending on your system setup:python3 ao_killboard.pypython ao_killboard.pyao_killboard.py./ao_killboard.pyThe documentation will refer toao_killboard.pyfurther for simplicity.Creating a bot account and setting it up for your server (guild)https://discordpy.readthedocs.io/en/latest/discord.htmlhttps://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 runSet 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 inhttps://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 (checkthis articleif you need to know how to obtain it)You can always runao_killboard.py --helpto check the available options.Running the bot manually using command line argumentsao_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> --debugReplace 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_CHANNEL=<123456789>
ao_killboard.py %*Replace the  with their respective values, omitting angle brackets. To enable debug logging, addset AO_KILLBOARD_DEBUG=1before 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  with their respective values, omitting angle brackets. Set the execute bit by runningchmod +x start-bot.sh. To enable debug logging, addAO_KILLBOARD_DEBUG=1before the last line.Running the bot using Dockerdocker run --rm -d --env 'AO_KILLBOARD_GUILD=<GUILD-ID>' --env 'AO_KILLBOARD_TOKEN=<DISCORD-TOKEN>' --env 'AO_KILLBOARD_CHANNEL=<123456789>' unresolvedexternal/ao-killboardor, 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-killboardReplace the  with their respective values, omitting angle brackets. You might also want to add--name ao-killboardor any other Docker switches you would prefer.