Welcome to Cub3d, a 3D game engine built using the raycasting technique, inspired by the classic FPS game Wolfenstein. This project is developed as part of the 42 school curriculum and serves as an introduction to basic 3D rendering principle.
- Raycasting Engine: Implements a 2.5D raycasting engin to render a 3D environment from a 2D map.
- Movement and Rotation: Basic player movement and rotation.
- Textures: Support for textured walls for each cardinal point.
- Collision Detection: Simple collision detection to prevent the player walking through walls.
- Floor and Ceiling: Textured floor and ceiling.
- Enemies: Animated enemies who follow you.
- Portals: Textured blue and orange portals (Valve like), recursive.
- Gun and portal gun: Scroll between a gun and a portal gun.
- Mini-map: Dynamic minimap that rotates with the player.
- Health bar: 100 HP.
- Multi-map: Go through different maps without restarting the game, by going through doors.
- Menu: Pause menu with
esc, allows you to change map, to exit and to hide or show the hud. - Jump: Funny jump.
- Multi-thread: Speed improvement.
- Inertia: Doom-like player inertia.
- Full mouse integration: Vertical and horizontal view with the mouse.
- Resize and Fullscreen: Dynamic resize with frame border.
Make sure you have the following installed:
- GCC: A GNU Compiler for C (version >= 9.3.0).
- CMake: MLX dependency.
Clone the project:
git clone https://github.com/jgdmt/cub3d.gitIn case your system doesn't have glfw installed cmake will detect this and download it for you. You can then run sudo make install in the _deps directory of glfw.
To compile MLX dependency:
cd MLX42
cmake -B build # build here refers to the outputfolder.
cmake --build build -j4 # or do make -C build -j4You can compile Cub3d using the following commands:
make: Compiles the entire project.make bonus: Compiles the bonus.make clean: Removes object files generated during compilation.make fclean: Cleans the project directory by removing executables and object files.make re: Recompiles the entire project from scratch.
# Compile the project
make
# Clean object files
make cleanAfter compilation, you can run the Cub3d by executing:
./cub3D [path_of_the_map]You can run the bonuses by executing:
./potato4D [path_of_the_map1] [path_of_the_map2] ...Maps are included in the project. The following maps work with the mandatory part:
- test_map_old.cub
- giga_copy.cub
The followings maps are recommended to use with the bonus part:
- 1_level.cub
- 2_level.cub
- 3_level.cub
This project is licensed under the MIT License - see the LICENSE file for details.
🌟 Thank you for checking out Cub3d! 🌟 If you have any questions or suggestions, feel free to reach out.