From ed426d992aa8655191bc2cffe8b116fe9c973f20 Mon Sep 17 00:00:00 2001 From: djonker Date: Thu, 26 Oct 2023 11:23:45 +0200 Subject: [PATCH] adjusted the readme --- Readme.md | 49 +++++++++++++++++++++++++++++-------------------- 1 file changed, 29 insertions(+), 20 deletions(-) diff --git a/Readme.md b/Readme.md index 03a7ede..d85ec63 100644 --- a/Readme.md +++ b/Readme.md @@ -1,33 +1,42 @@ -# Fractol -Fractol is a Fractal zoomer using the mlx library +# Cub3D +Cub3D is a simple raycasting game using the mlx library --- -## Improvements -### Features -auto zoom to current center.\ -Seperate Calculation from drawing so that color flowing can be controlled without recalculating\ -calulate and display fractal dimension?, count edge pixels at standard zoom?\ -option to display numbers of the numberplane?, if so how to shrink with zoom?\ -add an option to blend colors in a gradient\ -vector graphic fractols based on lines if possible? -### Faster Rendering -multithreading, give every Y line to the next thread.\ -If both numbers get very close to zero it is definitely in the mandelbrot (mess up precision?)\ -Check if the last number is very close to the current number every 10 iterations, if so break, it is in the mandelbrot (mess up precision?)\ -Use Symmetric properties to draw the first line and last line at the same time (only helpful with very low zoom values else it only adds conditions.)\ -Somehow stop calculating if a new calculation is next in line\ -Edge Detection? +## Todo +### Parsing +- Parse the .cub file for the floor and ceiling colors +- Parse the .cub file for the 4 textures +- Parse the .cub file for the map +- Flood fill the map and test if it is closed +- Check if all needed elements are present in the closed part of the map +### Raycasting +- Render the walls correctly +- Render the walls correctly with movement +- Render the walls correctly with rotation +### Bonus +- Doors +- Wall Collision +- Minimap +- Animated Sprites +- Rotate with the mouse +### Extra +- A Menu? +- Levels? +- Skybox? +- Enemies? +- Weapon Sprite that fires? +- Barrels? +- Jumping? +- Vertical Aiming? --- ## Bugs -**fractal getting out of aspect when wildly zooming in and out**\ -**CY and CX value wrong when the doubles are negative** --- ## Usage 1. Simply clone or download the repository 2. Run `make` in the cloned directory -3. Start the server with `./fract-ol [FRACTAL] [ITERATIONS] [COLORSCHEME]` +3. Start the game with `./cub3d` --- [This project is part of the studies at 42](https://42.fr/en/homepage/)