colyseus/colyseus-websocket-hx

(Haxe) WebSocket client aimed for all platforms

Multiplayer Framework for Node.js.
View documentation

Colyseus is an Authoritative Multiplayer Framework for Node.js, with SDKs available for the Web, Unity, Defold, Haxe, Cocos and Construct3. (See official SDKs)

The project focuses on providing synchronizable data structures for realtime and turn-based games, matchmaking, and ease of usage both on the server-side and client-side.

The mission of the framework is to be a standard netcode & matchmaking solution for any kind of project you can think of!

Key features:

• WebSocket-based communication
• Simple API in the server-side and client-side.
• Automatic state synchronization from server-to-client (delta compressed)
• Matchmaking clients into game rooms/sessions
• Scale vertically or horizontally

See public roadmap for future plans.

🚀 Quickstart

Create a bare-bones Colyseus server by using npm create colyseus-app@latest:

npm create colyseus-app@latest my-colyseus-server
cd my-colyseus-server
npm start

Sponsors

The sustainability of the project relies on Colyseus Cloud subscriptions and sponsorships. If you are not using Colyseus Cloud, please consider sponsoring the project 💖

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Aymeric Chauvin 💬 💡	Brian Hay 🖋	Damian A. Pastorini 💬 📖 🐛	Darek Greenly 💬 🐛 💻	David Rydwanski 💬 💻	Dr. Burton 🧑‍🏫	Endel Dreyer 💻 📖 💡
Enriqueto 💼	Fazri Zubair 💼	Federico 🐛 💻	James Jacoby 💬 💡 🖋	Jonas Voland 💬 🐛 💻 🤔 💡	Kyle J. Kemp 💬 🐛 💻 🤔	Luke Wood 💬 🐛 💻
Milad Doorbash 🐛 💻	Nikita Borisov 🐛 💻 💼 🤔	Phil Harvey 📖	Sergey 🐛 💻	Tom 💬 🐛 🤔	Tommy Leung 🧑‍🏫	digimbyte 📖

This project follows the all-contributors specification. Contributions of any kind are welcome!

Contributing

We encourage you to contribute to Colyseus! Please check out the Contributing guide for guidelines about how to proceed. Join us!

Everyone interacting in Colyseus and its sub-projects' codebases, issue trackers and chat rooms is expected to follow the code of conduct.

License

MIT

colyseus-websocket-hx's Issues

nodejs target is not supported

Because #if js falls into WebSocketJs which relies on js.html.WebSocket that does not exist in nodejs environment.

Getting a compilation failure for python target

Thank you for this project. I've gotten a lot of good usage out of it. I ran into this error when targeting the python target:

src/haxe/net/Crypto.hx:19: characters 29-37 : Type not found : RandomOs

I'm running ubuntu with both python2 and python3 installed on my machine, and using master of this git repo. Do I need to specify which python version to use during compilation? Are there other libraries that I need to install? Any help is greatly appreciated.

Sending a message to the server throws "Custom(ssl_send)"

For some odd reason this error is thrown when the client sends a message to the server, this happens randomly

Logs:

haxe/net/impl/WebSocketGeneric.hx:104: Custom(ssl_send)
io/colyseus/Connection.hx:58: WebSocket connection has been closed, stopping the thread!

Server example Python target - NameError: name 'sys_ssl_Socket' is not defined

I'm getting a NameError: name 'sys_ssl_Socket' is not defined when adding a python target for the server example.

To reproduce:

1. Add

--next

-python output/serverExamplePy.py
-cp src
-main haxe.net.example.WebSocketServerExample

to serverExample.hxml

2. haxe serverExample.hxml
3. python output/serverExamplePy.py

This results in the following traceback:

Traceback (most recent call last):
  File "output/serverExamplePy.py", line 3086, in <module>
    haxe_net_example_WebSocketServerExample.main()
  File "output/serverExamplePy.py", line 1375, in main
    server = haxe_net_WebSocketServer.create("0.0.0.0",port,1,True,False)
  File "output/serverExamplePy.py", line 1318, in create
    return haxe_net_WebSocketServer(host,port,maxConnections,isSecure,isDebug)
  File "output/serverExamplePy.py", line 1267, in __init__
    self._listenSocket = (sys_ssl_Socket() if (self._isSecure) else sys_net_Socket())
NameError: name 'sys_ssl_Socket' is not defined

Is this an issue with Haxe's python socket implementation? I'm new to haxe, so I'm not sure how to inspect this myself.

Thanks!

SocketSys Host resolve can take too much time.

In the hxcpp target, creating a new host instance runs the "_hx_std_host_resolve" function and it sometimes takes seconds to resolve the host, so creating the websocket can cause the application to freeze for seconds on the sys target.

Stack Trace:

colyseus-websocket-hx/src/haxe/net/impl/SocketSys.hx

Line 36 in d09ec0d

this.impl.connect(new Host(host), port);

https://github.com/HaxeFoundation/haxe/blob/3c97999667770f3a5418817d99a98bc47ef930b0/std/cpp/_std/sys/net/Host.hx#L38
https://github.com/HaxeFoundation/haxe/blob/3c97999667770f3a5418817d99a98bc47ef930b0/std/cpp/NativeSocket.hx#L69
https://github.com/HaxeFoundation/hxcpp/blob/0f2e870f066ae456ac65d65c6fb1fbdd3b22f251/src/hx/libs/std/Socket.cpp#L354

Solution Suggestion: The host instance can be created in a different thread, and once created, they can be moved to the main thread, creating a thread-safe solution.

Unknown error code

I get this output when trying to compile the example server code(examples are outdated fyi), I am creating a websocket server with isSecure false and isDebug true.

RandomOs for python target

Hi,

The following is missing from the bottom of Crypto.hx

#if python
@:pythonImport("os")
extern class RandomOs
{
	static public function urandom(count:Int):Array<Int>;
}
#end

Otherwise, you get an error that RandomOs is not found.