https://github.com/jotavare/cub3d
3D game created from scratch similar to Wolfenstein 3D, where I explored the world of raycasting, using C and the minilibx library.
https://github.com/jotavare/cub3d
3d algorithms c collision-detection color cub3d first-person-shooter game-engine gdb makefile minilibx minimap norminette raycasting rendering sprites valgrind wolfenstein-3d
Last synced: 2 months ago
JSON representation
3D game created from scratch similar to Wolfenstein 3D, where I explored the world of raycasting, using C and the minilibx library.
- Host: GitHub
- URL: https://github.com/jotavare/cub3d
- Owner: jotavare
- License: mit
- Created: 2023-10-05T23:15:12.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-26T23:32:07.000Z (10 months ago)
- Last Synced: 2025-01-02T10:45:33.938Z (4 months ago)
- Topics: 3d, algorithms, c, collision-detection, color, cub3d, first-person-shooter, game-engine, gdb, makefile, minilibx, minimap, norminette, raycasting, rendering, sprites, valgrind, wolfenstein-3d
- Language: C
- Homepage:
- Size: 14.4 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
About •
How to use •
Mandatory •
Bonus •
Team •
Norminette •
Contributing •
License
## ABOUT
This is a graphics programming project where I created a 3D game in C, using the minilibx library. I learned about raycasting, basic algorithms, rendering 3D environments, textures, windows, colours, events, shape filling, wall collision, map parsing, mini-map, ...
This project is inspired by the world-famous Wolfenstein 3D game, by the famous John Carmack and John Romero (Id Software), and published in 1992 by Apogee Software, Wolfenstein 3D is the first true “First Person Shooter” in the history of video games.
A replica of the original game is available to play online here.
- [Subject](https://github.com/jotavare/netpractice/blob/main/subject/en_subject_cub3d.pdf) `PDF`
- [References](https://github.com/jotavare/42-resources#04-cub3d) `GitHub`
## HOW TO USE
#### 1º - Clone the repository
```bash
git clone [email protected]:jotavare/cub3d.git
```
#### 2º - Enter the project folder and run `make mlx`
> [!NOTE]
> This rule is not mandatory but necessary to run the game because the minilibx library is not included.
```bash
cd cub3d/cub3d
make mlx
```
#### 3º - Run the game with a map of your choice
```bash
make re
./cub3d [map.cub]
```
#### MAKEFILE RULES
| Rules | Information |
| :-- | :-- |
| `make` | Compile so_long files. |
| `make all` | Compile mandatory files. |
| `make clean` | Delete all .o (object files) files. |
| `make fclean` | Delete all .o (object files) and .a (executable) files. |
| `make re` | Use rules `fclean` + `all`. |
| `make norm` | Uses the norminette on the libft and cub3d source files. |
| `make mlx` | Downloads and compiles the minilibx library. |
## MANDATORY
#### MAIN RULES
- [x] Must use MiniLibX library;
- [x] The game window must remain smooth: changing to another window, minimizing, etc;
- [x] Display different wall textures that vary depending on which side the wall is facing (North, South, East, West);
- [x] Must be able to set the floor and ceiling colours to two different ones;
#### WINDOWS AND KEYS
- [x] Displays the image in a window;
- [x] Left and right arrow keys must allow you to look left and right in the maze.
- [x] The `W`, `A`, `S`, and `D` keys must allow you to move the point of view through the maze.
- [x] Pressing `ESC` or clicking on the `cross` on the window’s frame must close the window and quit the program cleanly.
#### MAP PARSING/VALIDATION
> [!NOTE]
> The program must be able to parse any kind of map, as long it respects the rules:
- [x] The program has to take as a parameter a map description file ending with the `.cub` extension.
- [x] The map must be closed/surrounded by walls, if not, the program must return an error.
- [x] Map content always has to be the last.
- [x] Separated by one or more empty line(s).
- [x] Each type of element can be set in any order in the file.
- [x] Each type of information from an element can be separated by one or more space(s).
- [x] If an error/misconfiguration is encountered, it should return `Error\n` followed by an explicit message.
#### .cub COMPONENTS
- [x] The map must be composed of only 6 possible characters.
- [x] Each element's first information is the type identifier, followed by all specific information for each object;
| Characters | Description |
| :-- | :-- |
| `0` | Empty space. |
| `1` | Wall. |
| `N` `S` `E` `W` | Player start position and orientation. |
| Name | Example | Identifier | Information |
| :-- | :-- | :-- | :-- |
| North texture: | `NO ./path_to_the_north_texture` | NO | Path to the north texure. |
| South texture: | `SO ./path_to_the_south_texture` | SO | Path to the south texure. |
| West texture: | `WE ./path_to_the_west_texture` | WE | Path to the west texure. |
| East texture: | `EA ./path_to_the_east_texture` | EA | Path to the east texure. |
| Floor colour: | `F 220,100,0` | F | R,G,B colours in range [0,255]: 0, 255, 255 |
| Ceiling colour: | `C 225,30,0` | C | R,G,B colours in range [0,255]: 0, 255, 255 |
> Example of a valid `.cub` map:
```bash
NO ./path_to_the_north_texture
SO ./path_to_the_south_texture
WE ./path_to_the_west_texture
EA ./path_to_the_east_texture
F 220,100,0
C 225,30,0
1111111111111111111111111
1000000000110000000000001
1011000001110000000000001
1001000000000000000000001
111111111011000001110000000000001
100000000011000001110111111111111
11110111111111011100000010001
11110111111111011101010010001
11000000110101011100000010001
10000000000000001100000010001
10000000000000001101010010001
11000001110101011111011110N0111
11110111 1110101 101111010001
11111111 1111111 111111111111
```
## BONUS
- [x] Wall collisions.
- [x] A minimap system.
- [x] Doors which can open and close.
- [x] Animated Sprite.
- [x] Rotate the point of view with the mouse.
## TEAM
| GitHub | 42 Intra |
| :--: | :--: |
| [Pedro Mota](https://github.com/peterbikes) | [psotto-m](https://profile.intra.42.fr/users/psotto-m) |
| [João Oliveira](https://github.com/jotavare) | [jotavare](https://profile.intra.42.fr/users/jotavare) |
## NORMINETTE
> At 42 School, it is expected that almost every project is written following the Norm, which is the coding standard of the school.
```
- No for, do...while, switch, case, goto, ternary operators, or variable-length arrays allowed;
- Each function must be a maximum of 25 lines, not counting the function's curly brackets;
- Each line must be at most 80 columns wide, with comments included;
- A function can take 4 named parameters maximum;
- No assigns and declarations in the same line (unless static);
- You can't declare more than 5 variables per function;
- ...
```
* [42 Norms](https://github.com/42School/norminette/blob/master/pdf/en.norm.pdf) - Information about 42 code norms. `PDF`
* [Norminette](https://github.com/42School/norminette) - Tool to respect the code norm, made by 42. `GitHub`
* [42 Header](https://github.com/42Paris/42header) - 42 header for Vim. `GitHub`
## CONTRIBUTING
If you find any issues or have suggestions for improvements, feel free to fork the repository and open an issue or submit a pull request.
## LICENSE
This project is available under the MIT License. For further details, please refer to the [LICENSE](https://github.com/jotavare/cub3d/blob/master/LICENSE) file.