Quick Start

This guide will get you from zero to running the game in just a few minutes.

1. Clone the Repository

First, get the source code onto your machine.

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

2. Install Dependencies

It's best to use a virtual environment. Once you've created and activated it, install the required packages.

# Create and activate a virtual environment (macOS/Linux example)
python3 -m venv venv
source venv/bin/activate

# Install all dependencies
pip install -r requirements.txt

3. Run the Game

With the dependencies installed, you can now launch the game.

python main.py

The game window should appear, displaying the main menu. From here, you can navigate using the mouse to start a new game or exit.

(Optional) 4. Generate AI Assets

If you have a compatible GPU (like an RTX 5070), you can generate the game's visual assets yourself. The game comes with pre-generated mock assets, but for the full experience, you can run the generation script.

# This command will generate backgrounds, sprites, and UI elements
python -c "from gen_assets.generate_backgrounds import AssetGenerator; generator = AssetGenerator(); generator.generate_all_hero_backgrounds(); generator.generate_all_hero_sprites(); generator.generate_all_ui_elements()"

This process may take a considerable amount of time, especially on the first run as models are downloaded.