sdmay25-37 / NonEuclideanEngine

0 stars 0 forks source link

Non-Euclidean Engine

Main repo for our non-Euclidean rendering engine

Organization Details

tests/ contains a bunch of individual main programs that we can use for testing our engine functionality and creating cool demos

lib/ contains external code libraries

ne_engine/ contains all of the engine code

shaders/ contains a bunch of useful shaders used by the engine

res/ contains textures for use by the tests

.vscode/ contains some of our preferred vscode configuration details

Windows Setup Instructions

  1. Be better and use Linux
  2. Clone the repo: git clone https://github.com/sdmay25-37/NonEuclideanEngine.git --recursive
  3. Install a compiler for Windows. I suggest Mingw
  4. Install CMake
  5. Get a build system on Windows like Ninja
  6. Make sure Mingw/bin, CMake/bin, and Ninja.exe are on your path
  7. Open the Non_Euclidean_Playground directory and run cmake -S src -B build -G Ninja
  8. To build: cmake --build build

Linux Installation Instructions

  1. Clone the repo: git clone https://github.com/sdmay25-37/NonEuclideanEngine.git --recursive
  2. Change directories: cd Non_Euclidean_Playground
  3. Install the necessary packages: sudo ./linux_setup.sh
  4. If this does not work install the necessary packages(see Windows Setup Instructions for a list of necessary things)
  5. To build: cmake --build build