Repository files navigation

This plugin has been tested, and supports Unity versions 2021.2+, including all LTS releases, Unity 2023, and Unity 6.

This plugin is intended to help you:

• get started quickly with Dedicated Servers on Edgegap,
• make your server build iteration as fast as possible,
• make multiplayer development 10x easier by removing the need to learn Linux, Docker, or Cloud concepts.

This plugin does not need to be included in your builds, as it's only a development tool and does not have any runtime features.

• Get the freshest updates the moment they come out, seethe update guide.

• Requirement: functioning git client installed, for examplegit-scm.

1. Open your Unity project,
2. Select toolbar optionWindow ->Package Manager,
3. Click the+ icon and selectAdd package from git URL...,
4. Input the following URLhttps://github.com/edgegap/edgegap-unity-plugin.git,
5. ClickAdd and wait for the Unity Package Manager to complete the installation.

• Slightly easier as no git client is required.

• Installing our plugin this way will require you to manually replace plugin contents if youwish to update it,
• The newtonsoft package (dependency) version required may not be compatible with your project if you're already using an older version of this package.

1. Select toolbar optionWindow ->Package Manager,
2. Click the+ icon and selectAdd package by name...,
3. Input the namecom.unity.nuget.newtonsoft-json and wait for the Unity Package Manager to complete the installation.,
4. Back to this github project - make sure you're on themain branch,
5. Click<> Code, thenDownload ZIP,
6. Paste the contents of the unzipped archive in yourAssets folder within Unity project root.

The only other official distribution channels for this plugin are:

• Mirror Networking source
• Mirror Networking free package
• Mirror Networking LTS package
• PurrNet Networking source
• PurrNet Networking on Unity Asset Store
• PurrNet Networking on OpenUPM

Once you have it, check forTools ->Edgegap Hosting in Unity's top menu.

To take full advantage of our Unity plugin's build features, you will need to:

• Create an Edgegap Free Tier account,
• Install Docker Desktop (or Docker CLI),
• Install Unity Linux Build Support modules for Unity.

From here, we recommend following ourUnity Plugin Guide to get your first dedicated server deployed.

If you've installed using git, to update our plugin, locate it in Unity'sPackage Manager window and clickUpdate. Wait for the process to complete and you're good to go!

If you've installed by copying, you will have to remove the Edgegap folder and paste the newer copy. Your settings are saved in your Unity version, so they shouldn't be lost in this process.

This section is only for developers working on this plugin or other plugins interacting / integrating this plugin.

This project usesCSharpier code formatter to ensure consistent and readable formatting, configured in/.config/dotnet-tools.json.

SeeEditor integration for Visual Studio extensions, optionally configureReformat with CSharpier on Save under Tools | Options | CSharpier | General. You may also configurerunning formatting as a pre-commit git hook.

If you wish to detect presence of this plugin in the users Unity Editor, you can do so using a compiler directive:

#ifEDGEGAP_PLUGIN_SERVERS{...your code...}#endif