Files
blackroad-pixel-city/docs/FEATURES.md

4.5 KiB

Features Overview

🎨 Visual Features

Enhanced Graphics

  • Pixel Art Style: Authentic retro gaming aesthetic with hand-crafted sprites
  • Dynamic Shadows: Buildings cast realistic shadows
  • Smooth Animations: 60 FPS rendering with fluid movement
  • Color Palette: Carefully curated Pokemon-themed colors

Environmental Elements

  • Animated Water: Living pond with rippling water effects
  • Swaying Trees: Trees gently sway in the breeze
  • Varied Buildings: 7 different building styles including houses, shops, and Pokemon Center
  • Road System: Detailed roads with lane markings and crosswalks
  • Grass Texture: Subtle grass details for depth

🐾 Pokemon System

Available Pokemon (4 Species)

  • Pikachu: The iconic electric mouse with rosy cheeks
  • Bulbasaur: Grass starter with bulb on back
  • Charmander: Fire starter with flame tail
  • Squirtle: Water starter with shell

Pokemon Features

  • Smooth hopping animation
  • Sparkle effects
  • Autonomous roaming behavior
  • Species-accurate colors and designs
  • Random movement patterns

👥 NPC System

NPC Types

  • Trainers: Wearing red caps and ready for battle
  • Ace Trainers: Elite trainers in blue
  • Citizens: Regular townspeople

NPC Behaviors

  • Walking animation with arm and leg movement
  • Random pathing across the city
  • Stay within city bounds
  • Varied movement speeds
  • Realistic direction changes

🏗️ Building System

Building Types

  • Houses: Residential buildings with triangle roofs and windows
  • Pokemon Center: Red cross emblem for healing Pokemon
  • Shops: Commercial buildings with large display windows

Building Details

  • Multiple color schemes (red, blue, yellow, orange, purple)
  • Detailed roofs with outlines
  • Window designs with panes
  • Functional-looking doors with knobs
  • Shadow effects for depth

🌳 Nature Elements

Trees

  • Three size variations (small, medium, large)
  • Swaying animation
  • Layered leaves for depth
  • Realistic trunk textures

Water Features

  • Animated pond
  • Ripple effects
  • Depth variation with color gradients

⚙️ Technical Features

Performance

  • Optimized 60 FPS rendering
  • Efficient sprite system
  • Configurable quality settings
  • FPS monitoring available

Customization

  • Easy color scheme modification
  • Adjustable movement speeds
  • Configurable entity limits
  • Toggle-able effects (shadows, particles)

Interactive Controls

  • ESC: Exit game
  • F: Toggle FPS display
  • SPACE: Spawn random Pokemon
  • More controls coming soon!

📊 Configuration System

All settings in src/utils/config.py:

SCREEN_WIDTH = 800          # Window width
SCREEN_HEIGHT = 600         # Window height
FPS = 60                    # Target frame rate
MAX_NPCS = 8               # NPC population
MAX_POKEMON = 6            # Pokemon population
NPC_SPEED = 1              # NPC movement speed
POKEMON_SPEED = 0.5        # Pokemon movement speed
ENABLE_SHADOWS = True      # Shadow rendering
SHOW_FPS = False           # FPS counter

🎯 Planned Features (Roadmap)

Near Future

  • Player character control
  • Pokemon encounters
  • Dialog system for NPCs
  • Day/night cycle
  • Weather effects (rain, snow)
  • More Pokemon species (Eevee, Meowth, Psyduck, etc.)

Medium Term

  • Sound effects and music
  • Pokemon battles (turn-based)
  • Inventory system
  • Quest system
  • Save/load functionality
  • Interactive buildings (enter houses, visit Pokemon Center)

Long Term

  • Multiplayer support
  • Custom map editor
  • Pokemon evolution system
  • Trading system
  • Achievement system
  • Mobile port

🛠️ Developer Features

Modular Architecture

  • Clean separation of concerns
  • Easy to extend and modify
  • Well-documented code
  • Object-oriented design

Easy Customization

  • Add new Pokemon with simple template
  • Create new buildings with flexible system
  • Customize colors via palette
  • Adjust any behavior via config

Development Tools

  • FPS monitoring
  • Entity spawn testing
  • Configuration system
  • Comprehensive documentation

🌟 Quality of Life

  • Automatic entity boundary checking
  • Smooth collision avoidance
  • Natural movement patterns
  • Visual feedback for interactions
  • Responsive controls
  • Clear on-screen instructions

📱 Cross-Platform

  • Works on Windows, macOS, Linux
  • Only requires Python 3.8+ and Pygame
  • No complex dependencies
  • Easy setup and installation

Note: This is version 2.0.0 with major enhancements. Check CHANGELOG.md for full history.