mirror of
https://github.com/SpartanJ/eepp.git
synced 2026-05-30 18:16:31 +03:00
0211cae5a8
Changed ChannelsCount to ChannelCount, since it makes more sense. Now PlayOffset and Duration in sounds and music is returned in seconds, as float.
116 lines
3.6 KiB
C++
Executable File
116 lines
3.6 KiB
C++
Executable File
#ifndef EE_HPP
|
|
#define EE_HPP
|
|
/**
|
|
@mainpage Entropia Engine++
|
|
|
|
Developed by: Martín Lucas Golini
|
|
|
|
2D Game Engine designed for an easy cross-platform game development.
|
|
The project aims to provide a simple and powerfull framework that takes advantage of C++, OpenGL, OpenAL, SDL and more.
|
|
|
|
Thanks to: \n
|
|
* Sean Barrett for the stb_vorbis and stb_image libraries. \n
|
|
* Sam Latinga for Simple DirectMedia Layer library. \n
|
|
* Jonathan Dummer for the Simple OpenGL Image Library. \n
|
|
* Laurent Gomila for the SFML library ( eepp audio module is heavily based on the SFML audio module ) \n
|
|
* OGRE staff for the Timer implementation \n
|
|
* Lewis Van Winkle for PlusCallback \n
|
|
* Dieter Baron and Thomas Klausner for libzip \n
|
|
* Jean-loup Gailly and Mark Adler for zlib \n
|
|
* Milan Ikits and Marcelo Magallon for GLEW \n
|
|
* And a lot more people!
|
|
|
|
|
|
ROADMAP:
|
|
|
|
Short-term plans:
|
|
|
|
@TODO Improve documentation.
|
|
STATE: EE ( Base ) documented what is needed.
|
|
EE::Window documented.
|
|
EE::System documented.
|
|
EE::Graphics documented.
|
|
EE::Audio documented.
|
|
EE::Math 30 to 40 % documented.
|
|
EE::UI Not documented at all.
|
|
EE::Physics Not documented at all, chipmunk documentation should help.
|
|
EE::Gaming Not documented at all.
|
|
|
|
@TODO Add more commented examples, showing at least the basic usage of the engine ( 10 or more examples at least ).
|
|
STATE: 3 examples available. ( 30 % )
|
|
|
|
@TODO Improve the map editor ( add triggers, tiles selection to copy paste in other zones of the map, undo/redo actions ).
|
|
STATE: Needs at least to reoffset tiles and objects for the map resizing.
|
|
Tile selection i'm not decided yet.
|
|
Copy-Paste will be moved for a middle to long term plan.
|
|
|
|
@TODO Stabilize the API
|
|
STATE: DONE.
|
|
|
|
@TODO Improve Premake4 support. It should be really easy to compile eepp in Windows and OS X ( Linux is always easy thanks to package managers ).
|
|
STATE: DONE.
|
|
|
|
@TODO Add PVRTC and ETC support.
|
|
STATE: DONE.
|
|
|
|
Middle-term plans:
|
|
|
|
@TODO Add Networking support.
|
|
STATE: I'll use SFML network adapted to the engine coding style.
|
|
|
|
Long-term plans:
|
|
|
|
@TODO Add audio recording from the SFML implementation, adapted to the engine coding style.
|
|
|
|
@TODO Add Scripting support ( squirrel or angel script or lua ), at least some parts of the engine. Binding everything seems too much work.
|
|
STATE: I've binded some classes with lua+luabind and is awesome, but... luabind is bloated ( and for my needs it's the only good option ), and adds A LOT of compile time.
|
|
squirrel+sqrat almost does everything i need, but it have some bugs that seems to be unfixable ( none enum parameters, char parameters segfaults, no constructor overloading ).
|
|
|
|
@TODO Support UI Theming from scripts or XML.
|
|
|
|
@TODO Add some kind of support for TMX map files ( Tiles Map Editor ).
|
|
|
|
@TODO Pathfinding and AI helpers ( A*, FSM ).
|
|
|
|
*/
|
|
|
|
// General includes and declarations
|
|
#include <eepp/base.hpp>
|
|
#include <eepp/version.hpp>
|
|
using namespace EE;
|
|
|
|
// Math
|
|
#include <eepp/math.hpp>
|
|
using namespace EE::Math;
|
|
|
|
// System
|
|
#include <eepp/system.hpp>
|
|
using namespace EE::System;
|
|
|
|
// Audio
|
|
#include <eepp/audio.hpp>
|
|
using namespace EE::Audio;
|
|
|
|
// Window
|
|
#include <eepp/window.hpp>
|
|
using namespace EE::Window;
|
|
|
|
// Graphics
|
|
#include <eepp/graphics.hpp>
|
|
using namespace EE::Graphics;
|
|
|
|
// UI
|
|
#include <eepp/ui.hpp>
|
|
using namespace EE::UI;
|
|
using namespace EE::UI::Tools;
|
|
|
|
// Gaming
|
|
#include <eepp/gaming.hpp>
|
|
using namespace EE::Gaming;
|
|
using namespace EE::Gaming::MapEditor;
|
|
|
|
// Physics
|
|
#include <eepp/physics.hpp>
|
|
using namespace EE::Physics;
|
|
#endif
|