osu-stats-signature

Caution

The project has hit the Vercel rate limit and was paused by Vercel. It's recommended to fork this repo and deploy your own instance on Vercel for better uptime. Update: Migrated to Cloudflare workers: https://osu-sig.s23.moe/ , please use this link instead.

Languages

• English
• 中文

English

Introduction

osu-stats-signature can generate osu! profile cards/signatures that update in real-time, in SVG format. These can be used on osu! user profiles and so on.

Usage

The project is deployed on Vercel. Visit osu-stats-signature.vercel.app to generate.

Insert the generated URL to SVG as an image on the desired place.

Self-hosting

User data is fetched through the official osu! API (v2), which requires an OAuth application. Create one at osu! account settings → OAuth, then set these environment variables:

Variable	Description
OSU_CLIENT_ID	OAuth application client ID
OSU_CLIENT_SECRET	OAuth application client secret

• Vercel / Node: set them as environment variables (a local .env or the project settings).
• Cloudflare Workers: wrangler secret put OSU_CLIENT_ID / wrangler secret put OSU_CLIENT_SECRET (for wrangler dev, put them in .dev.vars).

If the credentials are not set, the app falls back to scraping the osu! website, which is prone to rate limiting (HTTP 429). Scraping can also be requested explicitly per card by adding &source=web to the URL.

Features & TODO

• Fetch osu! account information and generate cards
• Fetch and display avatar and user cover
• Cover blur support
• Intro animation
• Display Supporter Tag
• English translation
• Mini card
• Caching mechanism
• Generate personal best cards
• Generate detailed cards of individual scores

Preview

Full

With osu!skills chart

Mini

---

中文

简介

osu-stats-signature 可以生成实时更新的 osu! 个人资料卡片/签名档。生成的卡片为 SVG，可用于个人主页。

使用

该项目部署在 Vercel 上，前往 osu-stats-signature.vercel.app 生成卡片。

将得到的卡片 SVG 地址作为图片插入到个人主页中即可。

自建部署

用户数据通过 osu! 官方 API (v2) 获取，需要一个 OAuth 应用。在 osu! 账号设置 → OAuth 中创建后，配置以下环境变量：

变量	说明
OSU_CLIENT_ID	OAuth 应用的 client ID
OSU_CLIENT_SECRET	OAuth 应用的 client secret

• Vercel / Node：作为环境变量配置（本地 .env 或项目设置中）。
• Cloudflare Workers：wrangler secret put OSU_CLIENT_ID / wrangler secret put OSU_CLIENT_SECRET（wrangler dev 时写入 .dev.vars）。

若未配置，则会退回到抓取 osu! 网页的方式，该方式容易触发速率限制 (HTTP 429)。也可以在卡片 URL 后加上 &source=web 来单独指定使用网页抓取。

功能 & TODO

• 获取 osu! 账号信息并生成卡片
• 获取并显示头像和用户背景图片
• 支持背景图片高斯模糊
• 过渡动画
• 显示 Supporter Tag
• 英文版卡片
• Mini 卡片
• 缓存机制
• 生成个人 bp (最佳成绩) 卡片
• 生成单个成绩详情卡片

预览

Full

With osu!skills chart

Mini

osu-stats-signature

简介

osu-stats-signature 可以生成实时更新的 osu! 个人资料卡片/签名档。生成的卡片为 SVG，可用于个人主页。

使用

该项目部署在 Vercel 上，前往 osu-stats-signature.vercel.app 生成卡片。

将得到的卡片 SVG 地址作为图片插入到个人主页中即可。

功能 & TODO

• 获取 osu! 账号信息并生成卡片
• 获取并显示头像和用户背景图片
• 支持背景图片高斯模糊
• 过渡动画
• 显示 Supporter Tag
• 英文版卡片
• Mini 卡片
• 缓存机制
• 生成个人 bp (最佳成绩) 卡片
• 生成单个成绩详情卡片

预览

Full

With osu!skills chart

Mini