cub3d/Readme.md

64 lines
1.2 KiB
Markdown
Raw Normal View History

2023-10-26 11:23:45 +02:00
# Cub3D
Cub3D is a simple raycasting game using the mlx library
2023-10-25 13:56:45 +02:00
---
2023-10-26 11:23:45 +02:00
## Todo
### Bonus
- Doors
2023-10-25 13:56:45 +02:00
2023-10-29 17:22:15 +01:00
---
## 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
2023-11-01 16:13:18 +01:00
- Directional textures
2023-10-29 17:22:15 +01:00
### Bonus
- Wall Collision
- Rotate with the mouse
2023-11-06 01:28:52 +01:00
- Animated Sprites
2023-11-10 11:32:15 +01:00
- Minimap
2023-10-29 17:22:15 +01:00
### Extra
2023-11-10 11:32:15 +01:00
- Map sizes up to 1 Megabyte (1000x1000)
- Fullscreen
2023-10-29 17:22:15 +01:00
- Player can walk in 8 directions
- Player can Run
2023-11-05 08:12:18 +01:00
- Player can Jump
- Player can Crouch
2023-11-02 04:30:19 +01:00
- Vertical Aiming
2023-11-10 11:32:15 +01:00
- FPS counter
- Timer
- Decoration
2023-11-06 01:28:52 +01:00
- Weapon pickups
- Weapon Animations
2023-11-10 11:32:15 +01:00
- 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
2023-11-03 22:51:26 +01:00
2023-10-25 13:56:45 +02:00
---
## Bugs
2023-11-10 11:32:15 +01:00
- none?
2023-10-25 13:56:45 +02:00
---
## Usage
1. Simply clone or download the repository
2. Run `make` in the cloned directory
2023-11-10 11:32:15 +01:00
3. Start the game with `./cub3d maps/level.cub`
2023-10-25 13:56:45 +02:00
---
[This project is part of the studies at 42](https://42.fr/en/homepage/)