VNyanNet - Suvidriel/VNyanDoc GitHub Wiki

VNyanNet is VNyan's collaboration feature. It utilizes a dedicated server system to allow easy connectivity for VTubers without the need to worry about vpn-tunnels or other difficult settings. Only the server needs to be configured. Due to not being peer-to-peer it also adds a layer of security for VTubers

Requirements

You're recommended to use VSFAvatar-format for your avatars when using VNyanNet. While VNyanNet does also support vrm0, it's not recommended for collabs. This is because VSFAvatar files load much faster and don't suffer from majority of vrm-format's issues. They're also a much safer format to be used in a collaboration environment. In addition to that they support VNyan SDK components that extend the usability of VNyanNet.

How to use

Using VNyanNet is very easy. All you have to do is click the VNyanNet-button in VNyan. After this you'll need to enter the server details. If you're joining a collaboration then the host will give you the necessary server address, password and lobby details. Fill in those and also come up with a username to use during the collaboration. Once you've filled necessary information just click the Connect-button.

After you're connected to the lobby, VNyan will assign all the other guests a position slot starting from 1. These position slots can be changed in the VNyanNet-dialog. The actual positions can be set by using VNyan SDK's VNyanNet position slot-component. VNyan comes with 6 pre-made props for settings positions so you can use those or alternatively you can create your own positions in either a world or other assets.

Interactions

VNyanNet adds 2 new Remote Procedure Call-nodes to VNyan. These nodes can be used to broadcast an RPC-call to all lobby members. You can also react to received RPC calls with the callback node.

RPC calls could be used for example to create redeems that yeet all collab members etc.

Setting up Server

Setting up VNyanNet Server requires basic knowledge on how to configure dedicated game servers.

First step is to configure the VNyanNet.cfg file to set your server password. You can edit this file in for example notepad.

Next you'll have to configure the firewall. VNyanNet requires the following 2 ports to operate:

• UDP 2456
• TCP 2457