Installation Guide

This guide provides instructions for setting up the development environment for Medieval Deck.

Prerequisites

Hardware

  • For Running the Game: Any modern computer capable of running Pygame should suffice.
  • For AI Asset Generation: A powerful NVIDIA GPU is required. The project is specifically optimized for an RTX 5070 or equivalent, with at least 8GB of VRAM.

Software

  • Python 3.8+ or newer.
  • pip for package management.
  • git for cloning the repository.

Setup Instructions

Follow these steps to get the project running on your local machine.

1. Clone the Repository

Open your terminal and clone the project from GitHub:

git clone https://github.com/Noquela/MedievalDeck.git
cd MedievalDeck

2. Create a Virtual Environment

It is highly recommended to use a virtual environment to manage dependencies and avoid conflicts with other projects.

# For macOS and Linux
python3 -m venv venv
source venv/bin/activate

# For Windows
python -m venv venv
venv\Scripts\activate

3. Install Dependencies

The project's dependencies are listed in the requirements.txt file. Install them using pip:

pip install -r requirements.txt

This will install all necessary libraries, including: - pygame: The core game engine. - torch, diffusers, transformers: Libraries for the Stable Diffusion XL AI model. - xformers, accelerate: Performance optimization libraries for the AI pipeline. - Pillow, opencv-python: For image processing and enhancement.

Note: The PyTorch version specified (torch>=2.1.0+cu121) is for CUDA 12.1. If you have a different CUDA version, you may need to install a compatible version of PyTorch.