https://github.com/kuninoto/42_cub3d

A simple 3D 'game' using MinilLibX (mlx), the graphic library of the 42School and the raycasting algorithm
https://github.com/kuninoto/42_cub3d

1337school 21school 42 42-cub3d 42born2code 42cursus 42ecole 42porto 42portugal 42project 42projects 42school cub3d ecole42 raycasting raycasting-algorithm school42

Last synced: 9 days ago
JSON representation

A simple 3D 'game' using MinilLibX (mlx), the graphic library of the 42School and the raycasting algorithm

• Host: GitHub
• URL: https://github.com/kuninoto/42_cub3d
• Owner: Kuninoto
• Created: 2023-03-02T18:14:38.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2023-10-04T22:12:31.000Z (about 1 year ago)
• Last Synced: 2023-10-05T08:56:02.121Z (about 1 year ago)
• Topics: 1337school, 21school, 42, 42-cub3d, 42born2code, 42cursus, 42ecole, 42porto, 42portugal, 42project, 42projects, 42school, cub3d, ecole42, raycasting, raycasting-algorithm, school42
• Language: C
• Homepage:
• Size: 81.4 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# cub3D (42Porto - 42Cursus)    

#### Project done in collaboration with [Rodrigo Ramos](https://github.com/ramos21rodrigo)

## Grade: 115/100

###  Demonstration:

![](./extras/showcase.gif)

### Installing and running cub3D:

1- Installing dependencies

	sudo apt-get install make xorg libxext-dev zlib1g-dev libbsd-dev

2- Clone this repository:  

	git clone https://github.com/Kuninoto/42_cub3D

3- Navigate to _lvl_4_cub3D_ and run `make`

	cd 42_cub3D/lvl_4_cub3D && make

4- `make clean` so that you don't keep those object files that you won't need anymore  

	make clean

5- Run cub3D with your desired map

	./cub3D scenes/.cub

### Controls:

	ESC - Quit cub3D

	WASD / Arrows - Player movement

	Mouse - Change Player's POV 

### Creating new scenes:

	Scene elements:

		'NO' - North texture file path;

		'SO' - South texture file path;

		'EA' - East texture file path;

		'WE' - West texture file path;

		'F' - Floor color in RGB;

		'C' - Ceiling color in RGB;

	Map:

		'0' - Free space;  

		'1' - Wall;  

		'N', 'S', 'E', 'W' - Player's starting position

		(and which coordinate he will be facing at spawn);  

	To be valid, a scene must respect the following:

		- Be in .cub file extension;

		- All textures must be 64x64 and in .xpm file extension;  

	The map must:

		- Be composed only by valid characters;  

		- Be closed by walls;  

		- Contain only one Player;  

	(You can check examples of valid scenes on 42_cub3D/lvl_4_cub3D/scenes);

###  Subject: [cub3D en_subject](./extras/en.subject_cub3D.pdf)

#### Makefile Available Targets:  

`make` or `make all` - compiles cub3D  

`make clean` - wipes all object files  

`make fclean` - deletes cub3D and all object files  

`make re` - fclean + all  

## NOTE:

This project was developed for Linux. Although we've added conditional compilation and mlx for macOS (which do not have some functions that Linux has), it was for development and test purposes.  

## NOTE for 42 students:

mlx_mouse_hide() has memory leaks product of the mlx library, you can't in any way solve them.  

So that's why running this cub3D on a sucessful run with valgrind outputs exactly 28,772 still reachable bytes in 293 blocks.

If you wish to check valgrind without the boycotted memory leakage comment mlx_mouse_hide() on line 26 of main.c

## Useful links

[What is Raycasting?](https://en.wikipedia.org/wiki/Ray_casting)  

[Raycasting implementation](https://lodev.org/cgtutor/raycasting.html)  

[Mlx documentation](https://harm-smits.github.io/42docs/)  

## Disclaimer

> At [42School](https://en.wikipedia.org/wiki/42_(school)), almost every project must be written in accordance to the [Norm](./extras/en_norm.pdf), the schools' coding standard. As a result, the implementation of certain parts may appear strange and for sure had room for improvement.

---

Made by Nuno Carvalho (Kuninoto) | [email protected]