/TE3D

A 3D engine for the terminal.

Primary LanguageCGNU General Public License v3.0GPL-3.0

###### TE3D
#### A software-based 3D terminal engine.

IMPORTANT!
This project isn't under active development anymore.
See "CE3D" for the new C++ project.

### What you can do and what you can't do

You can...
-	present 3D-graphics.
-	also present 2D-graphics with the right settings (See documentation for this purpose).
-	load .obj models
-	just do a bit vector math and work with 3D-models.
-	everything that comes in your mind.

You can't...
-	Hm, there's nothin' you can't do with this stuff :)



### Installation guide

# LINUX
1.	Download this project archive and extract it or just clone this repository locally on your computer.
2.	Open the terminal and switch into the extracted folder.
3.	Run:
	sudo make install
4.	You did it!

# WINDOWS
1.	Install the Windows-SDK. You can get it from http://msdn.microsoft.com/en-us/windows/bb980924.aspx
2.	Download this project archive and extract it or just clone this repository locally on your computer.
3.	Run the "developer command prompt" from the Windows SDK. If you need administrator-priviliges to write into the project directory, start it as an administrator.
4.	Run:
	nmake install
5.	Copy the contents from the "install"-directory where you like and reference it to your projects.
6.	You did it!


### How-to-use guide

Just include <TE3D.h> in your C-files.
For a detailed list of available functions and examples, see the documentation.

Note:
The name design is leaned on the object-orientated design, but it's not object-orientated. To provide
methods for structs (like classes), the functions naming convention is (most time):

prefix 'TE3D' + '_' + the belonging struct name + '_' + the 'function-name'

For example:
```C
void TE3D_Matrix4x4f_mul(...)
```