Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/brendon45/3d_shooter

This project is a 3D game created using Ray Casting
https://github.com/brendon45/3d_shooter

3d-game 3d-graphics c-programming game-development portfolio raycasting

Last synced: about 2 months ago
JSON representation

This project is a 3D game created using Ray Casting

Host: GitHub
URL: https://github.com/brendon45/3d_shooter
Owner: Brendon45
License: mit
Created: 2024-05-24T09:10:10.000Z (7 months ago)
Default Branch: main
Last Pushed: 2024-06-08T05:52:39.000Z (7 months ago)
Last Synced: 2024-07-24T21:57:16.848Z (5 months ago)
Topics: 3d-game, 3d-graphics, c-programming, game-development, portfolio, raycasting
Language: C
Homepage: https://brendon45.github.io/3D_Shooter_Page/
Size: 507 KB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE
- Authors: AUTHORS

Awesome Lists containing this project

README

        ![CODING](https://github-production-user-asset-6210df.s3.amazonaws.com/125453474/259838372-ab3c1e01-2b98-47ae-96b7-37c07c85a2f1.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAVCODYLSA53PQK4ZA%2F20240605%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240605T165547Z&X-Amz-Expires=300&X-Amz-Signature=f5c550ca30f3a463cbd4683614509a42bd884f552ca64677a8962d6b8d215d3a&X-Amz-SignedHeaders=host&actor_id=137000164&key_id=0&repo_id=676041824)

# 3D_Shooter 🎮

- ![SHOOTER](https://user-images.githubusercontent.com/88714347/171422634-8adc8811-2559-4ba1-967f-4caf909c3f22.gif)

## Table of Contents

- [Background Context](#background-context)

- [Environment](#environment)

- [Installation](#installation)

- [How to play the game](#how-to-play-the-game)

- [Controls](#controls)

- [References](#references)

- [Future Enhancements](#future-enhancements)

- [Authors](#authors)

- [License](#license)

# Background Context

- The 3D_Shooter is a 3D maze game that uses ray casting to render a 2D map into a 3D navigable world. The game was developed in C using the SDL2 library. Development was performed on Ubuntu 22.04 LTS.

- The Maze is compatible with both Mac OS X and Linux/Ubuntu. It employs ray casting to create the illusion of a 3D environment within the maze.

## About SDL2 💻

- Simple DirectMedia Layer (SDL2) is a cross-platform development library designed to provide low-level access to audio, keyboard, mouse, joystick, and graphics hardware via OpenGL and Direct3D. It is widely used in video playback software, emulators, and popular games, including Valve's award-winning catalog and many Humble Bundle games. For more information on SDL2, visit the official SDL2 website.

## Environment

- Language: C

- Library: SDL2 (Simple DirectMedia Layer)

- Operating System: Ubuntu 22.04 LTS

- Compiler: gcc flags -Wall -Werror -Wextra and -pedantic

## Installation

  - Mac OS X or Linux/Ubuntu

  - SDL2 Installation

- If you don't have SDL2 installed, you can download the installation script [here](https://drive.google.com/file/d/1P7mISrn8QofKOYjQ09wASLEHCzghNHnQ/view?usp=sharing).

```shell

$ sudo apt-get install libsdl2-dev

```

## How to play the game

Step 1: Clone the repository:

```

git clone https://github.com/Brendon45/3D_Shooter.git

```

After downloading, locate the script and run it in your terminal:

Step 2: Compile All .c Files

- To compile all .c files in the src directory and generate an executable file called maze, run the following command:

```

cd 3D_Shooter

make all

```

Step 3: Run the Executable

- To play the game, run the executable with a specified map option.

	- The available map options are `level_1` to `level_7`, and:

		- These are for demonstration:

			- `demo_00 and demo_01`.

Example Commands:

To play the first level, use:

`./maze maps/level_1`

To play the first demo, use:

`./maze maps/demo_00`

## Controls

To play the game, you need to know these controls:

- `Up Arrow` Key / `T` Key: Move forward

- `Down Arrow` Key / `G` Key: Move backward

- `Left Arrow` Key / `F` Key: Rotate camera to the left

- `Right Arrow` Key / `H` Key: Rotate camera to the right

- `ESC Key` / `X Button`: Close window

- `F1 Key`: Toggle between fullscreen and windowed mode

## References

- [lodev.org](https://lodev.org/)

- [cplusplus.com](https://cplusplus.com/)

- [pikuma.com](https://pikuma.com/)

- [3DSage/OpenGL-Raycaster](https://github.com/3DSage/OpenGL-Raycaster)

- [permadi.com](https://permadi.com/)

- [Creating a Game Loop with C & SDL (Tutorial)](https://youtu.be/XfZ6WrV5Z7Y?si=xAdTIsAEyzAj3pFf)

## Future Enhancements

                                   🚧This project is still a work in progress!

📍There are still many elements that are under development and we wish to implement them into our 3D_Shooter project.

                               Stay tuned for more updates coming soon. 🍿📺🍿

- Additional Levels: Plan to introduce more complex and challenging maze levels.

- Enhanced Graphics: Explore advanced graphical techniques to further improve the visual appeal

- Improve Game Experience: By adding other elements such as sprites, enemies, weapons, rain, water, lava, etc. We can improve the difficulty and overall experience with the game.

- Expanded Compatibility: Aim to extend compatibility to more platforms, including Windows.

## AUTHORS✒️

1. Brendon Jeje       [Github](https://github.com/Brendon45) | [Linkedin](https://www.linkedin.com/in/brendonjeje/) | [Twitter](https://twitter.com/brendon4545)

2. Tafara Nyamhunga  [Github](https://github.com/Tafara-N) | [Linkedin](https://www.linkedin.com/in/tafaranyamhunga/) | [Twitter](https://twitter.com/tafaranyamhunga)

## License

- This project is licensed under the MIT License. See the [LICENSE.md](LICENSE.md) file for details.