{"id":13589362,"url":"https://github.com/FrozenStormInteractive/Unreal-SignalR","last_synced_at":"2025-04-08T09:32:36.981Z","repository":{"id":49330713,"uuid":"249545452","full_name":"FrozenStormInteractive/Unreal-SignalR","owner":"FrozenStormInteractive","description":"SignalR client for Unreal Engine","archived":false,"fork":false,"pushed_at":"2024-05-20T13:21:07.000Z","size":578,"stargazers_count":41,"open_issues_count":7,"forks_count":20,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-08-02T16:31:07.025Z","etag":null,"topics":["signalr","signalr-client","ue4","ue5","unreal","unreal-engine","unreal-engine-4","unreal-engine-5","unrealengine","websocket"],"latest_commit_sha":null,"homepage":"","language":"C++","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/FrozenStormInteractive.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"License.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-03-23T21:13:59.000Z","updated_at":"2024-06-13T22:01:09.000Z","dependencies_parsed_at":"2023-01-23T12:00:12.107Z","dependency_job_id":null,"html_url":"https://github.com/FrozenStormInteractive/Unreal-SignalR","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FrozenStormInteractive%2FUnreal-SignalR","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FrozenStormInteractive%2FUnreal-SignalR/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FrozenStormInteractive%2FUnreal-SignalR/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FrozenStormInteractive%2FUnreal-SignalR/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/FrozenStormInteractive","download_url":"https://codeload.github.com/FrozenStormInteractive/Unreal-SignalR/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223314095,"owners_count":17125001,"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":["signalr","signalr-client","ue4","ue5","unreal","unreal-engine","unreal-engine-4","unreal-engine-5","unrealengine","websocket"],"created_at":"2024-08-01T16:00:28.895Z","updated_at":"2024-11-06T09:30:51.283Z","avatar_url":"https://github.com/FrozenStormInteractive.png","language":"C++","funding_links":[],"categories":["Networking","Game Development"],"sub_categories":["Unreal Engine: Resources"],"readme":"\u003ch1 align=\"center\"\u003e\r\n  \u003cbr\u003e\r\n  \u003ca href=\"https://github.com/FrozenStormInteractive/Unreal-SignalR\"\u003e\r\n    \u003cimg src=\"Docs/static/img/logo.svg\" alt=\"Logo\" width=\"170\"\u003e\r\n   \u003c/a\u003e\r\n  \u003cbr\u003e\r\n  SignalR for Unreal\r\n  \u003cbr\u003e\r\n\u003c/h1\u003e\r\n\r\n## Dependencies\r\n\r\nThis plug-in requires Visual Studio and either a C++ code project or a full Unreal Engine source code from GitHub.\r\n\r\n**This plugin does not support the MessagePack protocol for the moment, only the JSON protocol.**\r\n\r\n## Usage\r\n\r\nYou can use this plug-in as a project plug-in, or an Engine plug-in:\r\n\r\n - If you use it as a project plug-in, clone this repository into your project's `Plugins` directory and compile your game in Visual Studio. A C++ code project is required for this to work.\r\n\r\n - If you use it as an Engine plug-in, clone this repository into the `Engine/Plugins` directory and compile your game. *Full Unreal Engine source code from GitHub is required for this*.\r\n\r\nThis plug-in is enabled by default, so no need to enable it in the plug-in browser.\r\n\r\nLink the `SignalR` module to to yours with `PublicDependencyModuleNames` or `PrivateDependencyModuleNames` in `\u003cYourModule\u003e.build.cs`:\r\n```cs\r\nPrivateDependencyModuleNames.AddRange(new string[]\r\n{\r\n    \"SignalR\",\r\n}\r\n);\r\n```\r\n\r\nCreate a hub connection with the SignalR engine subsystem:\r\n```cpp\r\n#include \"SignalRModule.h\"\r\n#include \"IHubConnection.h\"\r\n\r\nTSharedPtr\u003cIHubConnection\u003e Hub = GEngine-\u003eGetEngineSubsystem\u003cUSignalRSubsystem\u003e()-\u003eCreateHubConnection(\"https://example.com/chathub\");\r\n```\r\n\r\nBind an event which is fired when the server call it to the client.\r\n```cpp\r\nHub-\u003eOn(TEXT(\"EventName\")).BindLambda([](const TArray\u003cFSignalRValue\u003e\u0026 Arguments)\r\n{\r\n    ...\r\n});\r\n```\r\n\r\n`Invoke` fires an event when the server has finished invoking the method (or an error occurred). In addition, the event\r\ncan receive a result from the server method, if the server returns a result.\r\n```cpp\r\nHub-\u003eInvoke(TEXT(\"Add\"), 1, 1).BindLambda([](const FSignalRInvokeResult\u0026 Result)\r\n{\r\n    if (!Result.HasError())\r\n    {\r\n        UE_LOG(LogTemp, Warning, TEXT(\"The result value is: %d\"), Result.AsInt());\r\n    }\r\n});\r\n```\r\n\r\nUnlike the `Invoke` method, the `Send` method doesn't wait for a response from the server.\r\n```cpp\r\nHub-\u003eSend(TEXT(\"Add\"), 1, 1);\r\n```\r\n\r\n## Troubleshooting\r\n\r\n### Nothing happens when connecting to SignalR URL\r\n\r\nKeep a reference to your connection with a shared pointer. If you don't do this, the connection object will be destroyed and therefore won't work.\r\n\r\nRemember that the function `IHubConnection::Start` is asynchronous. When you send data after calling the function, the connection may not be complete (the data to be sent are kept on hold)\r\n\r\n### Negotiate failed with status code 307\r\n\r\n```\r\nLogSignalR: Error: Negotiate failed with status code 307\r\n```\r\n\r\nRedirections are not yet supported. Use IP address or a domain name without redirection.\r\n\r\nYou can also disable `UseHttpsRedirection()` in ASP.NET Core.\r\n\r\n### Peer certificate cannot be authenticated with given CA certificates\r\n\r\nThe HTTP module does not support self-signed certificates. The dotnet development certificate is not recognized by Unreal.\r\n\r\nYou can:\r\n- use the HTTP protocol (Disable `UseHttpsRedirection()` in ASP.NET Core)\r\n- or disable peer verification in **Project Settings** \u003e **Engine** \u003e **Network** \u003e **Verify Peer**\r\n\r\n![Disable peer verification in Unreal Project Settings](/Docs/static/img/Unreal-DisablePeerVerification.png)\r\n\r\n## Contributing\r\n\r\nPlease see [CONTRIBUTING.md](CONTRIBUTING.md) for instructions on how to contribute.\r\n\r\n## License\r\n\r\nThis project is licensed under the MIT License - see the [LICENSE.txt](LICENSE.txt) file for details.\r\n\r\n```\r\nCopyright (c) 2020-2022 Frozen Storm Interactive, Yoann Potinet\r\n```\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FFrozenStormInteractive%2FUnreal-SignalR","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FFrozenStormInteractive%2FUnreal-SignalR","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FFrozenStormInteractive%2FUnreal-SignalR/lists"}