Skip to content
This repository has been archived by the owner on Aug 2, 2023. It is now read-only.
/ vortex Public archive

Old, defunct and incomplete 3D game engine.

License

Notifications You must be signed in to change notification settings

fLindahl/vortex

Repository files navigation

Vortex Engine {#mainpage}

A 3D Game Engine built upon work done during the Game Development Bachelor Programme at Luleå University of Technology.

Disclaimer

Vortex is currently under heavy development and will most likely not be fully operational/buildable at this moment.

Requirements

  1. CMake 3.0+.
  2. Compiler with support for C++17.
  3. GPU supporting OGL 4.3+
  4. OS: Windows or Linux (so far)

Build Instructions

See Build Instructions.

Usage

The Example folder contains two folders, "code" and "resources". In the code folder you can put all the project specific code that you project might be using. The engine will look for resources and assets in the resources folder. If not, make sure your working directory is pointing at the engine root folder.

See Documentation for more help.

Example Project

The example project is simply an example implementation which shows of some features.

Documentation

Documentation can be generated with Doxygen by running it with doxy_config.conf. This will generate a docs folder which will contain all the documentation.

Documentation is written directly in the code using doxygen syntax but can also be done via markdown language files like this one.

See Documentation for wiki pages.