Getting Started

Getting Started

⚠️ This wiki is under construction. Pages are being populated incrementally.

This guide walks you through setting up Nodens from scratch — from installing prerequisites to running your first application.

Prerequisites

Tool	Minimum Version	Notes
C++ Compiler	Clang 22+	Must support C++23 modules. See Building and Toolchain for compatibility details.
CMake	3.30+	Required for FILE_SET ... TYPE CXX_MODULES support.
Ninja	Any recent	Required. Unix Makefiles do not support C++20 module dependency scanning.

Building from Source

git clone https://github.com/EldritchCodex/Nodens.git
cd Nodens
cmake -B build -G Ninja -DCMAKE_BUILD_TYPE=Debug
cmake --build build

Verifying the Build

Using Nodens via FetchContent

include(FetchContent)

FetchContent_Declare(nodens
    GIT_REPOSITORY https://github.com/EldritchCodex/Nodens.git
    GIT_TAG        dev
)
FetchContent_MakeAvailable(nodens)

add_executable(myapp main.cpp)
target_link_libraries(myapp PRIVATE Nodens::Nodens)

Your First Nodens Application

import Nodens;

class MyApp : public Nodens::Application {
public:
    static inline const Nodens::ApplicationSpecification appSpecifications = {
        .Name         = "My Nodens Application",
        .WindowWidth  = 1280,
        .WindowHeight = 720,
        .EnableGUI    = true,
        .IsHeadless   = false,
    };

    MyApp() : Application(appSpecifications) {
        // Add layers here, e.g., PushLayer(new MyLayer());
    }
};

int main()
{
    Nodens::InitializeLoggers();

    auto app = MyApp();
    app.Run();

    return 0;
}

Running the Examples

Next Steps

• Architecture Overview — Understand how the framework is structured.
• Creating a Custom Layer — Build something interactive.
• Building and Toolchain — Troubleshoot build issues.