Skip to content
lunazera edited this page Nov 25, 2023 · 187 revisions

VNyan documentation

VNyan uses an easy to use Node Graph-based interface allowing you to design chat interactions, model movements, and more!

Graphs

VNyan graphs are separated pages for your node setups. They can be exported and loaded, allowing for sharing with others.

Graphs can be rearranged using the arrows on the top right of the menu and can be toggled off, preventing them from running. The graph order can dictate the order that nodes execute, which may sometimes be relevant if two graphs are connected in some way by using the same parameters, triggers, or if they activate nodes that override each other.

Graphs are saved as JSON files.

Nodes

Nodes are the main building blocks of VNyan Graphs. They can any number of input sockets and output sockets depending on each node's function. Wires can be drawn between the input and output sockets of other nodes to chain when and how different nodes activate.

You can connect multiple wires to each socket. The order that nodes are wired into a socket generally dictates the order that the nodes execute. However, this is not always reliable and the order can sometimes change on application restart or when loading the graph (if the order is important for your graph setup, the Ordered Execution node should be used).

Node Types

Parameters

File system

VNyan saves most of it's settings in your AppData LocalLow folder.

Typical path: C:\Users\USERNAME_HERE\AppData\LocalLow\Suvidriel\VNyan

Here you can find your main profile's loaded graphs named redeems*.json (with * being the graph number starting from 1), settings named settings.json, various log files, a folder of backups for your graph and settings files, and a folder for additional profiles.

Each profile itself is another folder with similar organization.

Profiles

As of version 1.1.2, VNyan supports having multiple launch profiles. Each profile has its own settings, node-graphs, and environment allowing for multiple instances of VNyan to run at the same time.

Profiles work through command line arguments. All you have to do is pass a command line argument to VNyan when starting it.

For example: VNyan.exe -p NyanNyan This would start VNyan with profile called NyanNyan. If the profile doesn't exist then an empty one will be created. There is no profile limit, so you can create as many as you need.

VNyan comes with a cmd-file called VNyan_Profile_Example.cmd. This file can be opened in notepad and you can change the profile name there making it super easy to just double click the cmd instead of having to type the argument every time.

Example cmd-file:

@echo off
echo Launching VNyan with different profile

VNyan.exe -p ExampleProfile

You can also set up shortcuts for VNyan.exe and put the -p ExampleProfile command line code at the end of the Target line.

Clone this wiki locally