CUB3D_1337

A raycasting engine inspired by the legendary Wolfenstein 3D, the first true FPS in videogame history. This project implements raycasting techniques to render a dynamic 3D view inside a maze from a 2D map perspective.

📋 Table of Contents

• About
• Features
• Prerequisites
• Installation
• Usage
• Map Format
• Controls
• Technical Implementation
• Resources

🎮 About

CUB3D is a 42 Network project that explores the fundamentals of raycasting, a rendering technique used in early 3D games. Using the MiniLibX library, this project creates a first-person perspective of a maze where the player can navigate through corridors with textured walls.

Key Concepts:

• Raycasting algorithm
• DDA (Digital Differential Analysis) algorithm
• Texture mapping
• Field of view rendering
• Player movement and collision detection

images

✨ Features

Mandatory

• ✅ Wall rendering with raycasting
• ✅ Different textures for each cardinal direction (North, South, East, West)
• ✅ Configurable floor and ceiling colors
• ✅ Smooth player movement (W, A, S, D)
• ✅ Camera rotation (Arrow keys)
• ✅ Map parsing and validation
• ✅ Proper error handling

Bonus

• 🎯 Wall collision detection
• 🗺️ Minimap display
• 🖱️ Mouse rotation
• 🚪 Doors (optional)
• 🎨 Animated sprites (optional)

📦 Installation

1. Clone the repository:

git clone https://github.com/msabr/CUB3D_1337.git
cd CUB3D_1337

2. Compile the project:

# Mandatory part
make

# Bonus part
make bonus

3. Clean build files:

make clean   # Remove object files
make fclean  # Remove object files and executable
make re      # Recompile everything

🚀 Usage

Run the program with a map file:

./cub3D maps/mapSubject.cub 

or

 ./cub3D_bonus maps/mapSubject.cub

The program will:

1. Parse the map file
2. Validate the map structure
3. Initialize the graphics window
4. Render the 3D environment
5. Wait for player input

🗺️ Map Format

Map files use the .cub extension and follow this structure:

NO textures/wall_Gry.xpm
SO textures/wall_Huf.xpm
WE textures/wall_Sly.xpm
EA textures/wall_Rev.xpm

F 220,100,0
C 225,30,0

        1111111111111111111111111
        1000000000110000000000001
        1011000001110000000000001
        1001000000000000000000001
111111111011000001110000000000001
100000000011000001110111111111111
11110111111111011100000010001
11110111111111011101010010001
11000000110101011100000010001
10000000000000001100000010001
10000000000000001101010010001
11000001110101011111011110N0111
11110111 1110101 101111010001
11111111 1111111 111111111111

Map Components:

Texture Paths:

• NO - North wall texture
• SO - South wall texture
• WE - West wall texture
• EA - East wall texture

Colors:

• F - Floor color (RGB format: R,G,B)
• C - Ceiling color (RGB format: R,G,B)

Map Characters:

• 1 - Wall
• 0 - Empty space (walkable floor)
• N - Player starting position facing North
• S - Player starting position facing South
• E - Player starting position facing East
• W - Player starting position facing West
• (space) - Void (outside map boundaries)

Map Requirements:

• Map must be surrounded by walls (1)
• Must contain exactly one player starting position
• Valid characters only: 0, 1, N, S, E, W, and spaces
• Map must be closed (flood fill algorithm validation)

🎮 Controls

Key	Action
W	Move forward
S	Move backward
A	Strafe left
D	Strafe right
←	Rotate camera left
→	Rotate camera right
ESC	Exit program
Mouse	Rotate view (bonus)

🔬 Technical Implementation

Raycasting Algorithm

The project implements raycasting using the DDA algorithm:

1. Ray Generation: For each vertical strip of the screen, cast a ray from the player's position
2. DDA Algorithm: Calculate ray intersection with the map grid
3. Wall Distance: Compute perpendicular distance to avoid fisheye effect
4. Wall Height: Calculate projected wall height based on distance
5. Texture Mapping: Apply appropriate texture based on wall orientation
6. Rendering: Draw vertical strips to create the 3D illusion

Key Formulas:

Fisheye Correction:

correct_distance = ray_distance * cos(ray_angle - player_angle)

Wall Height Projection:

wall_strip_height = (WALL_HEIGHT / correct_distance) * DISTANCE_TO_PROJECTION_PLANE
wall_top_pixel = (WINDOW_HEIGHT / 2) - (wall_strip_height / 2)
wall_bottom_pixel = (WINDOW_HEIGHT / 2) + (wall_strip_height / 2)

Field of View:

• Standard FOV: 60 degrees
• Window divided by width to determine ray angles
• Each ray corresponds to one vertical pixel column

📁 Project Structure

cub3D
├── Libft
│   ├── Makefile
│   ├── ft_atoi.c
│   ├── ft_bzero.c
│   ├── ft_calloc.c
│   ├── ft_is_number.c
│   ├── ft_isalnum.c
│   ├── ft_isalpha.c
│   ├── ft_isascii.c
│   ├── ft_isdigit.c
│   ├── ft_isprint.c
│   ├── ft_isspace.c
│   ├── ft_itoa.c
│   ├── ft_malloc.c
│   ├── ft_memchr.c
│   ├── ft_memcmp.c
│   ├── ft_memcpy.c
│   ├── ft_memmove.c
│   ├── ft_memset.c
│   ├── ft_putchar_fd.c
│   ├── ft_putendl_fd.c
│   ├── ft_putnbr_fd.c
│   ├── ft_putstr_fd.c
│   ├── ft_split.c
│   ├── ft_strcat.c
│   ├── ft_strchr.c
│   ├── ft_strcmp.c
│   ├── ft_strcpy.c
│   ├── ft_strdup.c
│   ├── ft_striteri.c
│   ├── ft_strjoin.c
│   ├── ft_strlcat.c
│   ├── ft_strlcpy.c
│   ├── ft_strlen.c
│   ├── ft_strmapi.c
│   ├── ft_strncmp.c
│   ├── ft_strndup.c
│   ├── ft_strnstr.c
│   ├── ft_strrchr.c
│   ├── ft_strrev.c
│   ├── ft_strstr.c
│   ├── ft_strtrim.c
│   ├── ft_substr.c
│   ├── ft_tolower.c
│   ├── ft_toupper.c
│   ├── get_next_line.c
│   └── libft.h
├── Makefile
├── README.md
├── bonus
│   ├── cub3d_bonus.h
│   ├── main_bonus.c
│   ├── parsing_bonus
│   │   ├── parse_color_bonus.c
│   │   ├── parse_fill_map_bonus.c
│   │   ├── parse_line_bonus.c
│   │   ├── parse_map_bonus.c
│   │   ├── parse_memory_bonus.c
│   │   ├── parse_player_bonus.c
│   │   ├── parse_small_map_bonus.c
│   │   ├── parse_textures_bonus.c
│   │   ├── parse_utils_bonus.c
│   │   ├── parse_validate_map_bonus.c
│   │   └── parsing_bonus.h
│   └── rendring_bonus
│       ├── exit_game_bonus.c
│       ├── game_loop_bonus.c
│       ├── ray_cast_bonus.c
│       ├── ray_cast_dda_algo_bonus.c
│       ├── ray_cast_utils_bonus.c
│       ├── rendring_bonus.h
│       ├── start_game_bonus.c
│       ├── texturing_bonus
│       │   ├── texture_draw_bonus.c
│       │   ├── texture_loading_bonus.c
│       │   ├── texture_rendering_bonus.c
│       │   ├── texture_utils_bonus.c
│       │   └── texturing_bonus.h
│       ├── utils_bonus.c
│       └── wand_animation_bonus.c
├── file.md
├── images
│   ├── Gryffindor.png
│   ├── Hufflepuff.png
│   ├── Ravenclaw.png
│   ├── Slytherin.png
│   └── cub3d.png
├── mandatory
│   ├── cub3d.h
│   ├── main.c
│   ├── parsing
│   │   ├── parse_color.c
│   │   ├── parse_fill_map.c
│   │   ├── parse_line.c
│   │   ├── parse_map.c
│   │   ├── parse_memory.c
│   │   ├── parse_player.c
│   │   ├── parse_small_map.c
│   │   ├── parse_textures.c
│   │   ├── parse_utils.c
│   │   ├── parse_validate_map.c
│   │   └── parsing_cub3d.h
│   └── rendring
│       ├── exit_game.c
│       ├── game_loop.c
│       ├── ray_cast.c
│       ├── ray_cast_dda_algo.c
│       ├── ray_cast_utils.c
│       ├── rendring_cub3d.h
│       ├── start_game.c
│       ├── texturing
│       │   ├── texture_draw.c
│       │   ├── texture_loading.c
│       │   ├── texture_rendering.c
│       │   ├── texture_utils.c
│       │   └── texturing_cub3d.h
│       └── utils.c
├── maps
│   ├── Gryffindor_map.cub
│   ├── Hufflepuff_map.cub
│   ├── Ravenclaw_map.cub
│   ├── Slytherin_map.cub
│   ├── empty_map.cub
│   ├── mapSubject.cub
│   └── map_subject.cub
├── minilibx_opengl
│   ├── Makefile
│   ├── font.c
│   ├── font.xcf
│   ├── mlx.h
│   ├── mlx_init_loop.m
│   ├── mlx_int.h
│   ├── mlx_int_str_to_wordtab.c
│   ├── mlx_mouse.m
│   ├── mlx_new_image.m
│   ├── mlx_new_window.h
│   ├── mlx_new_window.m
│   ├── mlx_opengl.h
│   ├── mlx_opengl.m
│   ├── mlx_png.c
│   ├── mlx_png.h
│   ├── mlx_rgb.c
│   ├── mlx_shaders.c
│   └── mlx_xpm.c
├── structures_headers.tldr
└── textures
    ├── DOOR.xpm
    ├── wall_Gry.xpm
    ├── wall_Huf.xpm
    ├── wall_Rev.xpm
    ├── wall_Sly.xpm
    ├── wall_simple.xpm
    ├── wall_void.xpm
    └── wand_magic
        ├── wand_magic_1.xpm
        ├── wand_magic_2.xpm
        ├── wand_magic_3.xpm
        ├── wand_magic_4.xpm
        ├── wand_magic_5.xpm
        └── wand_magic_6.xpm

15 directories, 146 files

👥 Authors

• msabr
• aylamiri

	██╗  ██╗  ██████╗   ██████╗  ██╗    ██╗  █████╗  ██████╗  ████████╗ ███████╗
	██║  ██║ ██╔═══██╗ ██╔════╝  ██║    ██║ ██╔══██╗ ██╔══██╗ ╚══██╔══╝ ██╔════╝
	███████║ ██║   ██║ ██║  ███╗ ██║ █╗ ██║ ███████║ ██████╔╝    ██║    ███████╗
	██╔══██║ ██║   ██║ ██║   ██║ ██║███╗██║ ██╔══██║ ██╔══██╗    ██║    ╚════██║
	██║  ██║ ╚██████╔╝ ╚██████╔╝ ╚███╔███╔╝ ██║  ██║ ██║  ██║    ██║    ███████║
	╚═╝  ╚═╝  ╚═════╝   ╚═════╝   ╚══╝╚══╝  ╚═╝  ╚═╝ ╚═╝  ╚═╝    ╚═╝    ╚══════╝
	                             █████╗  ██████╗ 
	                             ╚═══██╗ ██╔══██╗
	                             █████╔╝ ██║  ██║
	                             ╚═══██╗ ██║  ██║
	                             █████╔╝ ██████╔╝
	                             ╚════╝  ╚═════╝
	                   🏰 Welcome to  Hogwarts  3D Game! 🏰$
	                        ✨After All This Time ✨