Introduction
- DGLE is a powerful cross-platform engine for 2D/3D games and real-time visualizations. Young, strong and crazy!
- DGLE is an open source project and free for use (under the terms of license, see below).
- DGLE is based on widely spread open standards, formats and APIs such as OpenGL, OpenAL, OGG Vorbis, Lua, Box2D, Bullet physics, Mono & GTK# e.t.c..
This file is official engine documentation for C++ programmers (DGLE users). This documentation is also suitable for any supported programming language.
The aim of the project
The goal of the project is to provide developers with flexible and extendable cross-platform easy-to-learn professional technology, capable of building any 2D/3D games, real-time visualizations, scientific applications etc. It should be easy to make great projects only by using editors and scripts or go deeper and use your programming skills of your favorite language to create really exciting projects. Users can also add new formats and functionality by creating new plugins for engine and share them with others over the web or just get plugins already made by others. When project is complete it can be easily build for every popular platform.
Getting started
Simple steps to make your first DGLE application.
- 1. Include this header ("DGLE.h") to your project.
- 2. Connect DGLE namespace to your project (ex. "using namespace DGLE;").
- 3. Paste "DGLE_DYNAMIC_FUNC" macros to your main source file (ex. "main.cpp").
- 4. Declare pointer to IEngineCore class like "IEngineCore *pEngineCore".
- 5. Call "GetEngine" function to retrieve IEngineCore pointer. For dynamic library it should be like this "GetEngine("DGLE.dll", pEngineCore);".
- 6. Now you can use IEngineCore methods. For example, you can initialize engine like this "pEngineCore->InitializeEngine(NULL, "HelloWorld");".
- 7. After engine initialization you should call "pEngineCore->StartEngine();" to start engine.
- 8. When you are done with engine don't forget to call "FreeEngine()" routine before exit.
Please see "HelloWorld" sample code at the "Examples" tab of this help file.
You can browse ".\src\examples" folder or go to "Examples" tab of this manual for further information.
License
DGLE is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
DGLE 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 Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License along with this program. If not, see http://www.gnu.org/licenses/.
The letter from the developers
If you are using DGLE in your project and you like it. Please do not remove DGLE splash screen and paste the link to the official DGLE website in your program credits section or elsewhere. It is the easiest way you can say "Thank you for your work!" to DGLE project developers. Also we would be happy for any donations to support further project development.
Additional help and information
Visit official DGLE engine website http://dglengine.org/ for additional information and support.
Feel free to write directly to project leader on e-mail hello@dglengine.org.
