joanroig/Generate Metrix
Metrix generates a customizable retro-style GIF showcasing GitHub metrics for your GitHub README profile.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| GITHUB_TOKEN | GitHub token for authentication | yes | — |
| GITHUB_USERNAME | GitHub username for displaying data | yes | — |
| LOG_LEVEL | Application log level | no | INFO |
| FFMPEG_LOG_LEVEL | FFmpeg log level | no | ERROR |
| FONT_SIZE | Main font size | no | 20 |
| SYMBOL_FONT_SIZE | Symbol font size | no | 20 |
| FONT_PATH | Path to the font file | no | assets/MxPlus_IBM_BIOS.ttf |
| SYMBOL_FONT_PATH | Path to the symbol font file | no | assets/MxPlus_IBM_BIOS.ttf |
| BACKGROUND_COLOR | Color of the background (CSS color names, hex codes, 'random', 'random-light', 'random-dark', 'complementary', 'contrasting', 'shade', 'shade-light', 'shade-dark') | no | random |
| TEXT_COLOR | Color of the text (CSS color names, hex codes, 'random', 'random-light', 'random-dark', 'complementary', 'contrasting', 'shade', 'shade-light', 'shade-dark') | no | random |
| MINIMUM_CONTRAST | Minimum color contrast | no | 2 |
| TEXT | Text to display | no | {username}'s GitHub Metrix ------------------------------ Joined GitHub: {created_at} Followed by: {followers} Users Owner of: {total_repos} Repos Total Commits: {total_commits} Total Stars: {total_stars} Data updated: {updated_date} |
| TYPING_CHARACTER | Character used for typing effect | no | █ |
| ACTIVITY | Enable or disable the activity section | no | true |
| ACTIVITY_TEXT | Text for the activity section | no | Last month commit activity: |
| ACTIVITY_DAYS | Number of days for activity | no | 29 |
| FPS | Frames per second for the GIF, recommended to be 50 or below | no | 50 |
| LOOP | Enable or disable looping the GIF | no | false |
| WIDTH | Width of the GIF | no | 608 |
| HEIGHT | Height of the GIF | no | 342 |
| GLITCHES | Enable or disable glitches | no | true |
| MAX_GLITCHES | Maximum amount of glitches at the same time | no | 4 |
| GLITCH_PROBABILITY | Probability in percentage of a glitch happening in a frame, between 0 and 100 | no | 3 |
| OUTPUT_FILE_PATH | Output file path for the GIF, if the path is relative it will be saved in the working directory | no | metrix.gif |
Outputs
no outputs