64 lines
1.2 KiB
Markdown
64 lines
1.2 KiB
Markdown
# Cub3D
|
|
Cub3D is a simple raycasting game using the mlx library
|
|
|
|
---
|
|
## Todo
|
|
### Bonus
|
|
- Doors
|
|
|
|
---
|
|
## Features
|
|
### Mandatory
|
|
- Parsing .cub file for colors and sprites
|
|
- Parsing .cub file for the map
|
|
- Set floor and ceiling color based on .cub file
|
|
- Set Player starting direction based on letter in map
|
|
- Render walls by raycasting
|
|
- Walk in 4 directions
|
|
- Rotate with arrow keys
|
|
- Directional textures
|
|
### Bonus
|
|
- Wall Collision
|
|
- Rotate with the mouse
|
|
- Animated Sprites
|
|
- Minimap
|
|
### Extra
|
|
- Map sizes up to 1 Megabyte (1000x1000)
|
|
- Fullscreen
|
|
- Player can walk in 8 directions
|
|
- Player can Run
|
|
- Player can Jump
|
|
- Player can Crouch
|
|
- Vertical Aiming
|
|
- FPS counter
|
|
- Timer
|
|
- Decoration
|
|
- Weapon pickups
|
|
- Weapon Animations
|
|
- Stabs and bullets kill Enemies
|
|
- Ammo Pickups
|
|
- Ammo System
|
|
- Shooting Enemies
|
|
- Animated Enemies
|
|
- Destructable Sprites
|
|
- Heath Pickups
|
|
- HP system
|
|
- Treasure Pickups
|
|
- Score system
|
|
- Level end elevator
|
|
- End level screen
|
|
- You died screen
|
|
|
|
---
|
|
## Bugs
|
|
- none?
|
|
|
|
---
|
|
## Usage
|
|
1. Simply clone or download the repository
|
|
2. Run `make` in the cloned directory
|
|
3. Start the game with `./cub3d maps/level.cub`
|
|
|
|
---
|
|
[This project is part of the studies at 42](https://42.fr/en/homepage/)
|