green-coder / unity3d-ddp-client Goto Github PK

Lightweight DDP client for Unity3D

License: MIT License

CSS 0.19% HTML 0.04% JavaScript 0.93% C# 98.78% Shell 0.07%

unity3d meteor ddp

unity3d-ddp-client's Introduction

Unity3D-DDP-Client

A lightweight DDP client for Unity3D. In other words, a library for Unity3D to communicate in realtime with Meteor servers.

I can be used for many things, like account registration, score board, match-making, chat, turn-based games, cooperative tools, etc ...

It may not be a fit for game interactions which require a lot of network data update per second (in which case you may want to use something like UNet instead).

If you are developing for the UWP platform (e.g. for Mixed Reality headsets or XBox) or if you like to use the new .Net 4.6 take a look at the dev branch

Feature list

DDP-client:
- Implementation of the DDP-client protocol version 1.
- data subscription / notification.
- method call / response.
- Uses websocket protocoles ws:// and wss:// to communicate with the server.
- Does not make assumptions about how to reconnect in case of disconnection. Let the user do it. Example provided.
Accounts:
- Login with username and password, logout.
- Resume previous session by login using a token.
- Does not make assumption about how the credentials and loaded and saved, let the user do it instead.
Local Database:
- Is optional.
- Listens to the DdpConnection and creates collections on demand.
- Let the user instantiate the database's collection via a callback.
- Database collections can keep the documents as JSON objects or as custom classes, in which case it let the user provide serialization / deserialization callbacks.
- Collections can be iterated over, and the user can register to their content's changes.

Getting started

Start the Meteor server

Install Meteor.

$  curl https://install.meteor.com/ | sh

Launch the server:

$ cd example-server
$ meteor

Start one of the Unity3D examples

Read the source code to see how it works and which keys to press.

The code is fairly simple and easy to read, both in the examples and in the library classes.

Stability

The source code is freshly typed and was not fully tested yet. If you find a bug, please file an issue on Github and I will be happy to fix it asap.

The source code is fairly simple, so may you find a bug, a fix should not take very long to implement.

Roadmap

Features to add later:

Additional ways to login, maybe using Facebook and Google+.
A bigger and complete example project.

Contribute

Contributions are welcome on this project.

Pull requests will be reviewed and may be modified to fit the coding style (i.e. to keep it easy to read).

License

This project is distributed under the MIT license.

unity3d-ddp-client's People

Contributors

Stargazers

Watchers

Forkers

joaokucera mohala562 derwaldgeist loganbates2002

unity3d-ddp-client's Issues

Is it necessary to unsubscribe before subscribing with new parameters?

For a location-based application, we have to update the subscriptions frequently, i.e. every time a user moves significantly. Is it necessary to unsubscribe in this case before subscribing to the same publication, but with other parameters? Or is it sufficient to just re-subscribe, as it is done in a regular Meteor client?

In the latter case: what happens to event handlers that have been registered on the previous subscription? Will they be automatically purged?

Rewrite the connection state

Review and add the CONNECTING state.

Still maintained?

Is this repo still being maintained? Since the last commit was one year ago, I am wondering if that's either because the code is stable or because it has been abandoned. :-)

Write better examples

It would be nice to write some more impressive examples and post some relevant screenshots on the README.md file.

Can't log in to a Meteor account

Hi,

Thank you very much for this promising project. I tested it with Meteor 1.4.1.1 + Unity 5.4.1f1 and could connect to local and remote Meteor servers, however each attempt to logging in to an account results in an "Incorrect password" error message.

This happens both from Unity with already existing accounts, and from the browser with accounts created within Unity.

Connection is not closed when exiting Unity play mode

The connection is kept open and it still sends and receives data from the server after you exit the play mode (at least on the dev-branch you can still see the ping-pong messages in the console log). This might be expected behaviour when you start the communication from the Inspector but might be inconvenient in most cases when you connect during program runtime.
Close should maybe be called when the object gets destroyed.

Use a namespace for the classes

Currently there is no namespace, that's a little annoying. I will change that once I have time.

Any suggestion for the namespace's name is welcome.

Merge with my code?

Hi @green-coder ,

based on your code I created a DDP-Client implementation that uses UWP for Hololens (see here ). Because this fork did not work with Unity I thought it was best to keep it as separated repo.

However, I just finished a more general version that does not use websocket-sharp but System.Net ClientWebSocket for Unity instead, if you use the experimental .Net 4.6 as well as UWP if it is build for it.
So instead of doing my own thing I could merge this with your code again and present a pull request, maybe as a special branch because it requires 4.6. For the older .Net that is used for most Unity Projects you still need a 3rd-party lib like websocket-sharp.

What do you think?

Send queued messages only after session is continued with token?

At the moment when I am disconnected from the server and I call a method I get an error but the method call is queued and executed as soon as a connection to the server is re-established.

But after reconnecting the user isn't logged in any more. Therefore all the method calls will return an error that the user needs to be logged in.

I tried to use the token to resume the session in ddpConnection.OnConnected but this is too late and the user will be logged in after all the queued messages have been executed.

Is there any way to solve this problem?