moqi / unity-socket.io Goto Github PK
View Code? Open in Web Editor NEWThis project forked from fpanettieri/unity-socket.io-deprecated
Socket.IO client for Unity3d
License: MIT License
This project forked from fpanettieri/unity-socket.io-deprecated
Socket.IO client for Unity3d
License: MIT License
-------------------------------------------------------------------------------- SocketIO for Unity - v1.0.0 -------------------------------------------------------------------------------- # Overview # This plugin allows you to integrate your Unity game with Socket.IO back-end It implements the protocol described at socket.io-protocol github repo. ( https://github.com/automattic/socket.io-protocol ) While connected, Socket.IO run on it's own thread to avoid blocking the main thread. Events are queued and dispatched on the next frame they are received. # Support # [email protected] skype: fabio.panettieri # Quick Start # In order to start using Socket.IO in your project you need to: 1. Drag the SocketIO prefab from SocketIO/Prefab/ to your scene. 2. Configure the url where your Socket.IO server is listening. 3. Toggle the autoconnect flag if you want it to be always running. 4. That's it! You can now start using Socket.IO in your game. # How to use # 1. Obtaining the Socket.IO component reference GameObject go = GameObject.Find("SocketIO"); socket = go.GetComponent<SocketIOComponent>(); Bear in mind that using GameObject.Find might be pretty expensive, you might want to store that reference in a variable for later use. 2. Receiving events Using the socket reference you can receive custom events public void Start(){ socket.On("boop", TestBoop); } public void TestBoop(SocketIOEvent e){ Debug.Log(string.Format("[name: {0}, data: {1}]", e.name, e.data)); } Also, you can also use lambda expresions as callbacks socket.On("boop", (SocketIOEvent e) => { Debug.Log(string.Format("[name: {0}, data: {1}]", e.name, e.data)); }); 3. Sending events Besides listening to Socket.IO events or your custom events, you can use send information to Socket.IO server using the Emit method. a) Sending plain messages socket.Emit("user:login"); b) Sending additional data Dictionary<string, string> data = new Dictionary<string, string>(); data["email"] = "[email protected]"; data["pass"] = Encrypt("1234"); socket.Emit("user:login", new JSONObject(data)); c) Sometimes, you might want to get a callback when the client confirmed the message reception. To do this, simply pass a function as the last parameter of .Emit() socket.Emit("user:login", OnLogin); socket.Emit("user:login", new JSONObject(data), OnLogin); 4. Obtaining current socket id (socket.sid) public void Start(){ socket.On("open", OnSocketOpen); } public void OnSocketOpen(SocketIOEvent ev){ Debug.Log("updated socket id " + socket.sid); } 5. Namespace Support Not implemented yet! 6. Binary Events Not implemented yet! # Examples # This package also includes a minimalist test that you might want to use to verify that you have setup your environment properly. 1. Navigate to the server directory cd PATH/TO/PROJECT/Assets/SocketIO/Server 2. Unzip the server code outside Unity folder unzip beep.js.zip -d /tmp/socketio 3. Go to the destination folder where the server code was extracted cd /tmp/socketio 4. Install Socket.IO server package npm install socket.io 5. (Optional) Enable debug mode Windows: set DEBUG=* Mac: export DEBUG=* 6. Run test server node ./beep.js 7. Open the test scene SocketIO/Scenes/SocketIOTest 8. Run the scene. Some debug message will be printed to Unity console. 9. Open SocketIO/Scripts/Test/TestSocketIO.cs to check what's going on. # Troubleshooting # This is the first release of the plugin, so error may appear. In order to track them, I've included some debug code that it's only compiled when you uncomment some flags. In order to enable debug messages you might: 1. Navigate to SocketIO/Scripts/SocketIO 2. Open files Decoder.cs, Encoder.cs and SocketIOComponent.cs 3. Uncomment the following line #define SOCKET_IO_DEBUG 4. Run your game again. This time messages sent and received will be logged to Unity console. Hopefully you might find some lead to the source of your problems / bugs. 5. Remember to comment it again after you used it. # License # SocketIO for Unity is provided under The MIT License
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.