Skip to content

ryo-ma/github-profile-trophy

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

GitHub Profile Trophy

GitHub Profile Trophy

πŸ† Add dynamically generated GitHub Stat Trophies on your README

stargazers forks issues license share

You can use this service for free. I'm looking for sponsors to help us keep up with this service❀️

⚠️ Notice from the Project Owner

Hello everyone,
I am the owner of this project.

Currently, due to the increase in users and traffic, the cost of maintaining this service has become quite high, and it is becoming financially difficult to sustain.
As costs continue to rise, there is a possibility that the service may have to be discontinued.
We are now at a stage where monetization and financial support are essential.

Your support in the following ways would be greatly appreciated:

  1. Financial support: GitHub Sponsors
  2. Reducing server load through self-hosting (by forking on GitHub and deploying to Vercel)
  3. Share your github-profile-trophy URL deployed to Vercel for load balancing (Send email: [email protected] or Pull Request)

Load balancing endpoints

These are endpoints provided by volunteers. Please use these in moderation.

Quick Start

Add the following code to your readme. When pasting the code into your profile's readme, change the ?username= value to your GitHub's username.

[![trophy](https://github-profile-trophy.vercel.app/?username=ryo-ma)](https://github.com/ryo-ma/github-profile-trophy)

Image

Use theme

Add optional parameter of the theme.

[![trophy](https://github-profile-trophy.vercel.app/?username=ryo-ma&theme=onedark)](https://github.com/ryo-ma/github-profile-trophy)

Image

More detail

About Rank

Ranks are SSS SS S AAA AA A B C UNKNOWN SECRET.

Rank Description
SSS, SS, S You are at a hard to reach rank. You can brag.
AAA, AA, A You will reach this rank if you do your best. Let's aim here first.
B, C You are currently making good progress. Let's aim a bit higher.
UNKNOWN You have not taken action yet. Let's act first.
SECRET This rank is very rare. The trophy will not be displayed until certain conditions are met.

NOTE: The UNKNOWN rank is denoted by ?

Secret Rank

The acquisition condition is secret, but you can see this.

Image

There are only a few secret trophies. Therefore, if you come up with interesting conditions, I will consider adding a trophy. I am waiting for contributions.

About Display details

Image

  1. Title name of aggregation target.
  2. Current rank.
  3. Title according to rank.
  4. Target aggregation result.
  5. Rank progress bar.

Optional Request Parameters

Filter by titles

You can filter the display by specifying the titles of trophy.

https://github-profile-trophy.vercel.app/?username=ryo-ma&title=Followers

Image

If you want to specify multiple titles.

https://github-profile-trophy.vercel.app/?username=ryo-ma&title=Stars,Followers

Image

You can also exclude the trophies you don't want to display.

https://github-profile-trophy.vercel.app/?username=ryo-ma&title=-Stars,-Followers

Filter by ranks

You can filter the display by specifying the ranks.
Available values: SECRET SSS SS S AAA AA A B C

https://github-profile-trophy.vercel.app/?username=ryo-ma&rank=S

Image

If you want to specify multiple ranks.

https://github-profile-trophy.vercel.app/?username=ryo-ma&rank=S,AAA

Image

You can also exclude ranks.

https://github-profile-trophy.vercel.app/?username=ryo-ma&rank=-C,-B

NOTE: Since UNKNOWN is denoted by ?, in order to include or exclude it you will have to use rank=? and rank=-? respectively

Specify the maximum row & column size

You can specify the maximum row and column size.
Trophy will be hidden if it exceeds the range of both row and column.

Available value: number type
Default: column=6 row=3

Restrict only row

https://github-profile-trophy.vercel.app/?username=ryo-ma&row=2

Restrict only column

https://github-profile-trophy.vercel.app/?username=ryo-ma&column=2

Restrict row & column

https://github-profile-trophy.vercel.app/?username=ryo-ma&row=2&column=3

Image

Adaptive column

https://github-profile-trophy.vercel.app/?username=ryo-ma&column=-1

You can set column to -1 to adapt the width to the number of trophies, the parameter row will be ignored.

Apply theme

Available themes.

theme
flat
onedark
gruvbox
dracula
monokai
chalk
nord
alduin
darkhub
juicyfresh
buddhism
oldie
radical
onestar
discord
algolia
gitdimmed
tokyonight
matrix
apprentice
dark_dimmed
dark_lover
kimbie_dark
aura

flat

https://github-profile-trophy.vercel.app/?username=ryo-ma&theme=flat

Image

onedark

https://github-profile-trophy.vercel.app/?username=ryo-ma&theme=onedark

Image

gruvbox

https://github-profile-trophy.vercel.app/?username=ryo-ma&theme=gruvbox

Image

dracula

https://github-profile-trophy.vercel.app/?username=ryo-ma&theme=dracula

Image

monokai

https://github-profile-trophy.vercel.app/?username=ryo-ma&theme=monokai

Image

chalk

https://github-profile-trophy.vercel.app/?username=ryo-ma&theme=chalk

Image

nord

https://github-profile-trophy.vercel.app/?username=ryo-ma&theme=nord

Image

alduin

https://github-profile-trophy.vercel.app/?username=ryo-ma&theme=alduin

Image

darkhub

https://github-profile-trophy.vercel.app/?username=ryo-ma&theme=darkhub

Image

juicyfresh

https://github-profile-trophy.vercel.app/?username=ryo-ma&theme=juicyfresh

Image

buddhism

https://github-profile-trophy.vercel.app/?username=ryo-ma&theme=buddhism

Image

oldie

https://github-profile-trophy.vercel.app/?username=ryo-ma&theme=oldie

Image

radical

https://github-profile-trophy.vercel.app/?username=ryo-ma&theme=radical

Image

onestar

https://github-profile-trophy.vercel.app/?username=ryo-ma&theme=onestar

Image

discord

https://github-profile-trophy.vercel.app/?username=ryo-ma&theme=discord

Image

algolia

https://github-profile-trophy.vercel.app/?username=ryo-ma&theme=algolia

Image

gitdimmed

https://github-profile-trophy.vercel.app/?username=ryo-ma&theme=gitdimmed

Image

tokyonight

https://github-profile-trophy.vercel.app/?username=ryo-ma&theme=tokyonight

Image

matrix

https://github-profile-trophy.vercel.app/?username=ryo-ma&theme=matrix

Image

apprentice

https://github-profile-trophy.vercel.app/?username=ryo-ma&theme=apprentice

Image

dark_dimmed

https://github-profile-trophy.vercel.app/?username=ryo-ma&theme=dark_dimmed

Image

dark_lover

https://github-profile-trophy.vercel.app/?username=ryo-ma&theme=dark_lover

Image

kimbie_dark

https://github-profile-trophy.vercel.app/?username=ryo-ma&theme=kimbie_dark

Image

aura

https://github-profile-trophy.vercel.app/?username=ryo-ma&theme=aura

Image

Margin Width

You can put a margin in the width between trophies.
Available value: number type
Default: margin-w=0

https://github-profile-trophy.vercel.app/?username=ryo-ma&margin-w=15

Image

Margin Height

You can put a margin in the height between trophies.
Available value: number type
Default: margin-h=0

https://github-profile-trophy.vercel.app/?username=ryo-ma&margin-h=15

Image

Example layout

https://github-profile-trophy.vercel.app/?username=ryo-ma&column=3&margin-w=15&margin-h=15

Image

Transparent background

You can turn the background transparent.
Available value: boolean type (true or false)
Default: no-bg=false

https://github-profile-trophy.vercel.app/?username=ryo-ma&no-bg=true

Image

Hide frames

You can hide the frames around the trophies.
Available value: boolean type (true or false)
Default: no-frame=false

https://github-profile-trophy.vercel.app/?username=ryo-ma&no-frame=true

Image

Contribution Guide

Check CONTRIBUTING.md for more details.

License

This product is licensed under the MIT License.

πŸ™ Sponsors

Thank you so much to all the amazing sponsors who support this project! Your contributions help keep development going and make this work possible.

πŸ’– Monthly Sponsors

🎁 One-Time Sponsors

Releases

No releases published

Sponsor this project

 

Packages

No packages published

Contributors 58