Fascinated/scoresaber-pp-to-rank-overlay
1
0
Fork 0
Code Issues 1 Pull Requests 9 Actions Activity

update readme

Browse Source
This commit is contained in:
Lee 2023-11-22 15:37:50 +00:00
parent c64f38eec7
commit 2fc7257929
1 changed files with 10 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
README.md
View File

@ -1,36 +1,14 @@
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
# Scoresaber PP to Rank Overlay
## Getting Started
Nothing fancy, just made this for me and a friend but feel free to use it. </br>
The text is white, so it you won't be able to see it. It will show up on OBS though.
First, run the development server:
## Usage
```bash
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
```
Usage: <https://ss-pp-to-rank-overlay.fascinated.cc/?id=YOUR_SCORESABER_ID&rank=1&started=START_TIME_IN_MILIS> </br>
Example:
<https://ss-pp-to-rank-overlay.fascinated.cc/?id=76561198449412074&rank=1000&started=1700575968398>
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
## Learn More
To learn more about Next.js, take a look at the following resources:
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
## Deploy on Vercel
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
- ID: Your scoresaber ID
- Rank: The rank you want to get to
- Started: The time you started the song in miliseconds. You can get this at <https://www.unixtimestamp.com>