Skip to content

hathora/unity-plugin

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

63 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Hathora Cloud Unity Plugin

Download the plugin:

Use case Download link Description Setup docs
Existing game Hathora_Cloud_Unity_pluginonly_latest.unitypackage plugin-only package view docs
Sample demo project Hathora_Cloud_Unity_plugin_latest.unitypackage plugin + demo package view guide

Hathora Cloud Unity Plugin includes:

  • Editor plugin to configure, build, and deploy your server directly from your Unity editor
  • Hathora Cloud C# SDK for programmatic integration
  • Demos directory with sample integrations with FishNet and Mirror networking solutions

For in-depth tutorial on using our plugin, check out our Beginner's tutorial.

For a guide on using our plugin with your existing multiplayer game, check out our Integration guide.

Plugin version history

To view a log of release versions and change logs, check out VERSION_HISTORY.md.

Install instructions

Screenshot of plugin contents

Our plugin works best with Unity version 2021.3.28f1 and higher. It will still work with earlier version of 2021.3.x, see "Version Compatability" section below.

1. Download plugin

Plugin-only (best for integrating w/ existing game): Hathora_Cloud_Unity_pluginonly_latest.unitypackage

Plugin + demo (best for learning): Hathora_Cloud_Unity_plugin_latest.unitypackage

2. Open the Unity project you want to add the plugin to

3. Add Hathora_Cloud_Unity_plugin_latest.unitypackage as a "Custom Package" (Assets > Import Package > Custom Package..)

NOTE: If you're installing the plugin-only version, you may notice errors with The type of namespace name "Newtonsoft" cannot be found. These are expected, to fix you will need to install Newtonsoft via Unity's Package Manager. You can do so by adding the package by name: com.unity.nuget.newtonsoft-json.

4. Using the "Hathora" top menu item, create a new config file

5. Create or login to your Hathora Cloud account using the Editor inspector on your newly created config file from the previous step

6. Create an application in Hathora Cloud

7. Now you can use the plugin to build and deploy your game server.

8. To learn more about the demos included, check out this tutorial.

Demo scene

Questions?

Get help and ask questions in our active Discord community: https://discord.com/invite/hathora

Version compatibility

Our plugin works best with Unity version 2021.3.28f1 or higher.

It does still work for earlier versions of 2021.3.x, but you will need to fix the Universal Render Pipeline (URP) package version. Note that URP is only used for our included demos, so if you simply ignore/delete the Demo folder, you can ignore the URP dependency.

  1. Window > Package Manager > remove Universal RP
  2. Find package via Unity Registry > install Universal RP (should be version compatible with your Unity version)
  3. Edit > Project Settings > Graphics > set "Scriptable Render Pipeline Settings" to StarterAssetsURP