/WebGlGameWithSignalRClient

unity Webgl game for communicating with asp.net core signalr server.

Primary LanguageJavaScript

Online web game (webgl) with unity and SignalR server

If you going to make an online web game (webgl) with unity and signalR server, you can start from this sample and tutorial.

Prerequisites :

  • Unity editor 2021.3
  • Standard Pipline (Core)

to run this example :

  1. download this repository. (see Prerequisites)
  2. downlaod SignalR Server from https://github.com/Mo-Rahemi/SignalRGameServerSample . (see Prerequisites)
  3. start the server. (check listening url (address and port) like http://localhost:5004/GameHub)
  4. set target to webgl.
  5. set server url in SignalRConnection Class.
  6. build and run game in broweser. (you cannot test game in editor because we use javascript client so we have to run in browser)

Step by step tutorial :

  1. Create a simple SignalR server (you can find mine here https://github.com/Mo-Rahemi/SignalRGameServerSample)
  2. Create a webgl template file then import SingalR javascript client files to your game.

Note: SingalR javascript client files can be found here : https://docs.microsoft.com/en-us/aspnet/core/signalr/javascript-client?view=aspnetcore-6.0&tabs=visual-studio

Note: How to create a webgl template? check here : https://docs.unity3d.com/Manual/webgl-templates.html (or simply copy mine into asset folder of your project)

  1. When you create a webgl template simply name it with changing folder name (my template name is signalr), copy javascript files into "TemplateData" folder, then add following lines to "index.html" (if you use my template skip this step) :
  • Copy SignalR javascript files to "TemplateData" folder. (must be in game export for connecting to SignalR server)

  • Add this line in head of "index.html" : <script src="TemplateData/signalr.js"></script> (needed for connecting to SignalR server)

  • Add this line "window.Game=unityInstance;" in "script.onload" in "index.html". so must be like below : (needed for Accessing our object in game)

    script.onload = () => {
      createUnityInstance(canvas, config, (progress) => {
        progressBarFull.style.width = 100 * progress + "%";
      }).then((unityInstance) => {
        loadingBar.style.display = "none";
        fullscreenButton.onclick = () => {
          unityInstance.SetFullscreen(1);
        };
    window.Game=unityInstance; //<-------------------------------- this line
      }).catch((message) => {
        alert(message);
      });
    };
    
  1. Change webgl template setting of your project (project setting -> player -> webgl -> Resolution and Presentation (section) -> webgl template) select your template by it's name. my template name is signalr.
  2. Create a jslib file whitch is a javascript file (under assets/plugins folder), and add your code for connecting and interacting with SignalR server and unity game both.

Note: You can see my jslib here : https://github.com/Mo-Rahemi/WebGlGameWithSignalRClient/blob/main/Assets/Plugins/SignalrConnection.jslib

Note: What is a jslib file ? check here : https://docs.unity3d.com/Manual/webgl-interactingwithbrowserscripting.html

  1. Run the game and enjoy.

export :

1

2

i found this awesome library so going to share with you :

https://github.com/evanlindsey/Unity-WebGL-SignalR

https://github.com/sta/websocket-sharp

https://github.com/endel/NativeWebSocket