codestats-skyline/README.md

47 lines
1.4 KiB
Markdown

# Code::Stats Skyline
<a href="https://discord.gg/QNupZ4Ywxf">
<img src="https://img.shields.io/discord/1143555541004726272?color=%235865F2&label=Discord" alt="Discord Link">
</a>
<a href="https://github.com/Aviortheking/codestats-skyline/stargazers">
<img src="https://img.shields.io/github/stars/Aviortheking/codestats-skyline?style=flat-square" alt="Github stars">
</a>
Tool to generate an STL using your Codestats Total XPs
[Based on Github's Skyline](skyline.github.com)
[Idea by @ColinM#7415](https://discord.com/channels/510060567298310144/510060567298310146/1049790442964783114) on the [Code::Stats Discord](https://discord.gg/gyzRfjc)
| Source | Result |
|------------------------------|--------------------------------|
| ![](./.github/codestats.png) | ![](./.github/prusaslicer.png) |
## How to generate
Go to the following URL and appends your username like below
```
https://codestats-skyline.avior.me/?username=Aviortheking
```
It will generate and allows you to download the generated STL!
### render a specific year
You can also render a specific year!
simply add the year to the URL
```
https://codestats-skyline.avior.me/?username=Aviortheking&year=2021
```
and voilà!
## Deploy the tool yourself!
You can use the Dockerfile to deploy the tool yourself!
_Code will be refactored as it has been done quickly :p_