Skip to content

EldritchCodex/NodensAppTemplate

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Nodens App Template

A clean template for prototyping interactive applications using the Nodens C++ framework.

Features

  • Pre-configured Build System: A modern CMakeLists.txt setup that links correctly against the Nodens framework.
  • Clean Architecture: Separates application logic (TemplateLayer) from the framework entry point (TemplateApp).
  • Ready-to-Run: Includes a basic ImGui window and update loop to verify your environment immediately.
  • Debug/Release Configurations: Pre-set compile definitions (ND_DEBUG, ND_RELEASE) for proper logging behavior.

Prerequisites

  • C++ Compiler: A compiler with C++23 support.
  • CMake: Version 3.8 or higher.
  • Git: For managing the repository and the Nodens submodule.

Getting Started

Clone the Repository

Since this project depends on the Nodens framework, use the --recursive flag to pull the framework source code automatically.

git clone https://github.com/EldritchCodex/NodensAppTemplate.git --recursive

If you have already cloned without --recursive, you can initialize the submodules manually:

git submodule update --init --recursive

How to Customize

  1. Rename the Project:

    • Open CMakeLists.txt and change the project name:
      project(YourApp VERSION 0.1.0 LANGUAGES CXX)
    • Update the window title in src/TemplateApp.cpp:
      Application(Nodens::WindowProps("YourApp", 1280, 720))
  2. Add Your Logic:

    • Open src/TemplateLayer.cpp.
    • Use OnUpdate(ts) for core logic and state updates.
    • Use OnImGuiRender(ts) for rendering UI elements.

License

This project is licensed under the MIT License - see the LICENSE file for details.

About

Template repo for Nodens-based applications

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published