NasNas: A C++ repository from Madour

An intuitive and beginner friendly 2D game framework for C++.

Features • How to build • Get Started • Screenshots • Showcase • Support

NasNas is a lightweight cross platform modular 2D game framework.

It is entirely written in modern C++17, and uses SFML2 for rendering.

It provides a clean and easy to use API.

The framework is separated in multiple modules :

Core is the only non-optional module. It is needed to create a NasNas application. It contains core classes and data needed by the framework.
ECS is an efficient data driven Entity Component System. It allows you to attach components to entities and run systems on specific sets of components.
Reslib contains the resource manager and resource loader. It handles resource loading and accessing in an elegant way.
Tilemapping is a Tiled Map loader (.tmx). It seamlessly integrates with NasNas and speeds up development for tile based games.
Tween allows you to animate any object using the provided or custom easing functions.
UI contains the User Interface utilities. (WIP)
More modules will be developed in the future !

Click to see platforms support

	Core	Ecs	Reslib	Tilemapping	Tween	Ui
Windows	✔️	✔️	✔️	✔️	✔️	✔️
Linux	✔️	✔️	✔️	✔️	✔️	✔️
MacOS	✔️	✔️	✔️	✔️	✔️	✔️
Android	✔️	✔️	✔️	✔️	✔️	✔️
iOS	❓	❓	❓	❓	❓	❓

Features

Implemented :

To do :

Menus and UI

Future :

Splash screens
Levels and game events management
In-game command line for debugging

You can find a global roadmap for the version 1.0 on the project board

Build

Desktop

Clone the repository.

git clone https://github.com/Madour/NasNas
cd NasNas

Then, you can build the static libraries with :

mkdir build && cd build
cmake ..
cmake --build . -j4

Finally, you can install those libraries using :

cmake --install .

Android

To build the framework for Android, please refer to the Android example's readme

Available CMake options :

-DNASNAS_BUILD_ECS=OFF to disable the ECS module
-DNASNAS_BUILD_RESLIB=OFF to disable the Reslib module
-DNASNAS_BUILD_TILEMAPPING=OFF to disable the Tilemapping module
-DNASNAS_BUILD_TWEEN=OFF to disable the Tween module
-DNASNAS_BUILD_UI=OFF to disable the UI module
-DNASNAS_EXAMPLES=ON to create the example applications targets
-DNASNAS_BUILD_SFML=ON to download and build SFML inside the project (enabled automatically if SFML package is not found)
-DNASNAS_STATIC_VCRT=ON to link the Visual C++ runtime statically (/MT) when using the Microsoft Visual C++ compiler

Get Started

Here is a sample code using NasNas framework, this will create a 720x480 window and log a string to the console :

#include <NasNas/Core.hpp>

class Game : public ns::App {
public:
    Game() : ns::App("My game", 720, 480) {
        ns_LOG("Created a NasNas app !");
    }
    void onEvent(const sf::Event& event) override {
        if (event.type == sf::Event::Closed)
            getWindow().close();
    }
    void update() override {}
};

int main() {
    Game g;
    g.run();
    return 0;
}