ryo-ma / github-profile-trophy

🏆 Add dynamically generated GitHub Stat Trophies on your readme

GitHub Profile Trophy

🏆 Add dynamically generated GitHub Stat Trophies on your readme

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

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)

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)

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.

Secret Rank

The acquisition condition is secret, but you can know the condition by reading this code.

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

1. Title name of aggregation target.
2. Current Rank.
3. Title according to rank.
4. Target aggregation result.
5. Next Rank Bar. The road from the current rank to the next rank.

Optional Request Parameters

• title
• rank
• column
• row
• theme
• margin-w
• margin-h
• no-bg
• no-frame

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

If you want to specify multiple titles.

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

If you want to specify multiple ranks.

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

You can also exclude ranks.

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

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

Adaptive column

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

You can set columns 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

flat

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

onedark

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

gruvbox

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

dracula

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

monokai

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

chalk

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

nord

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

alduin

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

darkhub

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

juicyfresh

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

buddhism

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

oldie

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

radical

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

onestar

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

discord

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

algolia

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

gitdimmed

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

tokyonight

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

matrix

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

apprentice

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

dark_dimmed

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

dark_lover

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

kimbie_dark

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

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

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

Example layout

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

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

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

Contribution Guide

Check CONTRIBUTING.md for more details.

License

This product is licensed under the MIT License.

github-profile-trophy's Issues

This Serverless Function has timed out.

followers count not getting updated

Special trophy should be animated

Special trophy should be animated, it is rainbowy, please, animate :)

Can add trophy for Code review

Change from ranks to achievements

I just discovered your project, and I think it's fantastic! I immediately applied it to my own profile, and I couldn't be happier!

But I did want to point out that if you allow users to determine their own rank, then naturally they will want to assign themselves a higher rank to make themselves look better. This will hurt your project's credibility, because there is nothing stopping someone from being deceptive. I believe you may have been inspired by the letter grade produced by the github-readme-stats project?

However, if you adapt this idea to make achievement-style badges that cannot simply be faked by users, then I believe your project will have a very prosperous future. There will no longer be a need to serve precisely 6 trophies, you can serve as many achievements as the user's profile has earned according to your system.

I thank you for your effort, and I have starred and watched your repo.

Organization support

Please support repository of a user and the repository of the organization to which the user joins.
I think it is mainly suitable for users who are working within the organization.

Requst: Support stars for organization-created repositories

I have a project under an organization which has a lot of stars, but it doesn't show up on my profile unfortunately for stars. Is there a way to add a fix for this?

thank you!

• byron

Add a translation mechanism, and a way to use it in the profile

Add a translation mechanism, and a way to use it in the profile, maybe Transifex is useful for this?

FEAT: Theme param?

I think it would be neat if this project supported an optional theme param.
For example ?theme=gruvbox could change rank bar from #0366d6 to #fabd2f.

What do you think?

Word-Filter

I think that it would be best if the template was to include more filtered words.

Wrong repo I do apologise!

[TROPHY SUGGESTION] Contributor Trophy

This trophy would be given to users who have contributed to this repository. It would be called something like "Power Contributor",

If there are any details that I forgot to add, let me know!

Add Fork trophy

We want a trophy demonstrating summation of forks of all repository. There is one javascript project counting total forks.

Split GitHub GraphQL API request in two

It's not working

It gives this error:

re-post to echojs

Sorry... cleaning out spam, and accidentally deleted your post. Feel free to repost.

Change rank system from C B A AA AAA S SS SSS to F E D C B A S SS

Change rank system from C B A AA AAA S SS SSS to F E D C B A S SS. The rationale is purely to make it more readable, as more people would understand the US grading system, than the current implementation. This is similar to OSU!'s rating system.

🏆Looking for the new themes

There are still a few trophy color themes.🏆
Waiting for your contributions.

You can add a new theme to the following file.

https://github.com/ryo-ma/github-profile-trophy/blob/master/src/theme.ts

How to run.

https://github.com/ryo-ma/github-profile-trophy#contribution-guide

Limit and Page parameters

I've been looking at adding this to my portfolio, but the fact it's a singular image in a col*row arrangement makes this poor for responsiveness. There is a hacky way where you can have several images and filter for each trophy. But I feel that misses something and could break ordering in the future.

It would be nice if there were 2 more parameters:

• limit - limits the total amount of trophies in an images
• page - cycles through the list, aka pagination

For example if you had 8 trophies (A,B,C,D,E,F,G,H). To get just the first 3 (A,B,C), you could set limit=3 and nothing for page, which can be done with row*col. For a second set (D,E,F) of 3, which would be limit=3 and page=2, which can't be achieved with row*col.

Additionally, one could add an offset, but I personally see no value in it in this case.

Special trophy being just S makes no sense

This is just S, but for other trophies there are double S and triple S ranks, but not for this one?

[Feature Request] Transparent Background

Would be nice to have an option to have a transparent background, cause github now supports dark theme.

Add gaps?

This project is great, but the trophies sticking to the other stuff doesn't seem to look very nice. I think adding a (changeable) gap would make it better!

Line wrap

Kinda happy to I get the hidden trophy 😝, however I hope they could be present in the same line instead of wrapping.

Bug

There is some bug

Some errors

Stopped working. Before everything was fine

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

Redirect to Docs

1. Please add redirect domain to docs here
2. Please host docs via readme on github page

[Feature Request] Option for Centered Last Row

It is helpful when the image is rendered within p that is aligned center.
For compatibility, this can be set to be false by default.

Example use case is here: https://github.com/Penguinlay/Penguinlay

[Feature Request] Please add discord-old-blurple.

Here's the theme: anuraghazra/github-readme-stats@2b0efb8

Themed trophies not updating

seems to be an issue with at least some themes not updating.
see attached photo.

Add Documentation for Buddhism and Oldie Themes

Just the two new themes that I've noticed that are still undocumented.
I'd do it myself but it seem's you have a documentation convention I don't want to mess up ;P.

Unknown title of Followers trophy

It's showing Unknown even though I have 3 followers.

Problem with `504 time out`

As example:

https://github-profile-trophy.vercel.app/?username=batazor&theme=gruvbox&row=1&column=8&no-frame=true

What can we do to bypass the query time limit?

Include Private Repo PRs

The commit trophy counts the commits of public + private repos, but, the pull request trophy counts only public pull requests, can anybody fix this??

This Serverless Function has timed out.

Make the "points" actually meaningfull at a glance

Make the "points" actually meaningfull at a glance. Off the top of my head this would be done by replacing "pt" with the actual metric used in each trophy. Like "issues" or "stars", etc.

Make it possible for the trophies to be graded on a curve

Make it possible for the trophies to be graded on a curve, maybe as an option: C and B would be below the mean, and A AA AAA, would be above, maybe > 50% > 90% and > 95% respectively, S SS SSS would be >99%, >99.9% and on the first 1000 respectively.

website link is not working.

website link in repo description is not working, is says "Can not find a query parameter: username"

2020 Trophy Text Cut-off Error

The 2020 Secret Trophy is getting its text cut-off, as shown in the screenshot below. Also, what is the point of that trophy, why is it more important than other years?

[Idea] Merging statistics with GitLab

I know the project currently takes stats from GitHub, but sometimes some developers use both GitHub and GitLab (or Bitbucket, etc.) Is there a possibility to optionally merge the stats with GitLab?
Since the readme tries to show the time spent on development, I think it would be nice to show the totality and not just one platform. (Although I also understand that, if accepted, it is an improvement that does not happen overnight 😛 ).
Thank you! 😄

Add a trophy type for the contributed to section

How about adding a trophy type for the number of repositories that someone contributed to. It's also there on the Github Readme Card in the last row. So, Definitely, it can be fetched from API. Also, there's another trophy type can be added for number of code reviews.

Code review

Please add code review trophy

Improve Requirements for Organization Secret Trophy

After finding out that the new secret trophy requires the person to be in [REDACTED] organizations, the first reaction would be to make [REDACTED] organizations to get it. Unsurprisingly this works, however it doesn't seem right. Instead there should be checking and requirements on the organizations before awarding the trophy:

Proposals:

1. The organization must be (at least) a week old
2. The organization must contain more than one account
3. The organization must contain one or more repositories
4. The person should be in at least one organization that was not created by them* **

* I believe this one might be controversial. Any thoughts?
** Dropped this

🏆Looking for new trophy types

If you have any ideas please let us know.
The target of aggregation is preferable to be able to obtain it using GitHub API.

Add Theme

I created a new theme named gitdimmed, so, @ryo-ma , can you update README.md and, add my theme??
Theme Name: GitDimmed
Author: MrBlueBird2 (Badri Vishal)
Theme Example: https://github-profile-trophy.vercel.app/?username=MrBlueBird2&row=2&column=6&theme=gitdimmed&column=8&no-frame=false&no-bg=false%22

Please remove joined 2020

github-profile-trophy/src/trophy.ts

Line 138 in 5e6027e

export class Joined2020Trophy extends Trophy{

Please remove Joined 2020 ( everything started ) and remove ancient user and add as years.

Like this python code

if year < 1:
    description = "everything started"
elif year > 1 and year < 10:
    description = "next description"
else:
    description = "Ancient user"

Why do i 59.2k points for issues?

https://github-profile-trophy.vercel.app/?username=nainardev

Have a dedicated page for the trophies

Make that clicking the trophies explains what they are and what the points mean.

Include Private And Forked Repos

Please Add one more query for including private repos and forked repos count In Repositories Trophy.

Request to add a github action

I see that the repo is quite engaging
I would love to see a github - action welcoming all the new contributors on their issues and Prs

If you love the idea , assign me

Count more languages in Repositories

Heya!

So there is no reasonable way to get the Multiple Language User trophy unless you make repositories purely coded in one language. Instead of querying for the first most used language in a repository could you possibly check for the top 3 most used languages in a repository? That way languages that don't really get used a lot in bytecode can also be factored into consideration.

Thanks!

Also, congrats on 1000 stars! 🎉

Multilanguage giving wrong result

Multilanguage of GitHub trophy is giving wrong results I have 16 unique languages public repos but it showing only 14 kindly help.
Thank You.