ludwigandreas / cub3d

Desktop game with self-made Ray-casting engine.

Pac3D

Desktop game with self-made Ray-casting engine.

Table of contents

• About
• Getting Started
  • Prerequisites
  • Installation
• Running the tests
• Usage
• Built Using
• Authors
• Acknowledgements
• License

About

Ray-casting project inspired by two legendary games: Wolfenstein 3D and Pac-Man.

Pac3D is a implementation of a simple 3D game engine using ray-casting technique. It uses the same principles as the original Wolfenstein 3D game, but with a different perspective. The game is written in C and uses the [MinilibX](https://harm-smits.github.io/42docs/libs/minilibx) library for that handles the graphical output. This game is an attempt to imagine what Pacman would have looked like in 3d if it had been released in 1992 on the Wolfenstein 3D engine.

This project is a part of the 42 school curriculum.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

What things you need to install the software and how to install them.

gcc >= 7.5.0
mlx >= 1.4.1

sudo apt-get install gcc

To install the MinilibX library, follow the instructions in the official site

Installation

A step by step series of examples that tell you how to get a development env running.

Clone the repository.

git clone --recurse-submodules https://github.com/AndrefHub/cub3d.git

cd cub3d

Run the Makefile.

make         # Mandatory part

make bonus   # Bonus part

Running the tests

Explain how to run the automated tests for this system.

make test

Usage

To run the program, you need to provide a map file as an argument.

./cub3D maps/some_map.cub

Bundled maps

maps/e1m1.cub - map for mandatory part maps/pacman.cub - map for bonus part, replicates map from original Pac-Man game

Built Using

• C - Programming language
• MinilibX - Library for graphical output
• Ray-casting - Rendering technique

Authors

This project was developed by:

	LudwigAndreas
	AndrefHub

Acknowledgements

• Wolfenstein 3D - First-person shooter video game
• Original Pac-Man - Arcade game
• MinilibX - Library for graphical output used in ecole 42
• School 21 - Educational institution

License

This project is licensed under the School 21 License - see the LICENSE file for details.