git_game_show 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d79381fcfc45667688aa066066dcfcaf8c6919d3536f74fd74e45d219cf36a3a
+  data.tar.gz: 132412fc5067777c302dc3823d6df63971bb7c4e8f457a91f8a36232d8d8b9d8
+SHA512:
+  metadata.gz: d0887291e1c5e56acb46c35e029083cbb1d1e0f0472399bdb65840d747730e6b7e92aa69b2b72fe1c74db8f55ade68aa98b116397ae47a186093c684cfa672ad
+  data.tar.gz: ca47ad7efd8c54e78f178e21320c12c4505af6bea297d0bc06c656aa2d203ed1511ae76144dd036cbd01d5621581fabb0b8396f24a7efde28f28f2b8f514a141

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Justin Paulson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,110 @@
+# Git Game Show
+
+A multiplayer trivia game based on Git repository commit history.
+
+## Overview
+
+Git Game Show transforms your project's Git commit history into a live, multiplayer trivia game. One user hosts a session, other players join remotely, and the system rotates through rounds of different question-based "mini-games," awarding points and declaring a final winner.
+
+## Features
+
+- **Host a Game**: Create a game server for others to join
+- **Join Games**: Connect to games hosted by others
+- **Multiple Mini-Games**: Different question types based on Git history
+- **Real-time Multiplayer**: Compete with others over WebSockets
+- **Scoring System**: Track points and determine a winner
+
+## Installation
+
+### Option 1: Install as a Ruby Gem (Recommended)
+
+```bash
+gem install git_game_show
+```
+
+This will install the `git-game-show` command globally on your system.
+
+### Option 2: Manual Installation
+
+```bash
+# Clone the repository
+git clone https://github.com/justinpaulson/git_game_show.git
+cd git_game_show
+
+# Install dependencies
+bundle install
+
+# Build and install the gem locally
+rake install
+```
+
+## Usage
+
+### Hosting a Game
+
+To host a game session:
+
+If installed as a gem:
+```bash
+git-game-show host --repo-path /path/to/git/repo
+```
+
+If installed from source:
+```bash
+git-game-show host --repo-path /path/to/git/repo
+```
+
+Options:
+- `--repo-path`: Optional. Path to the Git repository to use (defaults to current directory).
+- `--port`: Optional. Port to run the server on (defaults to 3030).
+- `--rounds`: Optional. Number of rounds to play (defaults to 3).
+- `--password`: Optional. Password for players to join (auto-generated if not provided).
+
+A secure join link will be generated automatically with a memorable random password. Just share this link with your players.
+
+### Joining a Game
+
+To join an existing game session:
+
+If installed as a gem:
+```bash
+git-game-show join "gitgame://host_ip:port/password" --name yourname
+```
+
+If installed from source:
+```bash
+git-game-show join "gitgame://host_ip:port/password" --name yourname
+```
+
+Parameters:
+- `join link`: The secure link provided by the host (includes host address and password)
+- `--name`: Optional. Your display name in the game. If not provided, you'll be prompted.
+
+You can also simply run `git-game-show` and select "Join a game" from the interactive menu.
+
+## Mini-Games
+
+The game includes several mini-games based on Git repository data:
+
+1. **Author Quiz**: Guess which team member made each commit
+2. **Commit Message Quiz**: Match the commit message to the right changed file
+3. **Commit Timeline**: Put commits in chronological order
+4. **Complete the Commit**: Complete the missing part of commit messages
+
+## Requirements
+
+- Ruby 2.7 or higher
+- A Git repository with commit history
+- Network access between host and players
+
+## License
+
+MIT
+
+## Contributing
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add some amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request

data/bin/git-game-show

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "git_game_show"
+
+GitGameShow::CLI.start(ARGV)