PixelQuest Modding Guide 🎮✨

1. Introduction to PixelQuest Modding

Welcome to the world of PixelQuest modding! This guide will walk you through creating custom mods that extend the game's functionality.

2. Mod Structure

mods/
└── your_mod_name/
    ├── mod.py           # Main mod file
    └── README.md        # Optional documentation

3. Basic Mod Template

import pygame
import random

class Mod:
    def __init__(self, game):
        # Mod metadata
        self.name = "My Awesome Mod"
        self.version = "1.0"
        self.author = "Your Name"
        self.description = "An amazing PixelQuest mod"
        
        # Store game reference
        self.game = game
        
        # Initialize mod components
        self._add_custom_blocks()
        self._add_crafting_recipes()

4. Adding Custom Blocks

def _add_custom_blocks(self):
    """Add unique blocks to the game"""
    new_blocks = {
        'magic_crystal': {
            'color': (100, 200, 255),  # Magical blue
            'solid': True,
            'mineable': True,
            'elevation': 1,
            'pushable': False,
            'light': 4,  # Emits light
            'special': 'magical_energy'
        }
    }
    
    # Add blocks to game
    for block_id, block_data in new_blocks.items():
        if block_id not in self.game.BLOCKS:
            self.game.BLOCKS[block_id] = block_data

5. Creating Crafting Recipes

def _add_crafting_recipes(self):
    """Add custom crafting recipes"""
    new_recipes = {
        'magic_crystal_lamp': {
            'magic_crystal': 3,     # 3 magic crystals
            'iron': 1,               # 1 iron
            'coal': 1                # 1 coal
        }
    }
    
    # Add recipes to game
    for recipe_id, recipe_data in new_recipes.items():
        if recipe_id not in self.game.crafting_recipes:
            self.game.crafting_recipes[recipe_id] = recipe_data

6. World Generation Hooks

def on_world_gen_post(self, level_type, *args):
    """Modify world generation"""
    # Only modify surface level
    if level_type != "surface":
        return
    
    # Validate chunk data
    if len(args) < 3:
        return
    
    chunk_x, chunk_y, chunk = args
    
    # Rare generation (e.g., 1% chance)
    if random.random() < 0.01:
        # Modify the chunk
        chunk = self._generate_custom_structure(chunk)
    
    return chunk

def _generate_custom_structure(self, chunk):
    """Create a custom world structure"""
    # Example: Add a magical crystal formation
    for x in range(10, 20):
        for y in range(10, 20):
            chunk[y][x] = 'magic_crystal'
    return chunk

7. Block Interaction Hooks

def on_block_interact(self, level_id, x, y, block_type):
    """Handle special block interactions"""
    interactions = {
        'magic_crystal': "The crystal pulses with mysterious energy!"
    }
    
    if block_type in interactions:
        # Display a message when interacting
        self.game.message = interactions[block_type]
        self.game.message_timer = 60
        return True
    
    return None

8. Conclusion

Creating a PixelQuest mod is an exciting way to extend the game's functionality. Start with small additions, experiment, and gradually build more complex modifications.

Quick Start Checklist

1. Create a new folder in the mods/ directory
2. Write your mod.py file
3. Implement the Mod class
4. Add blocks, recipes, or game mechanics
5. Test your mod in-game
6. Refine and improve

🎮 Happy Modding! Craft your own PixelQuest adventures! ✨