https://github.com/vinicius-rio/42-formation-lvl2-11.cub3d
Project 11: Cub3D - Eleventh project for the formation of software engineers at school 42 São Paulo.
https://github.com/vinicius-rio/42-formation-lvl2-11.cub3d
Last synced: about 1 month ago
JSON representation
Project 11: Cub3D - Eleventh project for the formation of software engineers at school 42 São Paulo.
- Host: GitHub
- URL: https://github.com/vinicius-rio/42-formation-lvl2-11.cub3d
- Owner: vinicius-rio
- Created: 2022-11-21T22:47:00.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-02-28T01:49:51.000Z (over 2 years ago)
- Last Synced: 2025-05-09T05:32:04.530Z (about 1 month ago)
- Language: C
- Size: 346 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 42-formation-lvl2-11.cub3d
Project 11: Cub3D - Eleventh project for the formation of software engineers at school 42 São Paulo.
- This project is inspired by the world-famous Wolfenstein 3D game. Our goal is to create a raycaster.
#### This project was like this:
#### How to run
- Clone the repository
````
git clone [email protected]:Vinicius-Santoro/42-formation-lvl2-11.cub3d.git
````
- Run `make` to compile _common part_.
- To clean objects files execute: `make clean`
- To clean executable file and objects: `make fclean`
- Recompile: `make re`
- Run `./cub3D` or followed by map path e.g. `./assets/maps/map42.cub`
#### File configuration
To run the game, you must pass as first argument a scene description file with the .cub
extension.
#### Identifiers
The file must have 6 element identifiers:
| Identifier | Description |
|:----------:|-------------|
|NO| Represents the texture of the wall in the north direction|
|SO| Represents the wall texture in the south direction|
|WE| Represents the wall texture in the west direction|
|EA| Represents the wall texture in the east direction|
|C| Represents the RGB color scale of the celling|
|F| Represents the RGB color scale of the floor||
Example in a .cub file:
````
NO ./assets/Images/north.xpm
SO ./assets/Images/south.xpm
WE ./assets/Images/west.xpm
EA ./assets/Images/east.xpm
F 200,200,200
C 0,0,0
````
#### Map configuration
The map construction is composed by the following characters:
- Walls: `'1'`
- Empty spaces inside: `'0'`
- Empty spaces outside: `' '`
- Initial player direction: `'N'`, `'S'`, `'W'` or `'E'`
#### Map Rules
- It must be completely surrounded by walls
- It must have a player
Map example:
````
1111111111111111111111111111111111111
1000000000000000000000000000000000001
1001111000001111000001111111111111001
1001111000001111000001111111111111001
1001111000001111000001111111111111001
1001111000001111000000000000001111001
1001111111111111000001111111111111001
1001111111111111000001111111111111001
1000000000001111000001111111111111001
1000000000001111000001111000000000001
1000000000001111000001111111111111001
1000000000001111000001111111111111001
100000000000000000N000000000000000001
1111111111111111111111111111111111111
````
#### How to play
- The `'→'` and `'←'` keys of the keyboard allow you to look left and
right in the maze.
- The `'W'`, `'A'`, `'S'` and `'D'` keys allow you to move the point of view through
the maze.
- `'Esc'` key exits the game.
#### Necessary concepts
- [O que é RayCasting?](docs/necessary_concepts/raycasting.md)
- [Interface gráfica utilizando a Linguagem C com MiniLibX](docs/necessary_concepts/interface.md)
- [RayCasting usando a Linguagem C](docs/necessary_concepts/raycasting-c.md)
#### Details of the entire project
- [makefile](docs/project_details/makefile.md)
- [check_line.c](docs/project_details/check_line.md)
- [commands.c](docs/project_details/commands.md)
- [end_game.c](docs/project_details/end_game.md)
- [main.c](docs/project_details/main.md)
- [make_image.c](docs/project_details/make_image.md)
- [parse_map.c](docs/project_details/parse_map.md)
- [raycast.c](docs/project_details/raycast.md)
- [read_map.c](docs/project_details/read_map.md)