diff --git a/README.md b/README.md index 2afcec4..525a922 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,51 @@ # cube3D -This is a 3D mini game, using raycasting, in imitation of Wolfenstein3D or Doom. +This project is a 3D mini game, that uses raycasting to produce a FPP (first person perspective), just like in Wolfenstein3D or Doom. + +![moving into the 3D](assets/cube3d_aller_retour.gif) + +It creates a 3D view from a map in a text file, and move the view as if we were walking and looking around. + +An example of a map : + +``` +$> cat -e map.cub +111111111111111111111111$ +1......................1$ +1......................1$ +1......................1$ +1.......1......1.1.1...1$ +1.....1...1............1$ +1.......1......1...1...1$ +1.....1...1....E.......1$ +1.......1......1.1.1...1$ +1......................1$ +1......................1$ +1......................1$ +1......................1$ +1......................1$ +1.......11.............1$ +1.......11.............1$ +111111..11............11$ +11.1....11.............1$ +11....1.11............11$ +11.1....11.............1$ +11.1111111............11$ +11...................111$ +1111111111..........1111$ +111111111111111111111111$ +$> +``` + +This map will produce this 3D view : + +![moving into the 3D](assets/cube3d_tour.gif) + +You can change the images on the wall : + +![change the images on the wall](assets/cube3d_image.gif) + +And change the map itself : + +![change the map](assets/cube3d_map.gif) -![aller retour](assets/cube3d_aller_retour.gif) diff --git a/assets/cube3d_tour_2.gif b/assets/cube3d_tour_2.gif deleted file mode 100644 index 0d8d5f1..0000000 Binary files a/assets/cube3d_tour_2.gif and /dev/null differ