Websocket is supported by SmartFoxServer 2X via the Javascript API<\/a> for HTML5 clients or the Unity\/WebGL API<\/a>, for WebGL builds.<\/p>\n\n\n\n NOTE<\/strong>: In this article we will often refer to Unity WebGL as this is the build name used in Unity for browser-based exports. Unity WebGL uses Websocket as the network technology for multiplayer communication.<\/p>\n\n\n\n Activating Websocket in SmartFoxServer 2X is requires only a few steps:<\/p>\n\n\n\n Now that Websocket is active we can try to connect with a client to the local server and start experimenting. To get going quickly you can download some of our examples, for instance the HTML5 Example pack<\/a> contains a wide series of tutorials with different levels of complexity (with relative online tutorials<\/a>).<\/p>\n\n\n\n Every example is already configured to connect to the localhost<\/em> on TCP port 8080, so no set up is required. You can double-click or drag and drop the html file in your browser and you’re good to go.<\/p>\n\n\n\n However for Unity-based examples<\/a> you will need one extra step. After building for WebGL, if you drag and drop one of the examples in your favorite browser a warning like this will show up:<\/p>\n\n\n\n What this means is that Unity WebGL examples need to be served from a web-server (for security reasons), so in order to fulfill this requirement you will need to move the exported folder under SFS2X\/www\/ROOT\/ExampleName<\/em><\/p>\n\n\n\n Once this is done you can safely point the browser to http:\/\/localhost:8080\/ExampleName<\/em> where ExampleName<\/em> is replaced by the actual name of the exported WebGL example. <\/p>\n\n\n\n The Websocket protocol comes with a more secure, encrypted variant which is the equivalent of HTTPS, called in short WSS<\/strong>. This is activated by deploying a valid SSL certificate in SmartFoxServer 2X, which enables both HTTPS and WSS over the chosen TCP port (more on this in the next sections).<\/p>\n\n\n\n Local testing with WSS (and HTTPS) is very tricky and usually unrecommended , although there may be some workarounds<\/a>. The main reason for this is that SSL certificates can only be issued for internet domains, and “localhost” is not one of those. Our suggestion in this case is to test locally by setting the client to standard Websocket and switching it to WSS when in production.<\/p>\n\n\n\n This is an example of how to switch the client between the two modes (WS and WSS) in Javascript:<\/p>\n\n\n\n And this is the same example for Unity\/WebGL:<\/p>\n\n\n\n Before you can use WSS you will need to deploy a valid SSL certificate<\/strong> in SmartFoxServer 2X. This operations requires a number of steps:<\/p>\n\n\n\n We describe this process step by step in a detailed guide<\/a> in our documentation.<\/p>\n\n\n\n Once you have completed the setup you will be able to connect your client to the game server via a secure Websocket connection.<\/p>\n\n\n\n Finally a couple of notes for Unity developers getting started with WebGL and SFS2X. When starting a new Unity project for the browser you will need to add multiple DLLs<\/strong> from our Unity API distribution to support running the code in the Unity Editor and building for WebGL.<\/p>\n\n\n\n Before getting started make sure to follow our documentation<\/a> to set up your environment correctly.<\/p>\n\n\n\n![\"\"](\"https:\/\/smartfoxserver.com\/blog\/wp-content\/uploads\/2020\/04\/Schermata-2020-04-27-alle-16.55.02-1024x625.png\")
<\/figure>\n\n\n\n\u00bb Testing locally<\/h3>\n\n\n\n
![\"\"](\"https:\/\/smartfoxserver.com\/blog\/wp-content\/uploads\/2020\/04\/Schermata-2020-04-28-alle-13.09.18-1024x191.png\")
<\/figure>\n\n\n\n\u00bb Secure Websocket (WSS)<\/h3>\n\n\n\n
Testing WSS locally<\/h4>\n\n\n\n
(function () {\n \/\/ Use a flag to easily switch cryptography on and off\n var useEncryption = true;\n \n \/\/ Create configuration object\n var config = {};\n config.host = \"mydomain.com\";\n config.port = useEncryption ? 8443 : 8080;\n config.useSSL = useEncryption;\n config.zone = \"BasicExamples\";\n \n \/\/ Create the SmartFox client instance\n var sfs = new SFS2X.SmartFox(config);\n \n \/\/ Add connection event listener\n sfs.addEventListener(SFS2X.SFSEvent.CONNECTION, onConnection, this);\n \n \/\/ Connect to SmartFoxServer 2X\n sfs.connect();\n \n \/\/ Handle connection event\n function onConnection(evtParams)\n {\n console.log(evtParams.success);\n }\n})();<\/code><\/pre>\n\n\n\npublic class ConnectionExample : MonoBehaviour\n{\n private SmartFox sfs;\n \n \/\/ Use a flag to easily switch cryptography on and off\n private bool useEncryption = true;\n \n void Start()\n {\n \/\/ Create the SmartFox client instance\n sfs = new SmartFox(useEncryption ? UseWebSocket.WSS : UseWebSocket.WS);\n \n \/\/ Add connection event listener\n sfs.AddEventListener(SFSEvent.CONNECTION, OnConnection);\n \n \/\/ Create configuration object\n ConfigData config = new ConfigData();\n config.host = \"mydomain.com\";\n config.port = useEncryption ? 8443 : 8080;\n config.zone = \"BasicExamples\";\n \n \/\/ Connect\n sfs.Connect(config);\n }\n \n \/\/ Handle connection event\n private void OnConnection(BaseEvent evt)\n {\n Debug.Log(evt.Params[\"success\"]);\n }\n}<\/code><\/pre>\n\n\n\nTesting remotely<\/h4>\n\n\n\n
\u00bb Unity WebGL notes<\/h3>\n\n\n\n
\u00bb Further discussions<\/h3>\n\n\n\n