Tree [c33c7c] master /
History



File Date Author Commit
data 2014-12-03 Sylvain Doremus Sylvain Doremus [c33c7c] Version 0.7.0
doc 2014-12-03 Sylvain Doremus Sylvain Doremus [c33c7c] Version 0.7.0
install 2014-12-03 Sylvain Doremus Sylvain Doremus [c33c7c] Version 0.7.0
source 2014-12-03 Sylvain Doremus Sylvain Doremus [c33c7c] Version 0.7.0
.gitignore 2014-12-03 Sylvain Doremus Sylvain Doremus [c33c7c] Version 0.7.0
.tgitconfig 2014-02-25 Sylvain Doremus Sylvain Doremus [c26a6b] Code cleanup + Beginning to export scenes in cs...
AUTHORS 2014-02-20 Sylvain Doremus Sylvain Doremus [051a30] Initial Commit
ChangeLog 2014-12-03 Sylvain Doremus Sylvain Doremus [c33c7c] Version 0.7.0
LGPL.txt 2014-02-20 Sylvain Doremus Sylvain Doremus [051a30] Initial Commit
NEWS 2014-12-03 Sylvain Doremus Sylvain Doremus [c33c7c] Version 0.7.0
README 2014-12-03 Sylvain Doremus Sylvain Doremus [c33c7c] Version 0.7.0
freeimage-license.txt 2014-02-20 Sylvain Doremus Sylvain Doremus [051a30] Initial Commit

Read Me

#
#   **-----------------------------------------------------------------------**
#   **                               Castor3D                                **
#   **-----------------------------------------------------------------------**
#   **                Multi-OS and Multi-Renderer 3D engine                  **
#   **-----------------------------------------------------------------------**
#   **              First version of this file: may 10th 2012                **
#   **-----------------------------------------------------------------------**
#

Overview :
I.   Description 
II.  Building Castor3D
III. Options
IV.  Running Castor3D
V.   General Questions


#   **-----------------------------------------------------------------------**
#   **                          I. Description                               **
#   **-----------------------------------------------------------------------**

Castor3D is a 3D engine written in C++.
It works on Windows and also on GNU/Linux.
It uses OpenGL (with GLSL) or Direct3D 9 (with HLSL).
Cg shader language is also supported.


#   **-----------------------------------------------------------------------**
#   **                       II. Building Castor3D                           **
#   **-----------------------------------------------------------------------**

Castor3D uses CMake to build project files.
You just need to launch cmake to build your preferential projet file.
Tested compilers are :
- Visual Studio 2010
- Visual Studio 2012
- Visual Studio 2013
- gcc 4.6.2
- gcc 4.7.0
CastorUtils depends on boost thread, FreeImage and FreeType.
Castor3D is based on CastorUtils.
GuiCommon depends on wxWidgets (from 2.8.11, currently on 2.9.3).
Last (but not least) CastorViewer depends on GuiCommon, Castor3D and wxWidgets.

Some plugins are also built :
Renderers
- GlRenderSystem depends on OpenGL (not GLU).
- Dx9RenderSystem uses Direct3D 9.
- Dx10RenderSystem uses Direct3D 10.
- Dx11RenderSystem uses Direct3D 11.

Importers : ASE, 3DS, LWO, OBJ, PLY, MD2, MD3. If you have Assimp installed,
			you can build ASSIMPImporter which replaces the previous ones
Dividers : Loop and PN-Triangles.

Two additional projects are also generated :
- ImgConverter : Allows you to convert any image file type to XPM or ICO.
- CastorUtilsTest : Allows you to run unit and performance tests for CastorUtils.

Documentation for CastorUtils and Castor3D can be generated using Doxygen.


#   **-----------------------------------------------------------------------**
#   **                           III. Options                                **
#   **-----------------------------------------------------------------------**

On GNU/linux the default install directory is in /usr/local.
You can change this directory by changing the CMAKE_INSTALL_PREFIX value.
The main application is installed in <install_dir>/bin/
The library LibGenerator (used to build your own plugins) is installed in
<install_dir>/lib/
The plugins are installed in <install_dir>/shared/Castor3D/


#   **-----------------------------------------------------------------------**
#   **                        IV. Running Castor3D                           **
#   **-----------------------------------------------------------------------**

To run Castor Viewer, just type 'CastorViewer' in your preferred command-line
tool.


#   **-----------------------------------------------------------------------**
#   **                        V. General Questions                           **
#   **-----------------------------------------------------------------------**

1. I need a feature that Castor3D do not implement, what should I do ?

There are two ways.
First, Castor3D is a LGPL software and library, so you are welcome to improve
it yourself ;-) !
Second, just ask the author :-) ! 

2. I implemented a cool feature, can I commit it ?

Obviously you are welcome to send the author any improvement. But obviously
the author is quite careful with readability, correctness and stability, 
and will read and check any contribution before including it.
Thus, it can take time... There are few basic rules to write contributions:
- (1) Do never change the indentation of any part of the code that's not yours.
- (2) Do never send codes without a lot of comments in (bad or good) english.
- (3) Do never send codes with obscure and/or non-english variable names.

3. How can I ask the author ?

Just send a mail to dragonjoker59@hotmail.com !