An open API service indexing awesome lists of open source software.

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


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

Last synced: 2 months ago
JSON representation

Awesome Lists containing this project

README

        


# 42_Cub3d

>







___

Table o'Contents

* [About ๐Ÿ“Œ](#about-)
* [Usage ๐Ÿ](#usage-)
* [Tests & Debug ๐Ÿงช](#tests--debug-)
* [References ๐Ÿ“š](#references-)
* [License ๐Ÿ“–](#license-)

# About ๐Ÿ“Œ

Cub3d is a project inspired by the world-famous `Wolfenstein 3D (Wolf3D)`, the first FPS ever. An exploration of ray-casting.
___

# Usage ๐Ÿ

Clone the repository and cd into it:
```sh
git clone https://github.com/PedroZappa/42_cub3d.git 42_cub3d
```

Build the program:
```sh
cd 42_cub3d
make
```

Run the program:
```sh
./cub3d ./maps/subject.cub
```

___

# Tests & Debug ๐Ÿงช

Run the following command and look at the `Test Rules ๐Ÿงช` & `Debug Rules ๏†ˆ` to get a comprehensive list of all available test/debug commands:
```sh
make help
```

> [!Note]
> If you use `tmux` you are in for treat ๐Ÿ˜
___
# References ๐Ÿ“š

- [Lode's Computer Graphics Tutorial](https://lodev.org/cgtutor/raycasting.html)
- [Ray Tracing in One Weekend](https://raytracing.github.io/books/RayTracingInOneWeekend.html)
- [2D Vector Rotations](https://matthew-brett.github.io/teaching/rotation_4d.html)
- [Vector Rotations: Active & Passiva](https://phys.libretexts.org/Courses/University_of_California_Davis/UCD%3A_Physics_9HB__Special_Relativity_and_Thermal_Statistical_Physics/3%3A_Spacetime/3.1%3A_Vector_Rotations)
- [Scalar Product](https://www.mathcentre.ac.uk/resources/uploaded/mc-ty-scalarprod-2009-1.pdf)

# License ๐Ÿ“–

This work is published under the terms of 42 Unlicense.

(get to top)