https://github.com/revalew/latrop-uni-pwag
LATROP in an OpenGL recreation of beloved game - PORTAL, but backwards!
https://github.com/revalew/latrop-uni-pwag
Last synced: 3 months ago
JSON representation
LATROP in an OpenGL recreation of beloved game - PORTAL, but backwards!
- Host: GitHub
- URL: https://github.com/revalew/latrop-uni-pwag
- Owner: revalew
- License: mit
- Created: 2024-12-28T09:41:42.000Z (5 months ago)
- Default Branch: master
- Last Pushed: 2025-01-25T17:29:05.000Z (4 months ago)
- Last Synced: 2025-01-25T18:25:02.919Z (4 months ago)
- Language: C
- Homepage:
- Size: 2.24 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# **Latrop: OpenGL recreation of Valve's beloved game - Portal, but backwards!**
## **Project Overview**
**Latrop** is a 3D game developed in **OpenGL**, inspired by the concept of creating and utilizing portals to solve puzzles and progress through levels. This game was created as a university project for the course **"Programming in Graphical API"**.
The main goal of this project was to explore graphical programming concepts, implement advanced rendering techniques, and demonstrate proficiency in using the OpenGL API for real-time 3D graphics.
## Table Of Contents
1. [Gameplay](#gameplay)
2. [Control Scheme](#control-scheme)
3. [Features](#features)
4. [Technical Details](#technical-details)
5. [Directory Structure](#directory-structure)
6. [Download precompiled release](#download-precompiled-release)
7. [How to Build and Run](#how-to-build-and-run)
- [Requirements](#requirements)
- [Building the Project](#building-the-project)
- [Running the Game](#running-the-game)
8. [Troubleshooting](#troubleshooting)
## **Gameplay**
In **Latrop**, players navigate through a series of levels filled with challenges and obstacles (like the pit of acid). The player uses a portal gun to:
- Create portals on designated surfaces (some surfaces won't allow you to place the portal on them).
- Solve puzzles by strategically positioning portals.
- Overcome challenges such as traps.
The game combines logic, and creativity to complete each level.
## **Control scheme**
Have a look at the control scheme [here](./docs/CONTROLS.md).
## **Features**
- **Portal Mechanics**: Create two interconnected portals to teleport across the game world.
- **3D Environment**: Fully rendered 3D levels designed using OpenGL using a **custom map generator**.
- **Physics Simulation**: Basic physics for realistic movement and interaction.
- **Resource Management**: Textures and maps are loaded dynamically during runtime.
## **Technical Details**
- **Programming Language**: C++
- **Graphics Library**: OpenGL
- **Development Tools**:
- **CMake**: For project building and management.
- **GLEW**: For OpenGL extension loading.
- **GLUT**: For window creation and input handling.
- **Assets**: All resources (textures, maps, etc.) are stored in the `data` and `maps` directories inside of the `src` directory.
## **Directory Structure**
- `src/` - Contains the C++ source code files for the game and all of the assets (shaders, textures, and maps).
- `data/` - Includes textures and shaders.
- `maps/` - Contains level design files.
- `build/` - Directory for compiled binaries and temporary build files (created during the build process),
- `docs/` - Additional documentation (control scheme, troubleshooting, etc.).
## **Download precompiled release**
You can find precompiled releases for both **GNU/Linux** and **Windows** in the [releases section](https://github.com/revalew/LATROP-Uni-PwAG/releases).
Each build comes with additional documentation (in markdown format) for easy reference.
**On Windows**, the `latrop.exe` will display a warning that the application is potentially dangerous (I don't want to get into exe signing right now...). No malicious code has been injected into this game (yet... :skull: but you can check the [workflow file](./.github/workflows/create_release.yml) and [source code](./src/) yourself), so you can safely click `More info` and `Run anyway`.
## **How to Build and Run**
### **Requirements**
- C++ Compiler (e.g., GCC, Clang, MSVC)
- Git
- CMake (minimum version 3.5)
- OpenGL-compatible hardware
- OpenGL libraries:
- GLEW
- GLUT
### **Building the Project**
> [!NOTE]
>
> This section has been tested on GNU/Linux, but will work almost identically on Windows using the CMake application.
>
> On Windows, you will need to manually download and link the required libraries into the Visual Studio project (configuration not included).
>
> You can also follow the steps from the [workflow file](./.github/workflows/create_release.yml) (job called `build-and-release-windows`, which uses the `vcpkg` package manager and `CMAKE_TOOLCHAIN_FILE` to link the downloaded packages with the provided `CMakeLists.txt` file).
- Clone the repository
```bash
git clone https://github.com/revalew/LATROP-Uni-PwAG.git
```
- Install required dependencies (e.g. using
dnf on RHEL distributions of Linux)
```bash
sudo dnf install mesa-libGL-devel mesa-libEGL-devel glfw-devel glew-devel glm-devel renderdoc
```
- Navigate to the project directory
```bash
cd LATROP-Uni-PwAG
```
- Create a build directory
```bash
mkdir build && cd build
```
- Run
CMake to configure the build
```bash
cmake ..
```
OR using `ccmake` with "GUI"
```bash
ccmake ..
```
- Compile the project (
-j$(nproc) is using all of the available cores and can be modified to a different number based on the number of cores your CPU has, e.g. 12 for a 16 core CPU, i.e. -j12)
```bash
cmake --build . -j$(nproc)
```
### **Running the Game**
After building, launch the game (**_inside the build folder_**):
```bash
./latrop
```
## **Troubleshooting**
Take a look at the most common problems and how to fix them [here](./docs/START.md).