|
1 | | -<p align="center"> |
2 | | - <img width="140" src="https://user-images.githubusercontent.com/6661165/91657958-61b4fd00-eb00-11ea-9def-dc7ef5367e34.png" /> |
3 | | - <h2 align="center">Github Profile Trophy</h2> |
4 | | - <p align="center">🏆 Add dynamically generated GitHub Trophy on your readme</p> |
5 | | -</p> |
6 | | -<p align="center"> |
7 | | - <a href="https://github.com/ryo-ma/github-profile-trophy/issues"> |
8 | | - <img src="https://img.shields.io/github/issues/ryo-ma/github-profile-trophy"/> |
9 | | - </a> |
10 | | - <a href="https://github.com/ryo-ma/github-profile-trophy/network/members"> |
11 | | - <img src="https://img.shields.io/github/forks/ryo-ma/github-profile-trophy"/> |
12 | | - </a> |
13 | | - <a href="https://github.com/ryo-ma/github-profile-trophy/stargazers"> |
14 | | - <img src="https://img.shields.io/github/stars/ryo-ma/github-profile-trophy"/> |
15 | | - </a> |
16 | | - <a href="https://github.com/ryo-ma/github-profile-trophy/LICENSE"> |
17 | | - <img src="https://img.shields.io/github/license/ryo-ma/github-profile-trophy"/> |
18 | | - </a> |
19 | | -</p> |
20 | | -<p align="center"> |
21 | | - </a> |
22 | | - <a href="https://twitter.com/intent/tweet?text=Add%20dynamically%20generated%20GitHub%20Trophy%20on%20your%20readme%0D%0A&url=https%3A%2F%2Fgithub.com%2Fryo-ma%2Fgithub-profile-trophy"> |
23 | | - <img src="https://img.shields.io/twitter/url?style=social&url=https%3A%2F%2Fgithub.com%2Fryo-ma%2Fgithub-profile-trophy"/> |
24 | | - </a> |
25 | | -</p> |
| 1 | +# Quick Start Guide |
| 2 | +This "hacked" version allows you to automatically unlock the "AllSuperRank" and "MultipleLang" secret trophies. |
26 | 3 |
|
| 4 | +Just use [my deployment (hacked-github-stat-trophies.vercel.app)]() and follow the general instructions from [the original repo](https://github.com/ryo-ma/github-profile-trophy). |
27 | 5 |
|
28 | | - |
29 | | -# Quick Start |
30 | | - |
31 | | -Add following code to your readme. |
32 | | -Change the `?username=` value to your GitHub's username. |
33 | | - |
34 | | -``` |
35 | | -[](https://github.com/ryo-ma/github-profile-trophy) |
36 | | -``` |
37 | | - |
38 | | -<p align="center"> |
39 | | - <img alig src="https://github-profile-trophy.vercel.app/?username=ryo-ma&column=6&rank=SSS,SS,S,AAA,AA,A,B,C" /> |
40 | | -</p> |
41 | | - |
42 | | -## Use theme |
43 | | - |
44 | | -Add optional parameter of theme. |
45 | | - |
46 | | -``` |
47 | | -[](https://github.com/ryo-ma/github-profile-trophy) |
48 | | -``` |
49 | | -<p align="center"> |
50 | | - <img width="660" src="https://user-images.githubusercontent.com/6661165/92327052-d99b9e00-f091-11ea-9a24-c7ec86982370.png"> |
51 | | -</p> |
52 | | - |
53 | | -**[More detail](#apply-theme)** |
54 | | - |
55 | | -# About Rank |
56 | | - |
57 | | -Ranks are `SSS` `SS` `S` `AAA` `AA` `A` `B` `C` `UNKNOWN` `SECRET`. |
58 | | - |
59 | | -| Rank | Description | |
60 | | -| ---- | ---- | |
61 | | -| SSS, SS, S | You are at a hard to reach rank. You can brag. | |
62 | | -| AAA, AA, A | You can reach the rank if you do your best. Let's aim here first. | |
63 | | -| B, C | You are in a growing process. | |
64 | | -| UNKOWN | You have not yet taken action. Let's act first. | |
65 | | -| SECRET | The rank is very rare. The trophy will not be displayed until the conditions are met. | |
66 | | - |
67 | | -## Secret Rank |
68 | | -The acquisition condition is secret, but you can know the condition by reading this code. |
69 | | - |
70 | | -<p align="center"> |
71 | | - <img width="110" src="https://user-images.githubusercontent.com/6661165/91643641-28cd4780-ea70-11ea-94a9-a51885252700.png" /> |
72 | | -</p> |
73 | | - |
74 | | -There are still few secret trophies. |
75 | | -Therefore, if you come up with interesting conditions, I am waiting for contributions. |
76 | | - |
77 | | -# About Display details |
78 | | - |
79 | | -<p align="center"> |
80 | | - <img width="220" src="https://user-images.githubusercontent.com/6661165/91642962-6333e600-ea6a-11ea-83af-e371e996bfa6.png" /> |
81 | | -</p> |
82 | | - |
83 | | -1. Title name of aggregation target. |
84 | | -2. Current Rank. |
85 | | -3. Title according to rank. |
86 | | -4. Target aggregation result. |
87 | | -5. Next Rank Bar. The road from the current rank to the next rank. |
88 | | - |
89 | | - |
90 | | -# Optional Request Parameters |
91 | | - |
92 | | -* [title](#filter-by-titles) |
93 | | -* [rank](#filter-by-ranks) |
94 | | -* [column](#specify-the-maximum-row--column-size) |
95 | | -* [row](#specify-the-maximum-row--column-size) |
96 | | -* [theme](#apply-theme) |
97 | | -* [margin-w](#margin-width) |
98 | | -* [margin-h](#margin-height) |
99 | | - |
100 | | - |
101 | | -## Filter by titles |
102 | | - |
103 | | -You can filter the display by specifying the titles of trophy. |
104 | | - |
105 | | -``` |
106 | | -https://github-profile-trophy.vercel.app/?username=ryo-ma&title=Followers |
107 | | -``` |
108 | | - |
109 | | -<p align="center"> |
110 | | - <img width="110" src="https://user-images.githubusercontent.com/6661165/92317141-80ebe700-f038-11ea-8501-4015bfbb2cf4.png"> |
111 | | -</p> |
112 | | - |
113 | | -If You want to specify multiple titles. |
114 | | - |
115 | | -``` |
116 | | -https://github-profile-trophy.vercel.app/?username=ryo-ma&title=Stars,Followers |
117 | | -``` |
118 | | - |
119 | | -## Filter by ranks |
120 | | - |
121 | | -You can filter the display by specifying the ranks. |
122 | | -`Available values: SECRET SSS SS S AAA AA A B C` |
123 | | - |
124 | | -``` |
125 | | -https://github-profile-trophy.vercel.app/?username=ryo-ma&rank=S |
126 | | -``` |
127 | | -<p align="center"> |
128 | | - <img width="110" src="https://user-images.githubusercontent.com/6661165/91642657-1cdd8780-ea68-11ea-994b-4568a55cd22a.png" /> |
129 | | -</p> |
130 | | - |
131 | | -If you want to specify multiple ranks. |
132 | | - |
133 | | -``` |
134 | | -https://github-profile-trophy.vercel.app/?username=ryo-ma&rank=S,AAA |
135 | | -``` |
136 | | - |
137 | | -## Specify the maximum row & column size |
138 | | - |
139 | | -You can specify the maximum row and column size. |
140 | | -Trophy will be hidden if it exceeds the range of both row and column. |
141 | | - |
142 | | -`Available value: number type` |
143 | | -`Default: column=6 row=3` |
144 | | - |
145 | | -Restrict only row |
146 | | -``` |
147 | | -https://github-profile-trophy.vercel.app/?username=ryo-ma&row=2 |
148 | | -``` |
149 | | - |
150 | | -Restrict only column |
151 | | -``` |
152 | | -https://github-profile-trophy.vercel.app/?username=ryo-ma&column=2 |
153 | | -``` |
154 | | - |
155 | | -Restrict row & column |
156 | | -``` |
157 | | -https://github-profile-trophy.vercel.app/?username=ryo-ma&row=2&column=3 |
158 | | -``` |
159 | | - |
160 | | -<p align="center"> |
161 | | - <img width="330" src="https://user-images.githubusercontent.com/6661165/91659474-c07f7400-eb0a-11ea-84f2-eb6b42547829.png"> |
162 | | -</p> |
163 | | - |
164 | | -## Apply theme |
165 | | - |
166 | | -Available themes. |
167 | | - |
168 | | -| theme | |
169 | | -| ---- | |
170 | | -| [flat](#flat) | |
171 | | -| [onedark](#onedark) | |
172 | | -| [gruvbox](#gruvbox) | |
173 | | -| [dracula](#dracula) | |
174 | | -| [monokai](#monokai) | |
175 | | -| [chalk](#chalk) | |
176 | | -| [nord](#nord) | |
177 | | - |
178 | | -### flat |
179 | | - |
180 | | -``` |
181 | | -https://github-profile-trophy.vercel.app/?username=ryo-ma&theme=flat |
182 | | -``` |
183 | | -<p align="center"> |
184 | | - <img width="660" src="https://user-images.githubusercontent.com/6661165/92325601-039b9300-f087-11ea-983a-fce8133549ee.png"> |
185 | | -</p> |
186 | | - |
187 | | -### onedark |
188 | | - |
189 | | -``` |
190 | | -https://github-profile-trophy.vercel.app/?username=ryo-ma&theme=onedark |
191 | | -``` |
192 | | - |
193 | | -<p align="center"> |
194 | | - <img width="660" src="https://user-images.githubusercontent.com/6661165/92327052-d99b9e00-f091-11ea-9a24-c7ec86982370.png"> |
195 | | -</p> |
196 | | - |
197 | | -### gruvbox |
198 | | - |
199 | | -``` |
200 | | -https://github-profile-trophy.vercel.app/?username=ryo-ma&theme=gruvbox |
201 | | -``` |
202 | | - |
203 | | -<p align="center"> |
204 | | - <img width="660" src="https://user-images.githubusercontent.com/6661165/92315152-e9c56600-f01c-11ea-9536-1bfbb158cfcb.png"> |
205 | | -</p> |
206 | | - |
207 | | -### dracula |
208 | | - |
209 | | -``` |
210 | | -https://github-profile-trophy.vercel.app/?username=ryo-ma&theme=dracula |
211 | | -``` |
212 | | - |
213 | | -<p align="center"> |
214 | | - <img width="660" src="https://user-images.githubusercontent.com/6661165/92490273-c91f2b00-f22b-11ea-9481-b5daae4d7bc3.png"> |
215 | | -</p> |
216 | | - |
217 | | -### monokai |
218 | | - |
219 | | -``` |
220 | | -https://github-profile-trophy.vercel.app/?username=ryo-ma&theme=monokai |
221 | | -``` |
222 | | - |
223 | | -<p align="center"> |
224 | | - <img width="660" src="https://user-images.githubusercontent.com/6661165/93725426-2c289e80-fbea-11ea-96a4-f6490ccf2126.png"> |
225 | | -</p> |
226 | | - |
227 | | -### chalk |
228 | | - |
229 | | -``` |
230 | | -https://github-profile-trophy.vercel.app/?username=ryo-ma&theme=chalk |
231 | | -``` |
232 | | - |
233 | | -<p align="center"> |
234 | | - <img width="660" src="https://user-images.githubusercontent.com/6661165/94294003-1de7d300-ff9a-11ea-91d1-60417a4d919b.png"> |
235 | | -</p> |
236 | | - |
237 | | -### nord |
238 | | - |
239 | | -``` |
240 | | -https://github-profile-trophy.vercel.app/?username=ryo-ma&theme=nord |
241 | | -``` |
242 | | - |
243 | | -<p align="center"> |
244 | | - <img width="660" src="https://user-images.githubusercontent.com/6661165/94346857-7ab2be80-006a-11eb-9082-36d377ae2531.png"> |
245 | | -</p> |
246 | | - |
247 | | - |
248 | | -## Margin Width |
249 | | - |
250 | | -You can put a margin in the width between trophies. |
251 | | -`Available value: number type` |
252 | | -`Default: margin-w=0` |
253 | | - |
254 | | -``` |
255 | | -https://github-profile-trophy.vercel.app/?username=ryo-ma&margin-w=15 |
256 | | -``` |
257 | | - |
258 | | -<p align="center"> |
259 | | - <img width="735" src="https://user-images.githubusercontent.com/6661165/93668661-e0ca9f00-fac8-11ea-9bec-325454f49fb4.png"> |
260 | | -</p> |
261 | | - |
262 | | -## Margin Height |
263 | | - |
264 | | -You can put a margin in the height between trophies. |
265 | | -`Available value: number type` |
266 | | -`Default: margin-h=0` |
267 | | - |
268 | | -``` |
269 | | -https://github-profile-trophy.vercel.app/?username=ryo-ma&margin-h=15 |
270 | | -``` |
271 | | - |
272 | | -## Example layout |
273 | | - |
274 | | -``` |
275 | | -https://github-profile-trophy.vercel.app/?username=ryo-ma&column=3&margin-w=15&margin-h=15 |
276 | | -``` |
277 | | - |
278 | | -<p align="center"> |
279 | | - <img width="360" src="https://user-images.githubusercontent.com/6661165/93668677-ff309a80-fac8-11ea-8ae3-3e3e8adbef39.png"> |
280 | | -</p> |
281 | | - |
282 | | - |
283 | | -# Contribution Guide |
284 | | - |
285 | | -## Environment |
286 | | - |
287 | | -* Deno >= v1.3.0 |
288 | | -* typescript == 3.9.7 |
289 | | -* [Vercel](https://vercel.com/) |
290 | | -* GitHub API v4 |
291 | | - |
292 | | -## Local Run |
293 | | - |
294 | | -Create `.env` file to project root directory, and write your GitHub token to the `.env` file. |
295 | | -Please select the authority of `repo` when creating token. |
296 | | - |
297 | | -``` |
298 | | -GITHUB_TOKEN=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
299 | | -``` |
300 | | - |
301 | | -Run local server. |
302 | | - |
303 | | -``` |
304 | | -deno run --allow-net --allow-read --allow-env debug.ts |
305 | | -``` |
306 | | - |
307 | | -Open localhost from your browser. |
308 | | - |
309 | | -http://localhost:8080/?username=ryo-ma |
310 | | - |
311 | | -## Editor config |
312 | | - |
313 | | -Read the [.editorconfig](./.editorconfig) |
314 | | - |
315 | | -## Run deno lint |
316 | | - |
317 | | -If you want to contribute to my project, you should check the lint with the following command. |
318 | | - |
| 6 | +If you want to automatically gain some of the other trophies, configure these booleans in [src/card.ts](https://github.com/FlyN-Nick/hacked-github-stat-trophies/blob/VegaDeftwing-master/src/card.ts) (you'll have to deploy to Vercel yourself): |
319 | 7 | ``` |
320 | | -deno lint --unstable |
| 8 | +let wantAllSuperRank = true; |
| 9 | +let wantMultipleLang = true; |
| 10 | +let wantLongTimeAccount = false; |
| 11 | +let wantAncientAccount = false; |
| 12 | +let wantJoined2020 = false; |
321 | 13 | ``` |
| 14 | +If you choose to use my deployement, it would be really appreciated if you gave me a star 🙃. |
0 commit comments