BeatSnipe

I'm a bot 🤖 that tracks the scores of the players you want to snipe to generate & auto-update playlists

Special thanks to Hei5enberg44 ❤ for the codes for retrieving ranked scores & processing scores from the BSFR-Cube-Stalker project.

🛠 Installation

• Install dependencies

  • Install bun

    curl -fsSL https://bun.sh/install | bash

    Other operating systems check here for installation.

• Retrieve dependencies

  bun install

• Setup docker compose

  • Copy docker-compose.example.yml to docker-compose.yml

    cp docker-compose.example.yml docker-compose.yml
    

  • Edit docker-compose.yml

    Modify container configuration if necessary

    ⚠️ Don't forget to change the default password for mariadb container

  • Run

    docker-compose up -d

• Config environment

  • Copy .env.example to .env

    cp .env.example .env
    

  • Edit .env

    Modify .env if necessary

    ⚠️ Don't forget to change mysql connection string with your mariadb container password

• Init Prisma ORM

  bunx prisma init
  bunx prisma db push

• Run BeatSnipe

  • Run Independently

    Server (api, discord bot)

    bunx run server

    Score listener

    bunx run listener
    

  • Run all and in background

    bunx run deploy

  • Stop all

    bunx run down

💾 Manage database

Get container name of mariadb

Example: beatsnipe-mariadb-1

docker ps

• Backup database

docker exec <CONTAINER_NAME> mariadb -u root -p<DB_PASSWORD_HERE> beatsnipe > beatsnipe_backup.sql

• Restore database

  docker exec <CONTAINER_NAME> mariadb -u root -p<DB_PASSWORD_HERE> beatsnipe < beatsnipe_backuped.sql

📔 How do I add a player to BeatSnipe and create a playlist?

• Link your account

  If this is your first time using the bot, you'll first need to use the /link command with your Steam/Oculus id, which you'll usually find in the link to your Scoresaber or Beatleader page.

• Add player

  To add a player to BeatSnipe, run the command /snipe add with the player's Steam/Oculus id, which you can also find in the link to their Scoresaber or Beatleader page, then select the leaderboard(s) you want to track.

• Generate playlist

  To create a playlist for a player you've added, first do the /list command to see the list of players you're tracking to see their Steam/Oculus id, then do the /playlist command with the id of the player you've chosen in the /list command, then choose whether you want to create a Scoresaber or Beatleader playlist.

  Once the command has been executed correctly, you will be provided with a playlist file.

📙 Other Commands

• Removing a player from your list

  Use the /snipe remove command with the Steam/Oculus id of the player you want to remove from your list

• Unlink my account

  The /unlink command unlinks your Discord account and your Steam/Oculus id from Beat Snipe and deletes all the snipes you have created.

👨‍💻 Author Ralex