https://github.com/spikehd/saberbot
Discord bot for interfacing with Scoresaber and Beatsaver
https://github.com/spikehd/saberbot
Last synced: 8 months ago
JSON representation
Discord bot for interfacing with Scoresaber and Beatsaver
- Host: GitHub
- URL: https://github.com/spikehd/saberbot
- Owner: SpikeHD
- License: gpl-3.0
- Created: 2020-12-07T03:55:24.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2021-02-28T05:00:40.000Z (over 5 years ago)
- Last Synced: 2025-01-17T22:44:52.561Z (over 1 year ago)
- Language: JavaScript
- Size: 34.2 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SaberBot
Discord bot for interfacing with Scoresaber and Beatsaver
Invite link: https://discord.com/api/oauth2/authorize?client_id=785384457481355294&permissions=67584&scope=bot
# Usage
* `$user [name or id]` - Get scoresaber user information on a player using their ID or name. Will throw an error if there is more than one user with a given name
* `$scores [name or id]` - Get scoresaber leaderboard information on a player using their ID or name. Will throw an error if there is more than one user with a given name
* `$findmaps [search query]` - Search for Beatsaver maps using a query.
* `$getmap [hash or key]` - Get information on a Beatsaver map using its hash or ID.
The Scoresaber and Beatsaver API wrappers used in this project were both written by me, you can check them out here:
* [ScoreSaber](https://www.npmjs.com/package/node-scoresaber)
* [Beatsaver](https://www.npmjs.com/package/beatsaver)
# Setup
* Clone the repo (`git clone https://github.com/SpikeHD/SaberBot.git`)
* Set up a bot user [here](https://discord.com/developers/applications)
* Invite the bot to your server (use the OAuth section to generate a link by selecting the "bot" checkbox)
* Create a copy of the example configuration and fill in the values (`cp example.config.json config.json`)
* `npm install` to install dependancies
* `node index`
# Contributing
Issues, PRs, etc. all welcome!