Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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 2 hours 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-03-21T01:45:23.000Z (6 months ago)
Last Synced: 2024-03-21T02:46:48.441Z (6 months 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.73 MB
Stars: 955
Watchers: 28
Forks: 61
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        [![Linux](https://github.com/nCine/nCine/workflows/Linux/badge.svg)](https://github.com/nCine/nCine/actions?workflow=Linux)

[![macOS](https://github.com/nCine/nCine/workflows/macOS/badge.svg)](https://github.com/nCine/nCine/actions?workflow=macOS)

[![Windows](https://github.com/nCine/nCine/workflows/Windows/badge.svg)](https://github.com/nCine/nCine/actions?workflow=Windows)

[![MinGW](https://github.com/nCine/nCine/workflows/MinGW/badge.svg)](https://github.com/nCine/nCine/actions?workflow=MinGW)

[![Emscripten](https://github.com/nCine/nCine/workflows/Emscripten/badge.svg)](https://github.com/nCine/nCine/actions?workflow=Emscripten)

[![CodeQL](https://github.com/nCine/nCine/workflows/CodeQL/badge.svg)](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