search

F43nd1r / zachtronics-leaderboard-bot

Apache License 2.0
3 stars 8 forks source link

readme

Zachtronics Leaderboard Bot

A discord & reddit bot for automating solution submission/display for Zachtronics games.

Currently included:

Use

The bot runs in the unofficial Zachtronics Discord Server, usable from slash commands.
The graphical leaderboard, frontier visualizer and API is hosted at https://zlbb.faendir.com/ .
The official leaderboard copies managed by the bot are in the wiki page of the game subreddits.

Set up the leaderboard integration in Opus Magnum

See https://github.com/F43nd1r/zachtronics-leaderboard-bot/wiki/How-to-submit-from-within-the-game

Build

  1. Set up docker-compose, create a discord bot, create a reddit app, get a github personal access token. Follow respective guides.

  2. Run gradle:

    ./gradlew build

  3. Run via docker-compose: docker-compose-example Alternatively to build . you can use prebuilt image: f43nd1r/zachtronics-leaderboard-bot:latest. This makes the gradle build obsolete.

The used github repositories are hardcoded into each leaderboard. You'll need to change those if the supplied github account does not have access to the original ones.