Getting started - Suvidriel/VNyanDoc GitHub Wiki

VNyan can be installed automatically through the Itch app. Simply open the Itch app, navigate to the VNyan page, click install, select the install location, and wait for installation to be completed!

Alternatively, VNyan can be installed manually. Download the VNyan .zip folder on Itch and extract in the desired location.

If VNyan is installed through the Itch App, it can be ran by pressing the Play button in the bottom right of VNyan's Itch page. VNyan can also be launched by opening the VNyan.exe file in the install folder without opening the Itch App. Using VNyan.exe, VNyan can also be launched in administrator mode. Opening VNyan through the Itch App requires your install to be up-to-date.

When you first open VNyan, you will be greeted by a startup wizard. The startup wizard will help you configure VNyan for the first time, but can be skipped (for example if you are importing a profile from another computer). The wizard will help you set up your model, your tracking, your model's expressions, and Youtube/Twtich integration. The startup wizard can be opened up at any time from the 'Help' menu on the right side of the screen.

If you experience lag with VNyan, you can run it in GPU Priority mode. There is a .cmd file called VNyan_GPUPriority.cmd that you can run instead of VNyan.exe, which will open VNyan using the GPU Priority setting. This will also run VNyan with Administrator privileges.

Alternatively, you can create a shortcut for VNyan.exe that automatically opens VNyan in GPU Priority Mode. After creating a shortcut, right-click the shortcut and open Properties, then add -gpu at the end of the Target line (the top field; include a space before -gpu). Make sure to also set VNyan to run with Administrator privileges.

Note:
If other programs like OBS are running in Administrator mode when VNyan is not, then hotkeys in VNyan may not register as intended when VNyan is not the active window. It is recommended to run VNyan in Administrator mode when other software is also running in Administrator mode.

Whenever a new version of VNyan is available, green text at the left of the window will pop up informing you.

If VNyan is installed through the Itch App, VNyan can be updated simply by opening the Itch App, navigating to the VNyan page, and pressing Update in the lower right corner. Make sure that the itch.io app updates VNyan into the same installation folder as the old version, rather than into a newly created folder.

To update a manual install of VNyan, download the latest version, extract the archive and copy it to your pre-existing install folder. Replace any existing files when prompted.

If items or plugins are missing after installing a new version, it is possible that you are running VNyan from a different folder than before. Try to find your previous install folder for VNyan and move the new install there.

WARNING As VNyan is in active development, updates are not backwards compatible. Graphs may break if you try to downgrade VNyan to previous versions. In particular, if a newer version has newly implemented nodes, any graph that contains this new node will be broken along with every other graph after it. If you need to use a previous version, try removing the newer nodes in the latest version before downgrading.

VNyan saves most of its settings in your AppData LocalLow folder. Typically, this means the following path: C:\Users\USERNAME_HERE\AppData\LocalLow\Suvidriel\VNyan. (Note that the AppData folder is typically hidden.)

In this folder, you can find your main profile's loaded graphs (named redeems*.json, with * being the graph number starting from 1, and the first graph being named simply redeems.json), 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.

VNyan saves a backup of all your graphs and settings once per day if VNyan has been opened and your graphs or settings have been modified. The backups are located in C:\Users\USERNAME_HERE\AppData\LocalLow\Suvidriel\VNyan\backup. Each backup file contains the date it was created, in yyyymmdd format. If you lose your graphs or settings for any reason, you can check here and use the files from a previous date.

Profiles allow you to create and save different configurations of settings and graphs. This can be used to keep separate configurations for different models, for instance if you are a rigger needing to have different sets of Node Graphs for different clients.

A new profile is created whenever a non-existent profile is opened. To open a VNyan profile, you can create a shortcut and configure its properties so that the Target Line includes -p *ProfileName*. Alternatively, you can create a .cmd file to open VNyan with a specific profile or a prompt to specify a profile, using the -p argument. VNyan_Profile_Example.cmd in the VNyan install folder serves as an example to load a specific profile through a .cmd file. It can be edited with Notepad.

Portable mode is used to store user settings in the VNyan install folder, rather than the AppData folder. For users who regularly need to copy their entire VNyan setup, including settings, props, etc, this places all data in one location for convenience. Portable mode can be selected using the -portable argument, similar to profiles. Multiple portable profiles can be created by combining the -portable and -p arguments.