Estuary-Unity-SDK

Description

The Estuary Unity SDK (dubbed Mangrove SDK) is a Unity plugin which allows for easy connection to a running instance of Mangrove, the backend server component of Estuary. This plugin includes a simple example scene and a boilerplate prefab to help speed up development with Estuary. Our SDK leverages the SocketIO Unity plugin, so connections can be made conveniently by specifying the local IP address and port number of your Mangrove instance.

Give us a Star! ⭐

If you find Estuary helpful, please give us a star! Your support means a lot! If you find any bugs or would like to request a new feature, feel free to open an issue!

Installation

1. Install SocketIO into your Unity project
   1. Copy the SocketIO plugin URL:

      https://github.com/itisnajim/SocketIOUnity.git

   2. In your Unity project, open Window -> Package Manager
   3. Click on the "+" button at the top left and select "Add package from git URL"
   4. Paste the link there and click "Add" or press enter
   5. [Optional] If the above step does not work, the SocketIO Unity plugin may have changed. In this case, consult the SocketIO plugin installation guide.
2. Install the Estuary Unity SDK by repeating the previous step but using this URL instead:

   https://github.com/Al-Estuary/Estuary-Unity-SDK.git