Skip to content

Latest commit

 

History

History
107 lines (74 loc) · 2.73 KB

README.md

File metadata and controls

107 lines (74 loc) · 2.73 KB
Raw

CE3D2

Inspired By Lasse

Console Engine 3D 2. A simple 3D engine for the console.

About

CE3D2 is a leightweight 3D engine specifically designed for rendering ASCII-art. Since it's not using heavy graphic pipelines and utilizes CPU only, the vector arithmetic is very flexible.

Build

Clone this repository, cd into and build it!

git clone https://github.com/Makman2/CE3D2
cd CE3D2
./make.sh release

You can speed things up by using parallel builds!

./make.sh release -j8

The libary is located inside the build/release directory.

To build CE3D2 you need:

  • a C++11 compiler
  • Boost
  • CMake

CE3D2 is only supported on linux platforms.

Installation

To install CE3D2, just type:

./make.sh install release

If you only want to install CE3D2, you don't need to build it even via ./make.sh release, the installation command does that automatically for you.

NOTE

The library is installed to /usr/local/lib/. Some platforms don't have this path inside the environment variables so execution of programs using CE3D2 result in a load-failure. This can be fixed often by modifying /etc/ld.so.conf adding /usr/local/lib/ and executing ldconfig with elevated privileges. Refer to the help of your platform.

Usage

After install you can use CE3D2 normally like any other library:

#include <CE3D2/Vector.h>

int main()
{
    CE3D2::Vector vec;
    // Do fancy vector stuff.
    return 0;
}

Don't forget to link against CE3D2 and use C++11 (in g++ use the flags -lCE3D2 and -std=c++11). Also you need Boost installed, since vector and matrix arithmetic is performed using it.

Documentation

HTML-documentation can be built easily with ./make.sh docs into build/docs. To display the documentation webpage, invoke your favorite browser with build/docs/html/index.html.

CE3D2 uses doxygen (version 1.8.6 or above required) to generate documentation.

Debugging

If you want to debug CE3D2, you need to invoke ./make.sh debug instead of ./make.sh release. The debug library is then located inside build/debug.

To install the debug libraries, pass debug instead of release to the install target: ./make.sh install debug

If you want to see all "build targets" of the make-script, type ./make.sh help.

Vagrant

CE3D2 supports Vagrant! Just type

vagrant up --provider=virtualbox

and the machine spawns up! The only dependency required is VirtualBox. After the machine has started, you can ssh into the machine with vagrant ssh and switch to the project directory with cd /vagrant.