Skip to content

A Discord bot for displaying the status of a game server

License

Notifications You must be signed in to change notification settings

Kexanone/apyllo

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Apyllo

Version GitHub Downloads Docker Pulls Issues License

A Discord bot for displaying the status of a game server

Supported Games

  • Arma 3
  • Citra (Nintendo 3DS Emulator)

Installation

python3 -m pip install git+https://github.com/Kexanone/apyllo.git

Usage

Bot Account

You first need to create a bot account and invite it to your server. The secret bot token that is obtained has to be passed to --token (see examples below).

Example for Arma 3

# See `python3 -m apyllo arma3 --help` for more details
python3 -m apyllo arma3 \
    --host <SERVER IP ADDRESS> --port <SERVER STEAM QUERY PORT> \
    --token <SECRET DISCORD BOT TOKEN> \
    --channel-id <DISCORD CHANNEL ID>

Example for Citra

# Example for Citra
# See `python3 -m apyllo citra --help` for more details
python3 -m apyllo citra \
    --host <SERVER IP ADDRESS> --port <SERVER PORT> \
    --token <SECRET DISCORD BOT TOKEN> \
    --channel-id <DISCORD CHANNEL ID>

Docker

Apyllo is also available as a docker image on Docker Hub

docker create --name mhxx-apyllo \
    --network host \
    -v ~/.cache/:/root/.cache/ \
    kexanone/apyllo citra \
    --host <SERVER IP ADDRESS> --port <SERVER PORT> \
    --token <SECRET DISCORD BOT TOKEN> \
    --channel-id <DISCORD CHANNEL ID>

Showcase

showcase-1.png