https://github.com/nahumsa/magic-rules-qa

Q&A with magic: the gathering rules
https://github.com/nahumsa/magic-rules-qa

Last synced: about 2 months ago
JSON representation

Q&A with magic: the gathering rules

• Host: GitHub
• URL: https://github.com/nahumsa/magic-rules-qa
• Owner: nahumsa
• License: apache-2.0
• Created: 2024-07-09T10:47:58.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-08-27T22:37:47.000Z (9 months ago)
• Last Synced: 2025-03-28T13:21:19.401Z (2 months ago)
• Language: Go
• Size: 1.05 MB
• Stars: 5
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Magic: the Gathering Rules Q&A


Welcome to the **Q&A with Magic: The Gathering Rules** project! This tool is designed to help Magic: The Gathering (MTG) players quickly find accurate answers to rules-related questions.

Whether you're a beginner or a seasoned player, this project aims to make navigating the complex rules of MTG easier and more intuitive.

![terminal](./assets/magic-qa.gif)

## Features

### Completed

- **Comprehensive Rules Database:** Access an extensive collection of rules and official rulings directly from the MTG Comprehensive Rules.

- **Search Functionality:** Use keywords or phrases to find relevant rules and explanations.

- **Vector Search:** Utilize vector search technology to quickly retrieve and rank the most relevant information from the rules database.

- **Regular Updates:** Stay up to date with the latest rules changes and errata from Wizards of the Coast.

- **GenAI Integration:** Leverage GenAI for advanced natural language understanding to enhance the accuracy and relevance of responses.

### In progress

- **Instant Q&A:** Get immediate answers to specific questions by querying the rules database.

- **User-Friendly Interface:** Clean and intuitive design for easy navigation and interaction.

## Getting Started

### Prerequisites

To run this project, you'll need:

- [Golang 1.22+](https://golang.org/dl/)

- [jina.ai](https://jina.ai/embeddings) (for embeddings)

- [QDRANT](https://qdrant.tech/) (for efficient information retrieval)

## Environment Variables

| Variable Name  | Description                                                  | Example Value               |

|----------------|--------------------------------------------------------------|-----------------------------|

| `JINA_API_KEY`   | API key for jina.ai                                          | `jina_naiasokdlnmasnd123ln` |

| `GOOGLE_API_KEY` | API key Google Gemini                                          | `asinodnoiansd12po3i2` |