gh-space-shooter

gh-space-shooter is an innovative tool that transforms GitHub contribution graphs into an engaging space shooter game. This project not only adds a fun twist to visualizing contributions but also offers a dynamic representation of coding history through interactive gameplay.

Key Features

• On-Demand GIF Generation: A user-friendly web interface allows users to create GIFs without any local installation.

• Automated Updates: With GitHub Actions, you can automate the creation of your game GIF, ensuring your game's visuals stay current without manual intervention. Simply add the provided workflow to your repository:

  name: Update Space Shooter Game
  on:
    schedule:
      - cron: '0 0 * * *'  # Daily at midnight UTC
    workflow_dispatch:  # Allows manual trigger
  permissions:
    contents: write
  jobs:
    update-game:
      runs-on: ubuntu-latest
      steps:
        - uses: actions/checkout@v4
        - uses: czl9707/gh-space-shooter@v1
          with:
            github-token: ${{ secrets.GITHUB_TOKEN }}
            output-path: 'game.gif'
            strategy: 'random'
  

• Customizable Gameplay: Choose various attack strategies for enemy movements and tweak animation speed settings. Here are some customizable parameters when generating your game:

  • username: Specify a username for which to generate the game.
  • output-path: Define where to save the generated GIF file.
  • strategy: Select from column, row, or random enemy attack patterns.
  • fps: Adjust frames per second for smooth animations.

Simple Usage

To generate a game GIF from your contributions, use the following command:

gh-space-shooter <username>

For example:

gh-space-shooter torvalds

Additionally, apply various options to customize the game:

# Changing file output
gh-space-shooter torvalds --output my-epic-game.gif
# Choosing enemy strategy
gh-space-shooter torvalds --strategy row
# Adjusting animation speed
gh-space-shooter torvalds --fps 25

Advanced Functionality

For developers looking to dive deeper, you can save raw contribution data in JSON format or load previously saved data, thus minimizing API calls:

# Save data to JSON
gh-space-shooter torvalds --raw-output data.json
# Load from JSON
gh-space-shooter --raw-input data.json --output game.gif

Data Format

The tool organizes relevant data in a structured JSON format, containing total contributions and detailed weekly performance metrics.

In summary, gh-space-shooter provides an entertaining way to visualize GitHub contributions while enhancing engagement with coding projects. Ideal for developers looking to gamify their contribution tracking, this project combines creativity with functionality.