View source for Troubleshooting:Websockets

<!--T:1-->
Resonite is capable as running as a [https://en.wikipedia.org/wiki/WebSocket websocket] client in game by utilizing the [[Special:MyLanguage/WebsocketClient (Component)|WebsocketClient]] component and the [[:Category:ProtoFlux:Websocket|Websocket]] ProtoFlux nodes. This can lead to a powerful opportunity to [[Connecting Resonite to Other Applications|connect Resonite to other applications]].

== Basic Information == <!--T:2-->

<!--T:3-->
Check the information on these nodes and components for basic information about how to use them:
* [[:Category:ProtoFlux:Websocket|Nodes]]
* [[Special:MyLanguage/WebsocketClient (Component)|The Component]]

== Requirements == <!--T:4-->

<!--T:5-->
For websockets to work you'll need to ensure:
* A websocket compatible server
** Not a regular Socket Server
** Not a Socket.Io Server
** Not any other kind of server. Specifically Websockets
* A computer to run your Websocket Server.
** This '''can''' be the same computer as the one that runs Resonite.
* Some knowledge of how to program a websocket server.
** Most websocket servers are basic and do not include your application logic.

== Resonite Limitations == <!--T:6-->

<!--T:7-->
* Resonite can only send and receive text based messages.
** Do not send Binary data!

== Checklist == <!--T:8-->

<!--T:9-->
If websockets are not working in your world please check the following:
* Is your address correct?
** It must be an address that Resonite and your computer can reach.
** Localhost or 127.0.0.1 are ok if you're referring to your local computer.
* Is the port correct?
** You can run a Websocket server on any port.
* Does your address start with <code>ws://</code> or <code>wss://</code>?
** It must '''NOT''' start with <code>http://</code> or <code>https://</code>
* Is your websocket server running?
** It must be running to connect successfully.
* Is the "User" property set to the person running the websocket server?
** Websocket connections run as a specified user. If this is incorrect they might not connect correctly.
* Have you denied the webhost in Resonite?
** Navigate to the home screen of your dash. 
** In the bottom right corner click on Debug. 
** Then in the window that appears click the "Web Hosts" tab.
** Check for any line in the window that shows the address that you're trying to use. 
** If it says "Denied" click "Remove Setting" next to it and make sure to "Allow" it when the request access dialog appears.

== Suitable Servers == <!--T:10-->

<!--T:11-->
Here are some suitable servers to get you started:
* Node.js
** Regular Node.js's Http Module can do this.
** [https://www.npmjs.com/package/ws ws] on NPM
* Python
** [https://pypi.org/project/websockets/ Websockets] on PyPi
* C#
** C# has [https://docs.microsoft.com/en-us/dotnet/api/system.net.websockets.websocket?view=net-5.0 native websocket support in .Net]
** There's also [https://github.com/sta/websocket-sharp websocket-sharp]
[[Category:Troubleshooting]]<!--T:12-->