Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/defold/extension-websocket
A native websocket implementation for Defold
https://github.com/defold/extension-websocket
hacktoberfest
Last synced: 4 months ago
JSON representation
A native websocket implementation for Defold
- Host: GitHub
- URL: https://github.com/defold/extension-websocket
- Owner: defold
- License: mit
- Created: 2020-08-19T09:04:33.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-09-09T15:11:52.000Z (5 months ago)
- Last Synced: 2024-10-04T22:07:09.799Z (4 months ago)
- Topics: hacktoberfest
- Language: C
- Homepage:
- Size: 16.3 MB
- Stars: 31
- Watchers: 5
- Forks: 11
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
- awesome-defold - WebSocket
README
# Defold websocket extension
[](https://github.com/defold/extension-websocket/actions)
## Installation
To use this library in your Defold project, add the following URL to your `game.project` dependencies:
https://github.com/defold/extension-websocket/archive/master.zip
We recommend using a link to a zip file of a [specific release](https://github.com/defold/extension-websocket/releases).
## API reference
https://defold.com/extension-websocket/
https://defold.com/extension-websocket/websocket_api/
## Debugging
In order to make it easier to debug this extension, we provide a `game.project` setting `websocket.debug` (edit `game.project` as text and add):
```
[websocket]
debug = level
```
Set it to:
* `0` to disable debugging (i.e. no debug output).
* `1` to display state changes.
* `2` to display the messages sent and received.
## External resources
To verify that your websocket server works, you can test it with some tools.
* [websocat](https://github.com/vi/websocat)
Or, you can test your server on this web page:
* https://www.websocket.org/echo.html
To monitor all the packets sent to/from the client/server, you can use e.g.
* [Wireshark](https://www.wireshark.org)
For command line debugging, there's
* tcpdump: `sudo tcpdump -X -s0 -ilo0 port 8080 ` (example for local ws:// connection)
* tcpdump: `sudo tcpdump -X -s0 host echo.websocket.org` (Monitors packets to/from echo.websocket.org)
## Credits
This extension makes use of the C library WSlay by @tatsuhiro-t:
* https://github.com/tatsuhiro-t/wslay
The test server used by the example:
* https://www.lob.com/blog/websocket-org-is-down-here-is-an-alternative