itsthomthomob/pinpoint-engine

Pinpoint Engine

Table of Contents

1. Context
2. Pre-reqs
3. Setup
4. Troubleshooting
5. Special Thanks

Context

Pinpoint Engine is a game engine I am (trying) to develop to further my graphical programming, rendering, and C++ skills for a purely educational experience.

To Do

• Link headers and cpp files correctly
  • Currently can't implement CPP code in respective CPP files

Pre-reqs

• GLAD headers
• GLFW headers
• CMake

Setup Instructions

1. Clone repo
2. Open in VSCode
3. Select variant via ctrl + shift + p, search Variant and choose Release
4. Build the project by doing ctrl + shift + p then CMake: Build
5. Open the Pinpoint-Engine.exe in the Build directory

Troubleshooting

• Remember that the build directory is in the .gitignore, so use cmake to build the directory again for new clones

Proctoring the Project Structure

pinpoint-engine
├─ .vscode
│  ├─ tasks, etc.
├─ CMakeLists.txt
├─ LICENSE.txt
├─ README.md
├─ src
│  ├─ main.cpp
│  ├─ ObjectsAPI
│  │  ├─ object controllers
│  ├─ Pinpoint
│  │  └─ namespace
│  └─ RenderingAPI
│     ├─ Buffer.cpp
│     ├─ Buffer.h
│     ├─ OpenGL
│     │  ├─ OpenGL Objects
│     ├─ points.h
│     ├─ Renderer.cpp
│     ├─ Renderer.h
│     └─ Shaders
│        ├─ fragmetn and vertex shaders
└─ vendor
   ├─ CMakeLists.txt
   ├─ glad
   |  └─ exes, cpps, hs, etc...
   └─ glfw
      └─ exes, cpps, hs, etc...