Magnum — *Lightweight and modular C++11/C++14 graphics middleware to power your dreams.* Looking for an open-source library that gives you graphics abstraction and platform independence on major desktop, mobile and web platforms? Do you want it to have all the convenience utilities around yet stay small, powerful and not give up on flexibility? *Here it is.* And it's free to use, even for commercial purposes. [![Join the chat at https://gitter.im/mosra/magnum](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/mosra/magnum?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Build Status](https://travis-ci.org/mosra/magnum.svg?branch=master)](https://travis-ci.org/mosra/magnum) [![Build Status](https://ci.appveyor.com/api/projects/status/5b477m034cfaskse/branch/master?svg=true)](https://ci.appveyor.com/project/mosra/magnum/branch/master) [![Coverage Status](https://coveralls.io/repos/github/mosra/magnum/badge.svg?branch=master)](https://coveralls.io/github/mosra/magnum?branch=master) [![MIT License](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) - Project homepage — http://magnum.graphics/ - Documentation — http://doc.magnum.graphics/ - GitHub project page — https://github.com/mosra/magnum Beauty of simplicity ==================== Among Magnum essentials is a UTF-8-aware OS, filesystem and console abstraction, a feature-packed vector math library and a slim C++11 wrapper of OpenGL / WebGL family of APIs. Build on top of that or opt-in for more. [See all core features](http://magnum.graphics/features/) With batteries included ======================= Shaders and primitives for fast prototyping, algorithms, debugging and automatic testing, asset management, integration with popular windowing toolkits and a UI library. Everything fits together but you still have a choice. [List the extra features](http://magnum.graphics/features/extras/) Screws are not glued in ======================= There's always more than one way to do things. Enjoy the freedom of choice and integrate your own asset loader, texture compressor, font format or math library, if you feel the need. Or use any of the various plugins. [View extension points](http://magnum.graphics/features/extensions/) ------- *Looking for more?* There's a [Showcase page](http://magnum.graphics/showcase/) right behind the corner with lots of WebGL demos. SUPPORTED PLATFORMS =================== - **Linux** and embedded Linux - **Windows**, **Windows RT** (Store/Phone) - **macOS**, **iOS** - **Android** - **Web** ([asm.js](http://asmjs.org/) or [WebAssembly](http://webassembly.org/)), through [Emscripten](http://kripken.github.io/emscripten-site/) Graphics APIs: - **OpenGL** 2.1 through 4.5, core profile functionality and modern extensions - **OpenGL ES** 2.0, 3.0, 3.1 and extensions to match desktop OpenGL functionality - **WebGL** 1.0, 2.0 and extensions to match desktop OpenGL functionality See the [Build Status page](http://magnum.graphics/build-status/) for detailed per-platform build status. BUILDING MAGNUM =============== You can either use packaging scripts, which are stored in the [package/](https://github.com/mosra/magnum/tree/master/package) subdirectory, or compile and install everything manually. A short guide is below, for better introduction it's advised to read through the [Getting Started Guide](http://doc.magnum.graphics/magnum/getting-started.html) in the documentation. Complete building documentation covering all platforms and feature sets is in the [Downloading and building](http://doc.magnum.graphics/magnum/building.html) page. Minimal dependencies -------------------- - C++ compiler with good C++11 support. Compilers which are tested to have everything needed are **GCC** >= 4.7, **Clang** >= 3.1 and **MSVC** >= 2015. On Windows you can also use **MinGW-w64**. - **CMake** >= 2.8.12 - **Corrade** — Plugin management and utility library. You can get it at https://github.com/mosra/corrade. Compilation, installation ------------------------- The library (for example with support for SDL2 applications) can be built and installed using these commands: ```sh git clone git://github.com/mosra/magnum && cd magnum mkdir -p build && cd build cmake .. \ -DCMAKE_INSTALL_PREFIX=/usr \ -DWITH_SDL2APPLICATION=ON make -j make install # sudo may be required ``` Building and running unit tests ------------------------------- If you want to build also unit tests (which are not built by default), pass `-DBUILD_TESTS=ON` to CMake. Unit tests use Corrade's TestSuite framework and can be run using ```sh ctest --output-on-failure ``` in build directory. Everything should pass ;) Building documentation ---------------------- The documentation is written using [Doxygen](https://doxygen.org). It can be build by running ```sh doxygen ``` in the root directory (i.e. where `Doxyfile` is). You might need to create the `build/` directory if it doesn't exist yet. Resulting HTML documentation will be in the `build/doc/` directory. Snapshot of the documentation is [also available for online viewing](http://doc.magnum.graphics/). GETTING STARTED =============== The best way to get started is to read the thorough [download, build, install and start using Magnum](http://doc.magnum.graphics/magnum/getting-started.html) in your project. After that, there are various [tutorials and examples](http://doc.magnum.graphics/magnum/example-index.html) and a complete [feature guide](http://doc.magnum.graphics/magnum/features.html) explaining all aspects of the library. RELATED PROJECTS ================ The engine itself is kept as small as possible with only a few dependencies. Additional functionality, often depending on external libraries, is provided in separate repositories. - **Corrade** — main Magnum dependency, a multiplatform utility library: https://github.com/mosra/corrade - **Magnum Bootstrap** — bootstrap projects for many use cases, helping you get up and running in no time: https://github.com/mosra/magnum-bootstrap - **Magnum Plugins** — various importer plugins for image, font, audio and 3D model formats is at https://github.com/mosra/magnum-plugins-plugins/branch/master) - **Magnum Integration** — integration with various external math and physics, get it at https://github.com/mosra/magnum-integration - **Magnum Examples** — examples of engine usage, varying from simple *Hello World*-like example to more advanced applications, such as viewer for complex 3D models. See it at https://github.com/mosra/magnum-examples - **Magnum Extras** — playground for testing new APIs, specialized stuff that doesn't necessarily need to be a part of main Magnum repository or mutually exclusive functionality: https://github.com/mosra/magnum-extras - **libRocket integration** — integrates Magnum as rendering backend into [libRocket](https://github.com/libRocket/libRocket) GUI library: https://github.com/miguelmartin75/Magnum-libRocket - **Dear IMGUI integration** — integrated Magnum as rendering backend into [Dear IMGUI](https://github.com/ocornut/imgui) library: https://github.com/denesik/MagnumImguiPort - **Magnum Inspector** — Gtk-based inspector window running alongside Magnum https://github.com/wivlaro/magnum-inspector CONTACT & SUPPORT ================= If you want to contribute to Magnum, if you spotted a bug, need a feature or have an awesome idea, you can get a copy of the sources from GitHub and start right away! There is the already mentioned guide about [how to download and build Magnum](http://doc.magnum.graphics/magnum/building.html) and also a guide about [coding style and best practices](http://doc.magnum.graphics/magnum/coding-style.html) which you should follow to keep the library as consistent and maintainable as possible. - Project homepage — http://magnum.graphics/ - Documentation — http://doc.magnum.graphics/ - GitHub project page — https://github.com/mosra/magnum - Gitter community chat — https://gitter.im/mosra/magnum - IRC — join the `#magnum-engine` channel on freenode - Google Groups mailing list — magnum-engine@googlegroups.com ([archive](https://groups.google.com/forum/#!forum/magnum-engine)) - Author's personal Twitter — https://twitter.com/czmosra - Author's personal e-mail — mosra@centrum.cz See also the Magnum Project [Contact & Support page](http://magnum.graphics/contact/) for further information. CREDITS ======= See the [CREDITS.md](CREDITS.md) file for details. Big thanks to everyone involved! LICENSE ======= Magnum is licensed under the MIT/Expat license, see the [COPYING](COPYING) file for details.