Skip to content

gouki04/Node_Editor

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Node Editor Framework for Unity

A flexible and modular Node Editor Framework for creating node based displays and editors


Node Editor Image

WebGL Demo - Forum Thread - Documentation

Major Features

  • Convenient editor with zooming and panning capabilities
  • Advanced modular traversal system used to calculate, update or traverse the canvas in any other way
  • Custom drag'n'drop node connection system
  • Dynamic extension of Controls, Nodes, Connections, NodeCanvases and their behaviour without touching framework code
  • Extensive control over Node/Knob/Connection appearance and generally modifiable GUI skin
  • Save/Load node canvas to asset or scene with auto-save functionality
  • Growing runtime support, both for traversing and even editing the canvas in-game
  • Documentation and active support:)
  • Many great examples found in the repo branches

Examples

There are several great examples depending on how you are planning to use the framework. You can find them as a subbranch of this repo in Examples/... and need to be copied into a project already containing the Node Editor Framework (most use the develop branch!):

  1. The Texture Composer, as seen in the title screen, is a very simple setup of a few texture nodes built upon the default calculation canvas in the framework. Start here to get a basic idea on how to create simple extensions of the framework with custom functionality.
  2. A great, but complex example is the Dialogue System, developed and maintained by ChicK00o and atrblizzard. Making excellent use of the framework's modularity to extend the frameworks capability and behaviour to get a basic dialogue system, including the editing and runtime execution (with an example scene), up and running. Check it out if you want to get an idea of a bigger setup expanding on the Node Editor Framework with custom rules.
  3. Another set of nodes is the 'Expression Node' example. These are a bit different as they use reflection to inject any type of variable into the framework, to convert or execute code on. It's main purpose is to show complex modifications of the Node Knobs and general extended use of the framework.
  4. A small example of extending the editor controls can be seen in the included Node Group. It contains custom controls to handle without modifying any framework code.

Tip: Get the latest development version with the best features in the develop branch!

Documentation and Support

The documentation can be found in the 'Docs' folder as raw markdown files to use with mkdocs and the compiled html version is online here. Please post on the project thread or contact Seneral for any type of question regarding the framework, examples or documentation.

Contributing

If you want to contribute to this framework or have improved this framework internally to suit your needs better, please consider creating a Pull Request with your changes when they could help the framework become better. The issues section serves as a feature discussion forum and I encourage you to check it out to get an idea of the future plans for the framework. You can also PM the main developer Seneral directly if you wish so.

Credits

The project was started as a part of the thread "Simple Node Editor" in may 2015 by Seneral. Big thanks to Baste Nesse Buanes who helped to set up this repository initially, without his help the framework could not have expanded to the point where it is now! Also, thanks to Vexe, who has greatly helped with the reflection related stuff which is used for the zooming functionality of the editor. And of course thanks to everyone contributing or simply motivating the developers by sharing their work with the Node Editor Framework! You can find the full list of contributors here.

Licensing

The license used is the MIT License - see license.md

About

Node Editor framework for Unity3D

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C# 99.9%
  • GLSL 0.1%