Documentation

How to build with nonoha, from running your first workspace to writing nodes, plugins, and your own web UI.

  1. Getting started

    Get nonoha-engine from GitHub and run the template workspace. You watch an app process a signal in the browser, then read and change the same graph through its JSON file and the API.

  2. Concepts

    This page explains what makes up a nonoha graph (workspaces, flows, graphs, nodes, and ports) and the data that flows between them. The examples use the template workspace you ran in Getting started.

  3. Writing nodes and plugins

    A node is a plain Python class, and a plugin is a plain Python package of nodes. This page adds two nodes to the template's plugin, connects them in the graph, and runs them.

  4. Your own web UI

    A workspace's app is made of HTML and JavaScript pages. The engine serves them at /app, and a page talks to the graph's input and output ports over WebSocket. On this page you drive Gain and Counter, the nodes added in Writing nodes and plugins, from a page.