This project is based on sharing knowledge and experiences throughout the entire process of understanding the MinilibX library and consecutive implementation in cub3d :)
- Ivo Marques - ialves-m
- João Almeida - joaoalme
Cub3D is a project that is part of curriculum 42 with the aim of learning the concepts of raycasting. For this project we used the MinilibX library. MinilibX is a small library which implements some basic functions that allow you to quickly open a window and to draw within it. More specifically, it’s an abstraction of the “X Window System” for Unix platforms.
Click here to access the complete subject of this project.
This project was inspired by the world-famous Wolfenstein 3D game, which was the first FPS ever. He enabled us to explore ray-casting. Our goal was to make a dynamic view inside a maze, in which we had to find our way.
- This project’s objectives were similar to all in this first year’s objectives: Rigor, use of C, use of basic algorithms, information research.
- As a graphic design project, cub3D allowed us to improve our skills in controlling and developing windows, colors, events, filling shapes.
- A deep understanding in the development of RayCasting as the first years of 3D gaming evolution.
The maps used in this project are the main root for the graphics design. Based in the map parsed information we can extract the textures, the sky and ground colors and the map structure which will be playable ground.
In Cub3d the main objective it's to translate a string map into a 3D game. With the implementation of miniLibX we were able to design all the pixels requirements for the Raycasting technique. Raycast
At first we started with some simple tests to understand how our ft_put_pixel function worked. Pixels are painted according to coordinates. After some tests, we moved on to the first contact with printing several vertical lines. This is the basic principle of Raycasting. At this stage we draw the first part of the project, which is the sky and the ground.
The image and the space through which we can navigate is generated based on a map of characters that identify the walls, the free space through which we can walk and some sprites spread across the map. After converting the character map, through the Raytracing process, to a graphical environment, we obtained the first satisfactory results where we were able to apply mobility through the hooks events of the miniLibX library.
The next step was to demystify the process of applying textures to each face of the blocks individually. The faces were identified as North, South, East, West and the path to their textures were indicated through the map file.
For the bonus phase of our project, we had to implement collisions with walls, create animations, doors that open and close and finally the possibility of using the mouse to move the player's view! One of the first implementations was the player HUD, player face animation and minimap system.
After applying the textures, it was not difficult to import new textures and identify new blocks on the map to build a more detailed map. Sprites were also implemented, because they behave differently from blocks and allow the implementation of all types of objects from all aspects across the map. So the game looks very identical to the original game, Wolfenstein.
To install and run Cub3D, follow these steps:
- Clone the repository:
git clone git@github.com:Pastilhex/cub3d.git
- Navigate to the project directory:
cd cub3d - Compile the main program by running the following command:
make
- Compile the bonus program by running the following command:
make bonus
To use Cub3D, follow these steps:
- Execute the main program
./cub3d mandatory/maps/dungeon.cub
- Execute the bonus program
./cub3d_bonus bonus/maps/wolfenstein.cub
Now you can use the following keys to play :)
WASD to move, <- (left) and -> (right) arrow keys to look
Maybe you could notice a different coding style. At 42 we need to follow some rules according to the coding standard of the school such as:
- No for, do while, switch, case or goto
- No functions with more than 25 lines
- No more than 5 functions per each file
- No more than 5 variables in the same function
- No assigns and declarations assigns in the same lineClick here to read the norm file of 42 school.