🎮 Advanced Game Engine with Multiplayer & Scripting

A sophisticated Platformer Game Engine developed for the Game-Engine-Foundations course (CSC581) that demonstrates advanced computer science concepts through practical implementation. Features multiplayer networking, JavaScript scripting integration, and multiple deployment options.

🎯 Project Overview

This project showcases a complete game engine implementation featuring:

• Multi-Platform Support: Windows, macOS, Linux
• Real-time Multiplayer: Client-server architecture with ZeroMQ
• JavaScript Scripting: V8 engine integration for runtime scripting
• Advanced Graphics: SFML-based rendering with custom shapes
• Docker Containerization: Multiple deployment options
• Event System: Custom event handling with script callbacks
• Physics Engine: Collision detection and movement mechanics

✨ Key Features

🎮 Core Game Engine

• Object-Oriented Design: Inheritance, polymorphism, and encapsulation
• Custom Shapes: PentagonShape extending SFML's Shape class
• Physics Simulation: Collision detection, gravity, and movement
• Replay System: Record and playback game sessions
• Pause/Resume: Full game state management
• Variable Speed: 0.5x, 1x, 2x game speed options

🌐 Multiplayer Networking

• Client-Server Architecture: ZeroMQ-based messaging
• Real-time Synchronization: Character positions and game states
• Multiple Clients: Support for multiple simultaneous players
• Network Optimization: Efficient state management and updates

📜 JavaScript Scripting

• V8 Engine Integration: Full JavaScript runtime support
• Hot Reloading: Live script updates during development
• Event Callbacks: Script-based event handling
• Native Integration: Seamless C++ to JavaScript communication

🎮 Implemented Games

1. Platformer Game (Base Engine)

• Character movement and jumping
• Platform collision detection
• Color modification through scripts
• Physics-based movement

2. Space Invaders

• Enemy spawning and movement patterns
• Bullet shooting system
• Collision detection for scoring
• Event-driven game mechanics

3. Flappy Bird

• Physics-based bird movement
• Obstacle generation and collision
• Score tracking system
• Boundary detection

🏗️ Architecture

┌─────────────────┐    ┌─────────────────┐
│   Game Client   │    │  Game Server    │
│   (Docker)      │◄──►│   (Docker)      │
│   - SFML GUI    │    │   - State Mgmt  │
│   - V8 Scripts  │    │   - Networking  │
│   - Physics     │    │   - Multiplayer │
└─────────────────┘    └─────────────────┘
         │
         ▼
   Display Options:
   - X11 Forwarding
   - VNC Web Interface
   - Headless Mode

🚀 Quick Start

Native Build (Requires Build Tools)**

Prerequisites

• C++17 compiler (GCC/Clang)
• SFML 2.5+
• ZeroMQ
• V8 JavaScript Engine
• CMake (optional)

Build Instructions

# Server
cd server
g++ -c game_server.cpp -lzmq
g++ game_server.o -o game_server -lsfml-graphics -lsfml-system -lsfml-window -lzmq -pthread
./game_server

# Client
make
./main

📦 Installation Options

Windows

1. Native Build
   • Install Visual Studio Build Tools
   • Install vcpkg for dependencies
   • Follow build instructions

macOS

1. Native Build
   • Install Xcode Command Line Tools
   • Install dependencies via Homebrew
   • Follow build instructions

Linux (Ubuntu)

1. Native Build

   sudo apt install build-essential libsfml-dev libzmq3-dev libv8-dev
   make

🎮 Game Controls

Universal Controls

• A: Move Left
• D: Move Right
• Space: Jump/Shoot
• P: Pause/Unpause
• R: Record/Play Replay
• Q: Change Speed (0.5x, 1x, 2x)
• E: Resize (with title bar button)

Game-Specific Controls

• Space Invaders: Space to shoot bullets
• Flappy Bird: Space to flap wings
• Platformer: A/D for movement, Space to jump

Script Triggers

• A + D (Chord): Triggers death script
• Movement: Triggers color modification script
• Collisions: Triggers event handling scripts

🔧 Development

Project Structure

Game-Engine-main/
├── 📁 assets/              # Game assets (images, videos)
├── 📁 scripts/             # JavaScript game scripts
├── 📁 server/              # Game server implementation
├── 📁 Versions/            # Homework progression (HW1-HW5)
├── 📄 game.cpp             # Main game engine (1199 lines)
├── 📄 ScriptManager.*      # JavaScript integration
└── 📄 v8helpers.*          # V8 JavaScript helpers

Scripting System

The engine supports JavaScript scripting through V8:

// Example: modify_color.js
function getRandomColor() {
    return Math.floor(Math.random() * 0xFFFFFF);
}

print("Modifying GameObject Through Script");
platform.color = getRandomColor();

Adding New Games

1. Create new game logic in game.cpp
2. Add game-specific controls
3. Implement collision detection
4. Add JavaScript event handlers
5. Update Docker configurations if needed

📚 Learning Progression

This project demonstrates progression through 5 major assignments:

HW1: Object-Oriented Programming

• Basic C++ classes and inheritance
• SFML graphics integration
• Custom shape implementation

HW2: Networking & Multiplayer (5 parts)

• ZeroMQ integration
• Client-server communication
• Real-time state synchronization
• Multiple client support

HW3: Advanced Networking

• Multiple server architecture
• JSON-based communication
• Enhanced state management

HW4: Game Mechanics (3 parts)

• Physics simulation
• Collision detection
• Game state management
• Replay system

HW5: Scripting Integration (3 parts)

• V8 JavaScript engine
• Script management system
• Event-driven programming
• Hot reloading

🛠️ Technical Details

Dependencies

• SFML 2.5: Graphics, window management, input handling
• ZeroMQ: High-performance messaging library
• V8: JavaScript engine for scripting
• Docker: Containerization and deployment
• X11/VNC: Display forwarding for GUI

Build System

• Makefile: Cross-platform build configuration
• Docker: Multi-stage builds for optimization
• CMake: Alternative build system support

Performance

• Multi-threading: SFML Mutex for thread safety
• Memory Management: RAII and smart pointers
• Network Optimization: Efficient state updates
• Graphics: Hardware-accelerated rendering

📸 Screenshots & Videos

Game Screenshots

Demo Videos

• Platformer Gameplay
• Space Invaders Demo
• Flappy Bird Demo

🤝 Contributing

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

Development Guidelines

• Follow C++17 standards
• Use meaningful variable names
• Add comments for complex logic
• Test on multiple platforms
• Update documentation

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

👨‍💻 Author

Madhur Dixit - Game Engine Foundations Course (CSC581)

🎯 Project Status

✅ Completed - All features implemented and tested

---

🆘 Troubleshooting

Common Issues

X11 Issues

• Display not found: Check DISPLAY environment variable
• Connection refused: Restart X11 server
• Permission denied: Run xhost +local:docker

Network Issues

• Connection timeout: Check firewall settings
• Port not accessible: Verify port forwarding
• Server not responding: Check server logs

---

🎮 Enjoy your advanced game engine with multiplayer and scripting capabilities!