mezzanine_engine.h

// © Copyright 2010 - 2016 BlackTopp Studios Inc.
/* This file is part of The Mezzanine Engine.

    The Mezzanine Engine is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    The Mezzanine Engine 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 General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with The Mezzanine Engine.  If not, see <http://www.gnu.org/licenses/>.
*/
/* The original authors have included a copy of the license specified above in the
   'Docs' folder. See 'gpl.txt'
*/
/* We welcome the use of the Mezzanine engine to anyone, including companies who wish to
   Build professional software and charge for their product.

   However there are some practical restrictions, so if your project involves
   any of the following you should contact us and we will try to work something
   out:
    - DRM or Copy Protection of any kind(except Copyrights)
    - Software Patents You Do Not Wish to Freely License
    - Any Kind of Linking to Non-GPL licensed Works
    - Are Currently In Violation of Another Copyright Holder's GPL License
    - If You want to change our code and not add a few hundred MB of stuff to
        your distribution

   These and other limitations could cause serious legal problems if you ignore
   them, so it is best to simply contact us or the Free Software Foundation, if
   you have any questions.

   Joseph Toppi - toppij@gmail.com
   John Blackwood - makoenergy02@gmail.com
*/
#ifndef _dox_mezzanine_engine_h
#define _dox_mezzanine_engine_h


/**
    @page mezzanine_engine %Mezzanine Engine

    The %Mezzanine Engine is Framework for building 3d physics enabled video games. It is written in
    and intended for C++ development. The Mezzanine Engine is designed to be re-usable and genre
    agnostic, so that it can be used in as many games as possible.

    @n
    It is released
    under an open source license, the GPLv3 and can readily be used by hobbyists or for educational.
    For licensing without GPL restrictions, including commercial licensing, please @ref contact_us
    All of the dependencies are open source as well enabling you or your team to investigate and
    understand every single bit of what our engine is doing.

    @n
    Unlike many other libraries out there we do not expect snooping through source code to be the
    only method of understanding the library. We have rigorously documented all the components of
    our engine and have made available @ref tech_doc_index "Doxygen generated documentation" to help
    you understand our code. We’ve even included a couple extra manuals and articles about some
    higher level usage of parts of our engine, and plan to include more articles for other parts of
    the engine as it is developed and matures.

    @section mezzanine_engine_goals Goals
    We have a number of goals going into this when we started this project:

    - Provide every major library/resource a typical A+ quality game needs
        - 3d Graphics
        - Real time physics
        - 3d surround sound
        - Intelligent Multithreading
    - User input
        - Keyboard
        - Mouse
        - Joystick
    - Work on every major gaming platform
        - PC – Currently works on Windows, Linux and Mac OS X
        - Mobile Platforms – Working on Android and iOS Support
        - Active research into obscure platforms (NaCL, Other mobile, etc)
    - Completely insulate games built with this from needing any platform specific code.
    - Maintain backward compatibility as long as technically feasible.
    - Modular reusable design
*/



#endif