Skip to content

Latest commit

 

History

History
47 lines (33 loc) · 1.53 KB

README.md

File metadata and controls

47 lines (33 loc) · 1.53 KB

Nodes

A minimal backend for nodes.

Features

  • No external dependencies - only the C++ standard library is used
  • Backend only - you can implement your own frontend
  • Simple API (at least in my opinion)
  • Node muting
  • Node groups (see the example group node under src/nodes/groupnode.[cpp,h])

What Is Missing/What I'll Work On Next

  • Looping
  • Evaluation using concurrency/parellism

Compiling

This assumes you already have C/C++ and CMake already set up.

  1. Download or clone this repository
  2. Open a terminal in the top level directory.
  3. Run mkdir build && cd build
  4. Run cmake ..
  5. Run the appropriate command for the compiler you're using, i.e.
make
# or
ninja
# or
clang
# etc.

Running

To run the example found in src/main.cpp, run ./src/nodes{{OS EXECUTABLE EXTENSION}} still inside of the build/ directory, where {{OS EXECUTABLE EXTENSION}} is the operating system's executable extension, i.e. blank for Linux, .exe for Windows, etc..

Additional Notes

  • As of writing, I am not completely convinced that this uses the most efficient evaluation system. A key problem is that the whole node tree is evaluated every time, even if some nodes don't need to be run again.
  • I am not entirely sure how much I will maintain this repository, particularly as this was originally intended to be a prototype for Gimel Studio, but if there is enough interest I will continue working on it.

License

This project is released under the MIT license. Do what you wish with it. :)