khirsig / cub3d

42 Raycaster group project

cub3d

Cub3D is a project of the 42 coding school in Heilbronn, that we needed to do for the core curriculum.
The task was to recreate a Raycaster which was used in games like Wolfenstein 3D.
This raycaster was done by Jonas Hagedorn and Kevin Hirsig.

The idea of a raycaster is, that in a 2D Grid Map each Square is either a 0 (no wall) or >= 1 (wall with a certain texture).
From the view of the player we send out rays, that move forward on the 2D Map until it hits a map-square that is a wall.
We then calculate the distance from the player to the wall to set the height, that this wall needs to be drawn on the screen with.
While these are all 2D calculations, we create a 3D look.
Because following the ray with maximum precision would be infinite, we used DDA (Digital Differential Analysis) which finds which squares a line hits.
With this we can reduce the amount of calculating needed by a lot.
Once the walls are drawn we draw the 2D sprites of the enemies to the player and sort them from furthest away to closest to camera.

How to Run on MacOS

Copy into a shell of your choice while being in the directory:

git clone [e-mail]:khirsig/cub3d.git && cd /cub3d

make && ./cub3D maps/haring.cub

How to create your own maps

You can create your own map files if you want, since the map is still 2D, they are pretty easy to create. However, you need to follow some rules:

• The file ending needs to be .cub
• There can be only one player
• The map always needs to be surrounded by walls
• All wall textures need to be in .xpm format
• NO, SO, WE, EA need to be followed by one space and then the path to the wall texture. NO = North, SO = South, WE = West, EA = East
• C and F need to be followed by the rgb colors you want for ceiling and floor seperated by commas

Identifier	Description
0	Floor
1	Wall
2	Door
G	Goblin Enemy
R	Rat Enemy
N	Player Spawn facing North
S	Player Spawn facing South
E	Player Spawn facing East
W	Player Spawn facing West