Skip to content

AshrafMorningstar/README-Arcade

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

2 Commits
Β 
Β 
Β 
Β 

Repository files navigation

README-Arcade: Level Up Your Profile. README-Arcade allows you to embed playable games directly into your GitHub README. Why settle for a static bio when you can have a global leaderboard? Our engine uses GitHub Actions to process game logic and updates an SVG image displayed in your markdown. AI Review: This project is a masterclass in utilizing GitHub's infrastructure for non-traditional purposes. It solves the engagement problem for developer profiles by providing a 'sticky' interactive element. The use of SVGs ensures cross-platform compatibility without the need for external scripts. Potential for high virality is 9/10 due to the visual and social nature of the project.

πŸ“‹ Detailed Documentation

βš™οΈ API Reference

initGame(config): Initializes the game state in a JSON store. updateFrame(input): Processes input and returns a new SVG frame. renderLeaderboard(): Generates a high-score table in Markdown format.

πŸš€ Usage

To add a basic Snake game, include Snake in your README.md and enable the 'Update Game' GitHub Action.

πŸ€– AI Insight

The architecture successfully bypasses GitHub's Markdown sanitization by serving dynamic SVGs via serverless functions or local Actions. This project is optimized for social sharing and developer engagement, perfectly fitting the 'GitHub Profile' customization trend.

About

A powerful engine to create and host interactive games directly inside your GitHub README files.

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Packages

 
 
 

Contributors