add README.md and clean

This commit is contained in:
mcolonna 2025-07-31 17:37:16 +02:00
parent 88c890c0e1
commit 1de30894fd
10 changed files with 40 additions and 0 deletions

View file

@ -22,6 +22,8 @@ ECHO = echoo(){ \
fi; \
};echoo
_default : bonus
all : $(NAME)
bonus :

38
README.md Normal file
View file

@ -0,0 +1,38 @@
# cub3d
this is a little kind of video-game i made for 42 school with [ReverseSky on github](https://github.com/ReverseSky). it uses the MinilibX library.
## compile and run
this project only works on linux (it may work on macOS too but you will need to manually add the MinilibX library for macOS).
1. in your terminal, run `make -v`.
if you have a `command not found` error or equivalent, you will need to install `make`. on ubuntu / debian, run:
```sh
$ sudo apt install make
```
2. clone the repository and cd inside it:
```sh
$ git clone https://gitea.zaclys.com/frzysk/42_cub3d
$ cd 42_cub3d
```
3. build the game:
```sh
$ make
```
4. run the game:
```
$ ./cub3d maps/weirdshape.cub
```
(you can use any file inside maps/)
## play
- use arrows, W/A/S/D or Z/Q/S/D to move.
- you can also click on the window to use the mouse.
- press ESC to quit.
there is a counter of your moves. try to finish the game with the less moves possible :)