Skip to content

Latest commit

 

History

History
82 lines (59 loc) · 3.25 KB

README.md

File metadata and controls

82 lines (59 loc) · 3.25 KB

🎮 3D Rendering Engine with basic Fluid Simulation

A Python-based 3D rendering engine using Pygame library, featuring a Rubik's Cube model display and trivial fluid simulation effects. This project was inspired by and builds upon concepts learned from YouTube tutorial on 3D Engine and Technology of Raycasting.

🎬 Visual Showcase - Watch on YouTube or wait for the GIF to load

Start Screen

✨ Features

• 🖼️ 3D Object Rendering: Loads and displays 3D models from OBJ files

• 🎥 Interactive Camera: Full 360° navigation with keyboard controls

• 🧮 Matrix Transformations: Support for translation, rotation, and scaling

• 🌊 Water Simulation: basic fluid surface with wave animations

🔧 Technical Implementation

• Projection Pipeline: Implements a complete 3D rendering pipeline with perspective projection matrices

• Homogeneous Coordinates: Uses 4D homogeneous coordinates for all transforms (translation, rotation, scaling)

• Camera System: First-person camera with view matrix composition from position and orientation vectors

• Object Loading: Custom OBJ file parser that extracts vertex and face data

• Wave Algorithm: Procedural water waves using layered sine functions with time-based animation

🎮 Controls

Camera Controls

• W/A/S/D: Move camera forward/left/backward/right

• Q/E: Move camera up/down

• Arrow Keys: Rotate camera view

⚙️ Installation

  1. 📥 Clone the repository: 
    git clone https://github.com/yourusername/3d-engine-py.git
cd 3d-engine-py
  2. 🐍 Create a virtual environment and activate it: 
    python -m venv venv
source venv/bin/activate  # On Windows use `venv/Scripts/activate`
  3. 📦 Install dependencies: 
    pip install -r requirements.txt # On Windows if pip is not recognized, try: `py -m pip install -r requirements.txt`
  4. 🕹️ Run the Engine: 
    python main.py

📂 Project Structure

3d-engine-py/
├── main.py               # Entry point and main rendering loop
├── camera.py             # Camera implementation with movement controls
├── object_3d.py          # 3D object representation and rendering
├── projection.py         # Matrix projection utilities
├── matrix_functions.py   # Mathematical transformation functions
├── water.py              # Water surface simulation with wave effects
|
├── resources/            # Different 3d models and objects for display
|├── RubixCube.obj
|├── skull.obj
|
├── screenshots/
|├── visual_showcase.gif
|├── visual_showcase.jpg
|
├── requirements.txt
└── README.md‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎# This file

🙏 Acknowledgements

This project was inspired by tutorials on 3D graphics programming fundamentals available on YouTube, particularly Creating a 3D Engine with Python by Coder Space. The core concepts were learned from these educational resources and extended with additional features like the water simulation.