Cross-platform 3D game engine written in C++ and OpenGL
Switch branches/tags
Nothing to show
Clone or download

README.md

Locus Game Engine

##Description

Locus is a cross-platform 3D game engine written in C++ and OpenGL. It is a hobby project so it is not meant to compete with AAA game engines though some of its code may prove useful to other projects.

##Code Review

If you wish to review the code for Locus, please see README_CODE_REVIEW.txt.

##Supported Platforms

  • Windows (compiles with Visual Studio 2013)
  • Linux (compiles with GCC 4.8.2)
  • Mac support and support for other compilers is forthcoming

##License

Locus uses a BSD-style license. See LICENSE.txt for more details.

##Compilation

Locus uses the CMake build system. The root project directory should be set as the CMake source directory.

Locus ships with all its third-party dependencies.

Locus supports both static and dynamic linking. However, due to certain design decisions, including the use of the C++ standard library at the API boundary and the use of C++ exceptions, great care is necessary for dynamic linking with Locus. Namely, the application and all Locus modules should be compiled with the same compiler (and standard library) and should use the same runtime library.

##Examples

Sample applications using Locus are in the examples directory.

Minor Planet Mayhem is a cross-platform 3D first person space shooter game written in C++ and OpenGL using the Locus Game Engine.

##Credits

Locus Game Engine Copyright (c) 2014 Shachar Avni. All rights reserved.

##Third-Party Software

Locus makes use of the following third-party software whose licenses are available in the accompanying LICENSE.txt:

  • GLFW 3.0.3
    Copyright (c) 2002-2006 Marcus Geelnard
    Copyright (c) 2006-2011 Camilla Berglund

  • The OpenGL Extension Wrangler Library (GLEW) 1.10.0
    Copyright (c) 2002-2007, Milan Ikits
    Copyright (c) 2002-2007, Marcelo E. Magallon
    Copyright (c) 2002, Lev Povalahev

  • Open Audio Library (OpenAL)
    Copyright (c) 1991, 1999 Free Software Foundation

  • Ogg Vorbis
    libogg 1.3.1
    libvorbis 1.3.4
    Copyright (c) 2002, Xiph.org Foundation
    Copyright (c) 2002-2008 Xiph.org Foundation

  • The FreeType Project 2.5.3
    Portions of this software are copyright (c) 2014 The FreeType Project (www.freetype.org). All rights reserved.

  • PhysicsFS 2.0.3
    Copyright (c) 2001-2012 Ryan C. Gordon and others.

  • RapidXML 1.13
    Copyright (c) 2006, 2007 Marcin Kalicinski

  • stb_image 1.46
    Public Domain Contributions by Sean Barrett and others

  • stb_image_write 0.97
    Public Domain Contributions by Sean Barrett and others