hiddenswitch / Meteor-Unity

A Unity SDK for Meteor.

Meteor-Unity

Download Version 3.2: http://hiddenswitch.github.io/Meteor-Unity/Meteor-Unity_v3.2.unitypackage.

A Unity SDK for Meteor. Tested with Unity3D 2018.3.2f1 on il2cpp platforms. See the Documentation.

This release supports il2cpp backends, allowing it to be used in production for iOS builds. iOS, Android and desktop platforms are supported. WebGL is not supported.

See the example code at the bottom of the Readme for an overview of all the supported features. Wherever possible, the API matches the Meteor API, and the details match Meteor details. There is an exception to how things usually work in Meteor:

Compared to Meteor, Meteor-Unity has some limitations. It cannot simulate code yet, so database side effects must come from the server. It also cannot handle documents that are not explicitly typed.

Tips

• Your websocket URL will be in the form of ws://domain.com/websocket without SSL, wss://domain.com/websocket with SSL, and ws://localhost:3000/websocket locally.
• If you're hosting on Galaxy, make sure to enable an SSL certificate when you add the domain to your Galaxy application. Otherwise, you will not be able to connect to your websocket server at all, regardless of the URL you use.
• Over cellular Internet, many providers degrade non-SSL traffic. Use an SSL certificate to improve your Websocket connectivity over 3G and LTE.
• Deserializing large amounts of JSON takes time. This occurs whenever you receive data from Meteor. If you need to transfer large amounts of data frequently to a Unity client, use a sealed classand use 1-letter field names for your documents. In the future, struct and Unity's built-in JSON will be supported to greatly improve performance.
• Keep your data structures simple: use arrays instead of generic lists and value types like Vector3 instead of classes. This will help you get performance improvements in future releases, since most optimizations will only support simpler structures.
• Meteor cannot outperform UNET in latency, especially when responding to method calls from client to server. However, Meteor publishes are nearly as efficient as they can be. Consider whether for your purposes you need to write to databases, or whether or not you can use the (publish handle).added, removed and changed calls in your Meteor.publish function directly.

Getting Started

0. Check out the documentation at http://hiddenswitch.github.io/Meteor-Unity/annotated.html.

1. Install meteor.

   # Install meteor
   curl https://install.meteor.com/ | sh

2. Create a new Unity project.

   # For Mac
   /Applications/Unity/Unity.app/Contents/MacOS/Unity -createProject ~/Documents/Example
   cd ~/Documents/Example

3. Download and install the Meteor-Unity package.

4. Create a meteor project, add the accounts-password package, and run the project.

   meteor create Web
   cd Web
   meteor add accounts-password
   meteor

5. Connect to your server from Unity. All meteor work should live in coroutines. Here is an example which uses a coroutine (IEnumerator) to sequence a bunch of actions one after another. In this example, we assume we've defined a collection called collectionName on the server and created a few methods and subscriptions. You can't copy and paste the code below and expect it to work with an empty meteor project, but it will compile.

   IEnumerator MeteorExample() {
     var production = false;
   
   	// Connect to the meteor server. Yields when you're connected
   	if (production) {
   	  yield return Meteor.Connection.Connect ("wss://productionserver.com/websocket");
   	} else {
   	  yield return Meteor.Connection.Connect ("ws://localhost:3000/websocket");
   	}
   
   	// Login
   	yield return (Coroutine)Meteor.Accounts.LoginAsGuest ();
   
   	// Create a collection
   	var collection = new Meteor.Collection<DocumentType> ("collectionName");
   
   	// Add some handlers with the new observer syntax
   	var observer = collection.Find ().Observe (added: (string id, DocumentType document) => {
   		Debug.Log(string.Format("Document added: [_id={0}]", document._id));
   	});
   
   	// Subscribe
   	var subscription = Meteor.Subscription.Subscribe ("subscriptionEndpointName", /*arguments*/ 1, 3, 4);
   	// The convention to turn something into a connection is to cast it to a Coroutine
   	yield return (Coroutine)subscription;
   
   	// Create a method call that returns a string
   	var methodCall = Meteor.Method<string>.Call ("getStringMethod", /*arguments*/1, 3, 4);
   
   	// Execute the method. This will yield until all the database side effects have synced.
   	yield return (Coroutine)methodCall;
   
   	// Get the value returned by the method.
   	Debug.Log (string.Format ("Method response:\n{0}", methodCall.Response));
   }
   
   public class DocumentType : Meteor.MongoDocument {
   	public string stringField;
   	public int intField;
   }

To use the above example, include the following file in the server/ directory in your Meteor project:

let collection = new Mongo.Collection('collectionName', {connection: null});
   Meteor.publish('subscriptionEndpointName', function (number1, number2, number3) {
   console.log(`Subscribed: ${number1}, ${number2}, ${number3}`);
   return collection.find({});
});
   
Meteor.methods({
   'getStringMethod': function (number1, number2, number3) {
   console.log(`Called method: ${number1}, ${number2}, ${number3}`);
   return "test";
   }
});
   
Meteor.setInterval(function () {
   collection.insert({
   stringField: 'test',
   intField: 1
   })
}, 1000);
   
Accounts.onCreateUser(function (user) {
   console.log(`User created: ${user._id}`);
   return user;
});