haroon/osu-leaderboard
1
0
Fork 0
mirror of https://git.haroon.hackclub.app/haroon/osu-leaderboard.git synced 2024-11-23 21:23:40 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

I forgot to add a proper README

Browse source
This commit is contained in:
Haroon 2024-08-19 23:45:43 +01:00
parent 4abe8ac1cc
commit a30fe34f57
Signed by: haroon
GPG key ID: 8B96C44DDF5756E4
1 changed files with 45 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

52
README.md
View file

@ -1,15 +1,51 @@
# osu! leaderboard
To install dependencies:
osu! leaderboard is a project I worked on for Hack Club's Arcade.
It allows for users to link their osu! account to their Slack accounts and view leaderboards for each ruleset (showing linked users), as well as search beatmaps and create invites to multiplayer matches all from Slack.
```bash
bun install
This currently runs in the Hack Club Slack in the [#osu](https://hackclub.slack.com/archives/C165V7XT9) channel.
## Commands
`/osu-link`: Starts the linking process.
`/osu-leaderboard`: Shows the leaderboard of all osu! users who are linked. This can be changed to show different rulesets via a dropdown.
`/osu-profile <user>`: Search for an osu! user or a Slack user and view (if any) the link between their accounts.
`/osu-search`: Opens a modal that allows you to filter for a beatmap.
`/osu-multiplayer-invite`: If you have linked your account, you can run this command to create a message to allow people to join an osu!lazer multiplayer room you create.
## Setup
(Please note; a lot of this is hardcoded! You may need to change a few references in the code to whereever you're hosting the bot.)
1. Clone the repo:
```
$ git clone https://git.haroon.hackclub.app/haroon/osu-leaderboard.git
```
To run:
```bash
bun run index.ts
2. Create a `.env` file with the following format:
```ini
SLACK_BOT_TOKEN=<your slack bot token (xoxb)>
SLACK_SIGNING_SECRET=<your slack signing secret>
CLIENT_SECRET=<your osu! oauth app's client secret>
```
This project was created using `bun init` in bun v1.1.8. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.
3. Change the following hard-coded values (sorry!)
a. lines 9-13: edit for your postgres installation
b. line 76, 118, 152, 172: edit for your client ID and redirect URI
c. line 262: edit to a linked user's slack ID (preferably yours)
d. line 330, 443, 488, 598: edit the slack URL to your workspace's URL
e. line 786, 787, 794, 800: edit to the URL where you're hosting the bot.
4. Install packages, using your package manager of choice.
5. Run `index.ts` using `npx tsx .`, not `bun .`! (Bolt likes to be funny when you're using Bun.)
6. Voila!