Ctrlk
edgegap.comDashboard
discordlinkedin
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Developer Tools

We build these tools for you with a simple mantra: “the keys to successful teams are fast iteration and frequent testing”. If you see an opportunity for improvement, please let us know in our Community Discord. We hope you will enjoy a smooth experience. 🚀

Find real world examples which you can use as a project starter and modify further.

Semantic Versioning

Our developer tools and managed services use official Semantic Versioning, indicating which updates are ✅ safe (minor, patch) and which may contain ⚠️ breaking changes (major).

Once a version is released, it will never be modified/changed.

⚡ Dedicated Servers Quickstart Plugin

Build and launch your dedicated game server into the cloud directly from your Unity Editor!

This plugin is provided 100% free of charge, under Terms and Conditions of Free Tier.

All Unity3D Long Term Support (LTS) versions after 2021.3+ are officially supported.

This plugin contains features intended to help you:

  • build and containerize your dedicated servers for linux,

  • test your server’s docker image locally,

  • upload and deploy your server on Edgegap.

This plugin does not modify any game behavior, it’s merely a convenient dev tool for Edgegap tasks. The plugin isn't included in your builds, as it’s only used during server build preparation.

Installation

Please refer to the official plugin repository for detailed instructions on installation.

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

Install Unity Linux Build Support Modules

  • Use Unity Hub to select tab Installs, access Settings and Add Modules for each Unity version you intend to use with Edgegap platform:

  • Scroll down to select and install the following Unity modules:

    • Linux Build Support (IL2CPP),

      • Linux Build Support (Mono),

      • Linux Dedicated Server Build Support

Install Docker Desktop (or Docker CLI)

See Unity to get started and for detailed instructions on plugin usage.

Troubleshooting and FAQ

Unity error: [Package Manager Window] Error adding package: https://github.com/edgegap/edgegap-unity-plugin.git

  • To add our plugin via git URL, you will need git client installed (Installation).

Unity Error: Missing Linux Build Support

  • See Developer Tools, you’re most likely missing Linux Build Support modules, which you can install through Unity hub. Make sure to choose the same Unity version as your project’s.

If you need help, please reach out to us over Discord. For live games support see our ticketing system.

For plugin developers - if you wish to detect presence of this plugin in the users Editor, you can do so using a compiler directive #if EDGEGAP_PLUGIN_SERVERS {your code} #endif .

⭐ Software Development Kit

Unity SDK contains optional integration utilities for Deployments, Matchmaking, and Server Browser. This plugin officially supports Unity versions 2021.3.0f1 and later.

The latest version of Unity SDK is 3.5.3. All examples in this documentation are up to date.

This plugin is provided 100% free of charge, under Terms and Conditions of Free Tier.

Requirements

Install a Git Client (for example git-scm)

A git client is needed for Unity to download and install our Unity package automatically. You will not need to use git directly once it's installed.

Installation

  1. Open your Unity Project,

  2. Select Window > Package Management > Package Manager ,

  3. Click the ➕ icon and select Add package from git URL... ,

  4. Input the URL of our SDK when prompted:

  1. Click Add and wait until installation is completed.

Import Samples

This package includes multiple samples, intended to be used individually (do not combine samples).

Verified Sources

This is the only official distribution channel for this SDK, do not trust unverified sources!

Update Package

Navigate to Edgegap SDK in Unity Package Manager and click Update .

Imported Samples are not updated automatically! Back up any custom property values, delete the sample scripts used in your scene currently and re-import samples.

Some releases may contain breaking changes. This will be indicated by a new MAJOR version.

Updating to v3

This update includes many new Server Browser utilities and examples, improves matchmaking error handling, and more. See Release Notes for a complete list.

Unity SDK update v3 includes a few breaking changes. Please re-test your integration carefully.

Troubleshooting and FAQ

Unity: [Package Manager Window] Error adding package: https://github.com/edgegap/edgegap-unity-sdk.git

  • To add our plugin via git URL, you will need git client installed.

Visual Studio: type or namespace name could not be found for Edgegap namespace.

  1. In Unity Editor, navigate to Edit / Preferences / External Tools / Generate .csproj files.

  2. Make sure you have enabled Git packages.

  3. Click Regenerate project files.

If you need help, please reach out to us over Discord. For live games support see our ticketing system.

📫 Distributed Relay Transports library

Find a custom Transport for your netcode library to utilize Distributed Relays in peer to peer games.

See documentation:

PreviousServer Browser
NextGodot

Last updated

Was this helpful?