Libraries and the File System

Libraries and the File System

What is a Library

A library is, for all intents and purposes, the various nodegraphs that you can refer to in other nodegraphs. Libraries act very much like programming libraries, providing functionality that you would otherwise need to build yourself. Libraries are identified by the "lib.json" file.

Where are these Libraries

The user created libraries will typically go into your Documents/ProcFlow/Libraries directory. Note that the default base nodegraphs that come with ProcFlow will be located where your ProcFlow application is.

How is "lib.json" structured

The file "lib.json" is a simple json object that holds the name of the library, the UUID of the library, the author of the library, what version of library structure the library is, for backwards compatibility. When ProcFlow starts it looks for this file in every folder in the Documents/ProcFlow/Libraries path.

The fields of the root JSON object are as follows:

{
    "name": "name-of-library",
    "uuid": <uuid>,
    "author": "your-user-name",
    "format": 1
}

Library Graphs

The graphs within a library are found in named folders recursively anywhere within the library's directory. ProcFlow will search for folders containing a "node.json" file. This directory represents the entire graph.

Node Dependencies

You are currently responsible as a user to determine what dependencies to download. That being said, ProcFlow (both the client and the library) will warn you when a node attempts to summon a node that it cannot find.

TODO