Welcome to the Git Slayer Game documentation repository! This project turns GitHub/GitLab contributions into an epic adventure where your coding activities translate into experience points (XP), items, and character progression. This repository contains all the documentation and design details for the Git Slayer Game.
Note: This repository is dedicated solely to documentation. Actual game development, API, sprites, and browser extension components are managed in separate repositories.
In Git Slayer Game, contributors choose a character class that aligns with their coding style, such as Knight, Sorcerer, Paladin, or Druid. Each class has unique abilities and bonuses that enhance specific types of contributions. Contributors earn XP by performing GitHub/GitLab activities, leveling up to unlock new abilities and earn powerful items.
Our goal is to bring fun and motivation to coding, making contributions more engaging, collaborative, and rewarding.
This repository contains the following documentation files for a deeper understanding of the game’s components:
- docs/components.md: Overview of the core game components, including character classes, items, levels, and milestones.
- docs/gitactivities.md: Explanation of GitHub/GitLab activities and how they translate to XP, item rewards, and other game mechanics.
- docs/abilities-bonuses.md: Detailed descriptions of each class’s unique abilities and bonuses, enhancing specific contributions.
- docs/activity-level-tiers.md: Information on the level progression system, including XP requirements, item tiers, and player advancement.
- docs/interface.md: Details on the interactive dashboard and user interface for tracking progress, managing items, and viewing leaderboards.
- docs/user-experience.md: Insights into the intended user experience, including leveling paths, item rewards, and example gameplay scenarios.
The Git Slayer Game is developed across multiple repositories, each dedicated to a specific aspect of the project:
- documentation: This repository, containing all documentation and design details for the Git Slayer Game.
- sprites: Contains all sprite assets for characters, items, and other visual elements used in the game.
- git-slayer-api: The core API that handles game logic, XP calculations, item distribution, and more.
- chrome-addon: A Chrome extension that provides players with notifications, progress tracking, and game updates directly in their browser.
Players can choose from one of four classes:
- Knight: Defensive and stable, focused on security and robustness.
- Sorcerer: Innovative and creative, introducing new technologies and solutions.
- Paladin: Collaborative, enhancing team communication and documentation.
- Druid: Versatile, contributing to various parts of the project as needed.
Earn XP by completing GitHub/GitLab activities, including:
- Commits
- Pull Request Merges
- Issue Resolutions
- Code Reviews
- Documentation Updates
Leveling up unlocks new abilities, item rewards, and milestone challenges.
Contributors can earn items through milestones, random drops, and events. Items enhance abilities and grant additional XP bonuses for specific contributions.
A dashboard provides an interactive view of each player’s progress, items, leaderboard standings, and more.
Development for Git Slayer Game’s core logic, sprites, and browser integration is managed across multiple repositories. This repository serves as the central reference for design, rules, and documentation.
To contribute to documentation:
- Clone this documentation repository:
git clone <documentation_repo_url> cd documentation
- Review and improve documentation as needed, adding new explanations or examples to help future contributors.
Join the adventure, contribute to the project, and level up in Git Slayer Game! 🐲💪