Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nCine/nCine
A cross-platform 2D game engine
https://github.com/nCine/nCine
android cpp11 cross-platform emscripten game-development game-engine game-engine-2d gamedev imgui linux lua macos mingw ncine opengl real-time renderdoc rendering windows
Last synced: about 1 month ago
JSON representation
A cross-platform 2D game engine
- Host: GitHub
- URL: https://github.com/nCine/nCine
- Owner: nCine
- License: mit
- Created: 2019-05-28T17:31:43.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-10-11T01:05:33.000Z (2 months ago)
- Last Synced: 2024-10-29T22:32:03.433Z (about 1 month ago)
- Topics: android, cpp11, cross-platform, emscripten, game-development, game-engine, game-engine-2d, gamedev, imgui, linux, lua, macos, mingw, ncine, opengl, real-time, renderdoc, rendering, windows
- Language: C++
- Homepage: https://ncine.github.io/
- Size: 3.89 MB
- Stars: 1,070
- Watchers: 31
- Forks: 63
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-game-engine-dev - nCine - Cross-platform 2D game framework. (Libraries / C++)
- awesome-list - nCine - A cross-platform 2D game engine. (Game Engines / Data Management)
- awesome-game-engines - nCine - nCine is a cross-platform 2D game engine that runs on PC (Linux, Windows, macOS), Android, Raspberry Pi, and the web (Emscripten). The project has been in active development since June 2011. (Uncategorized / Uncategorized)
README
[](https://github.com/nCine/nCine/actions?workflow=Linux)
[](https://github.com/nCine/nCine/actions?workflow=macOS)
[](https://github.com/nCine/nCine/actions?workflow=Windows)
[](https://github.com/nCine/nCine/actions?workflow=MinGW)
[](https://github.com/nCine/nCine/actions?workflow=Emscripten)
[](https://github.com/nCine/nCine/actions?workflow=CodeQL)
# nCine
nCine is a cross-platform 2D game engine.
It is released under the MIT License, Copyright (c) 2011-2024 Angelo Theodorou.
For additional information: https://ncine.github.io
## Information
### Dependencies
- GLEW
- GLFW 3.x
- SDL 2
- libpng
- libwebp
- OpenAL-soft
- libogg, libvorbis, libvorbisfile
- Lua 5.4
- Dear ImGui
- Nuklear
### Supported Platforms and Compilers
- Windows (MSVC, MinGW-w64 on MSYS2)
- macOS (Clang)
- Linux (GCC, Clang)
- Android (GCC, Clang)
- Emscripten
### Development Tools
- git
- CMake
- Qt Creator
- Doxygen with GraphViz
- Valgrind
- Cppcheck
- clang-format
- Google Test and Gcovr
- Tracy frame profiler
- Google Benchmark
- RenderDoc graphics debugger
## Development
### Conventions
#### Coding Conventions
- Indent with tabs (4 spaces) but use spaces for continuation line alignment
- Allman brackets
- No brackets around one line conditional statements
- Padding space after parenthesis headers (`if`, `do`, `while`, `for`, `switch`)
- Align pointer and reference operator to the variable or function name
- `inline` keyword always before `virtual` and `static`
- Mark an override method with the `override` specifier and remove `virtual`
- Access specifiers order: `public`, `protected`, `private`
- One half indent for access specifiers (2 spaces)
- Declarations order: typedefs and enums, data members, constructors, destructors, methods
- Friends defined in the private section of a class, after everything else
- One space padding around operators
- Use of the `explicit` keyword all the times it makes sense
#### Naming Conventions
- Pascal case for classes, enumerations, typedefs and constants
- Camel case for variables, functions and parameters
- All upper case for enumerators in an enumeration
#### Documenting Conventions
- Put Doxygen brief descriptions in header files and additional documentation in implementation ones
- Use Qt style for Doxygen detailed descriptions (`/*! */`) and end them with a period