{"id":15043692,"url":"https://github.com/msabaeian/godot-socketio","last_synced_at":"2025-04-14T23:12:30.220Z","repository":{"id":256655366,"uuid":"853550094","full_name":"msabaeian/godot-socketio","owner":"msabaeian","description":"a Socket.IO client for Godot written in GDScript","archived":false,"fork":false,"pushed_at":"2024-10-14T12:48:35.000Z","size":35,"stargazers_count":16,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-14T23:12:15.187Z","etag":null,"topics":["engineio-client","gdscript","godot","socket-io","socket-io-client"],"latest_commit_sha":null,"homepage":"","language":"GDScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/msabaeian.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-09-06T22:17:30.000Z","updated_at":"2025-02-25T19:57:41.000Z","dependencies_parsed_at":"2024-09-12T08:36:56.852Z","dependency_job_id":"65062693-0e0b-43ae-a751-7519d909d0d5","html_url":"https://github.com/msabaeian/godot-socketio","commit_stats":null,"previous_names":["msabaeian/godot-socketio"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/msabaeian%2Fgodot-socketio","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/msabaeian%2Fgodot-socketio/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/msabaeian%2Fgodot-socketio/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/msabaeian%2Fgodot-socketio/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/msabaeian","download_url":"https://codeload.github.com/msabaeian/godot-socketio/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248975329,"owners_count":21192210,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["engineio-client","gdscript","godot","socket-io","socket-io-client"],"created_at":"2024-09-24T20:49:26.659Z","updated_at":"2025-04-14T23:12:30.188Z","avatar_url":"https://github.com/msabaeian.png","language":"GDScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Socket.IO Godot Client\n\nThis is a [Socket.IO](https://socket.io/) and [Engine.IO](https://socket.io/docs/v4/engine-io-protocol/) client addon for [Godot](https://godotengine.org/) written in [GDScript](https://gdscript.com/) that supports both HTTP long-polling and Websocket.\n\n\u003e This is still a work in progress and is not yet fully featured. Please make sure to check out the [#features](#features) section before using it. The current implementation is functional and works, but there are some known cases that have not been implemented or covered yet (like binary messages)\n\n## Compatibility\n\n| Godot | plugin version | Socket.IO server |\n| -------------- | ---------------- | ---------------- |\n| 4.3 | 0.1.x | 4.x |\n\n\u003e I haven’t checked the current implementation with older versions of the Godot and Socket.IO server. I hereby ask you to do this and inform me if it works or not.\n\n## Quickstart\n\nAdd the Socket.IO node to your tree and fill out the parameters in the Inspector, connect the signals via code or IDE, and use it.\n\n```gdscript\n@onready var client: SocketIO = $SocketIO\n\nfunc _ready() -\u003e void:\n    client.socket_connected.connect(_on_socket_connected)\n    client.event_received.connect(_on_event_received)\n\nfunc _on_connect_pressed() -\u003e void:\n    client.connect_socket()\n\nfunc _on_socket_connected() -\u003e void:\n    client.emit(\"hello\")\n    client.emit(\"some_event\", { \"value\": 10 })\n\nfunc _on_event_received(event: String, data: Variant, ns: String) -\u003e void:\n    print(\"event %s with %s as data received\" % [event, data])\n```\n\n## Features\n\n| Name | Status | Description\n| -------------- | ---------------- | ---------------- |\n| HTTP long-polling            | ✔️              | \n| Websocket            | ✔️              | \n| WebTransport            | ❌              | [requires: Add support for WebTransport in Godot](https://github.com/godotengine/godot-proposals/issues/3899)\n| auto upgrade            | ✔️              | \n| emit events            | ✔️              | \n| listen to events            | ✔️              | \n| namespaces            | ✔️              | Multiplexing\n| custom path            | ✔️              | \n| auth            | ✔️              | \n| automatic reconnection            | ❌              | reconnection attempts, delay, factor\n| connection timeout            | ❌              | if the client does not receive a ping packet within pingInterval + pingTimeout, then it SHOULD consider that the connection is closed ([link](https://github.com/socketio/socket.io/blob/main/docs/engine.io-protocol/v4-current.md#heartbeat))\n| query            | ❌              | additional query parameters that are sent when connecting a namespace `socket.handshake.query`\n| extra headers            | ❌              |\n| emit with acknowledgement            | ❌              | [acknowledgement](https://github.com/socketio/socket.io/blob/main/docs/socket.io-protocol/v5-current.md#acknowledgement-1)\n| Websocket only            | ❌              | connect to Websocket only (disable polling)\n| binary messages            | ❌              | \n| noop packet            | ❌              |\n| error handling for HTTP requests            | ❌              | inside `request.gd`\n| custom serializer            | ❌              | [Custom parser](https://socket.io/docs/v4/custom-parser/)\n| C# API            | ❌              | \n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmsabaeian%2Fgodot-socketio","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmsabaeian%2Fgodot-socketio","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmsabaeian%2Fgodot-socketio/lists"}