diff --git a/Getting-started.md b/Getting-started.md new file mode 100644 index 0000000..b8e6e6f --- /dev/null +++ b/Getting-started.md @@ -0,0 +1,55 @@ +# Getting Started + +## Installation +To install, download the latest version of [VNyan from itch.io](https://suvidriel.itch.io/vnyan) and extract to a folder of choice on your computer. Open `VNyan.exe` to start! + +## Updating VNyan +To update VNyan, download the latest version, extract the archive and put it in your pre-existing install folder with replacement. + +Note that VNyan updates are not meant to be backwards compatible, especially as the program is still in development. Thus you will not find previous versions available for download. + +Graphs may break if you try to downgrade VNyan to previous versions. In particular, if a newer version has a new node that the older version does not, any graph that contains this new node will be broken along with every other graph after it. You should still be able to open VNyan with the latest version where you added these new nodes and remove them to maintain some compatibility. + +### Using the itch.io app +You can use the [itch.io app](https://itch.io/app) to manage your VNyan installation. This will allow you to automatically download and install new updates. Make sure that the itch.io app updates VNyan into the same installation folder rather than making new folders, or you might find that some of your settings, props and objects get unset. + +## Startup +When you first open VNyan, you will be greeted by a startup wizard. + +# 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 `-p ExampleProfile` at the end of the Target line. + +## GPU Priority Mode +If you experience lag with VNyan, you can start it in GPU Priority mode. There is a cmd file `VNyan_GPUPriority.cmd` that you can run instead of VNyan.exe which will open using this setting. This will also run VNyan with Administrator privileges. + +Alternatively, you can create a shortcut for VNyan.exe and put `-gpu` at the end of the Target line. Just make sure to also set VNyan to run with Admin privileges. + +Note that due to how Windows admin mode works, the Hotkey node will not be able to read keyboard inputs then VNyan is out of focus. You will still be able to use Websocket triggers and those can be set up in place of hotkeys. \ No newline at end of file diff --git a/Node-Graphs.md b/Node-Graphs.md new file mode 100644 index 0000000..9708de6 --- /dev/null +++ b/Node-Graphs.md @@ -0,0 +1,25 @@ +# Node Graph System +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. + +You can navigate in graphs by dragging with the middle mouse button, and zooming in and out with the scroll wheel. + +## 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 +* [[Callback nodes|Callback Nodes]] - Nodes that send trigger on different events. +* [[Action nodes|Action Nodes]] - Nodes that apply an action or effect when triggered. +* [[Gateway and Other Nodes|Conditional Nodes]] - Conditional Nodes and Nodes with more specific or complex operations + +## Parameters +* [[How parameters work?|Parameters]] \ No newline at end of file