Cub3D is a 3D raycasting engine inspired by classic games like Wolfenstein 3D. This project recreates a first-person pseudo-3D environment using raycasting techniques. It parses map files (.cub), renders textured walls, floors, and ceilings, and includes interactive elements like doors and enemy sprites. Developed as part of the 42 school curriculum, it uses MiniLibX for graphics and handles player movement, mouse-look, and basic shooting mechanics.

• Map Parsing: Supports .cub files with textures (NO, SO, EA, WE), floor/ceiling RGB colors, and 2D grid maps.
• Raycasting Rendering: Real-time 3D projection with wall textures, doors, and distance-based scaling.
• Player Controls: WASD/arrow keys for movement, mouse for camera rotation, spacebar for door interaction, and left-click for shooting enemies.
• Sprites & Enemies: Dynamic enemy AI (chasing player), sprite sorting by distance, and crosshair-based shooting.
• Mini-Map: Overhead view with player position, walls, and doors.
• Animations: Gun firing animation and FPS counter.
• Docker Support: Containerized build and run environment for easy setup.
• Error Handling: Validates map integrity (walls, player position, doors) and RGB values.

In-game view with raycasted walls and mini-map

Crosshair on enemy sprite during combat

(Add actual screenshots to the assets/ folder and update links for your repo.)

• Ubuntu 20.04+ (or compatible Linux distro)
• Clang, Make, and X11 libraries

1. Clone the repository:

   git clone https://github.com/madamou/cub3d.git
   cd cub3d

2. Install dependencies:

   sudo apt update
   sudo apt install clang make libx11-dev libbsd-dev libxext-dev

3. Build the project:

   make all

1. Ensure Docker and Docker Compose are installed.
2. Build and run:

   docker-compose build
   docker-compose up

   • This mounts the current directory and forwards X11 for graphics.
   • Run xhost +local before starting if needed for X11 access.

1. Compile the project (see above).

2. Run with a map file:

   ./cub3D maps/test.cub

   • Example maps: maps/test.cub, maps/random.cub (generated via make random).

3. Exit: Press Escape or close the window.

• Valgrind: make leak (runs with leak checks).
• LLDB: make debug.
• Norminette & Push: make push (formats code and commits).

cub3d/
├── Dockerfile          # Docker image for build
├── docker-compose.yml  # Docker Compose setup
├── Makefile            # Build script (includes libft & minilibx)
├── includes/           # Header files (cube3D.h, parsing.h, etc.)
├── libft/              # Custom libc implementation
├── maps/               # Example .cub maps (test.cub, random.cub)
├── assets/             # Textures & sprites (walls, gun, enemies)
├── minilibx-linux/     # MiniLibX graphics library
└── srcs/               # Source code
    ├── main.c          # Entry point
    ├── parsing/        # Map parsing & validation
    ├── raycasting/     # Raycasting engine & DDA algorithm
    ├── mlx/            # MiniLibX hooks, rendering, & events
    └── utils/          # Utilities (libft extensions)

• Language: C (ANSI C89 compliant)
• Graphics: MiniLibX (X11-based)
• Libraries: Custom libft (string/memory utils, printf, GNL)
• Build Tool: GNU Make
• Container: Docker
• Compiler: Clang with -Wall -Wextra -Werror -g3

No external dependencies beyond system libs (libX11, libbsd).

• Standard: -Wall -Wextra -Werror -g3
• Optimization: Uncomment -O3 -Ofast in Makefile for faster builds.
• Dependencies: Links libft, MiniLibX, libm, libX11, libXext.

• X11 Errors: Run xhost +local for Docker/X11 forwarding.
• Map Parsing Errors: Ensure .cub files have valid format (textures before map, single player 'N/S/E/W').
• No Graphics: Verify X11 setup (echo $DISPLAY should output :0 or similar).

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

Follow 42's norminette for code style (make form to auto-format).

• Author: pepedinho and judananaa (42 Paris student)
• Inspiration: 42 School's Cub3D project
• Libraries: MiniLibX (by 42), custom libft
• Assets: Custom textures in assets/ (replace with your own for originality)

Last updated: October 2025
Questions? Open an issue or contact [email protected]/ [email protected] 🚀