Getting Started with Edgegap

With Edgegap being included with Fish-Networking you can quickly get started in only a few minutes. Check out our official step-by-step video tutorial on using Edgegap with Fish-Networking.

Complete Video Instructions

If you prefer video tutorials we also have a short video showing how to install and deploy your game with Edgegap!

If you choose to skip over the video you will find our written guide below.

Installing

WARNING! The Edgegap plugin published on Unity Asset Store is outdated and not supported anymore. If you've previously installed our plugin by another method than described above, please remove any Edgegap files or dependencies related before updating your plugin using the git URL.

We like to recommend using the Package Manager to install Edgegap. This is the easiest way to quickly install and stay up to date. Other installation methods are available as well if the Package Manager is not for you.

Installing through the Package Manager requires having a git client installed; most developers already meet this criteria. If you do not have a git client you may download one here. Alternatively, you can choose to install another way.

  • First open your Package Manager within Unity by going to Window -> Package Manager.

  • Choose a git URL to install from. Both of these links install the same files, but using the appropriate link helps us understand better how developers are using Fish-Networking.

Copy a link below.

If you downloaded FishNet from the asset store please use:

https://github.com/edgegap/edgegap-unity-plugin.git#partner/fishnet-assetstore

Otherwise, please use:

https://github.com/edgegap/edgegap-unity-plugin.git#partner/fishnet-source

  1. After copying a link, click the + sign in your Package Manager window, and choose Add Package from git url.

  2. Paste the link you copied, and click Add.

  3. After successfully installing Edgegap you will now be able to access their Unity menu under Tools.

Zip Archive

Installing using a zip archive does not require any special tools. When using this approach Edgegap updates must be done manually, should you choose.

If you decide to switch to using the Package Manager later you may simply delete your current Edgegap installation and follow the Package Manager instructions above.

  • Choose a link to install from. Both of these links install the same files, but using the appropriate link helps us understand better how developers are using Fish-Networking.

Navigate to a link below.

If you downloaded FishNet from the asset store please use:

https://github.com/edgegap/edgegap-unity-plugin.git#partner/fishnet-assetstore

Otherwise, please use:

https://github.com/edgegap/edgegap-unity-plugin.git#partner/fishnet-source

  1. Click the Code button, and choose Download Zip.

  2. Open the downloaded file, and copy the edgegap-unity-plugin-main folder to your project's Assets folder.

  3. Once files are copied, you can find Edgegap in your project. You may move and remain the folders as you like.

Installing Dependencies

To operate Edgegap requires Newtonsoft Json to be installed within your project. Most installations of Unity have this dependency included automatically.

If you do not have Newtonsoft Json installed, or are unsure, you can quickly add it using the Package Manager.

  • Within Unity navigate to Window -> Package Manager.

  • Click the + sign in the top left of the Package Manager window, and choose Add package by name.

  • Enter com.unity.nuget.newtonsoft-json while leaving the version field empty, then click Add.

Detailed Written Guide

A fully detailed installation and usage guide is provided directly on Edgegap's website.

You can also find instructions tailored specifically to Fish-Networking here.

Last updated