Skip to content

Latest commit

 

History

History
55 lines (43 loc) · 1.61 KB

README.md

File metadata and controls

55 lines (43 loc) · 1.61 KB
Raw

xe - x engine

A simple 3d (game?) engine written for learning purposes

building/hacking

xe definitely builds and runs on:

  • Arch Linux
  • Debian
  • Mac OS X

xe might work on:

  • FreeBSD/PcBSD

you'll need:

  • cmake
  • ninja
  • glfw 3.1.2
  • libgl
  • libSOIL
  • yaml-cpp

this project uses submodules for things like stb_*.h and simpleini, so you must clone xe with --recursive.

this is a standard cmake-style project, so do the cmakey thing:

$ mkdir build
$ cd build
$ cmake -GNinja ..
$ ninja

ninja should produce an executable, xe. run this to start the engine.

thanks and acknowledgements

thanks to:

  • the GLFW, GLM, and SOIL authors for awesome libraries
  • John Carmack for writing the Doom and Quake engines (great learning resource and inspiration)
  • Robert Nystrom for writing Game Programming Patterns, which has been an incredible help with architecture and design patterns

license

xe - a simple 3d game engine written for learning purposes

Copyright (C) 2016 Liam Marshall

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.