{"id":20268618,"url":"https://github.com/agoraio/signaling-sdk-samples-unity","last_synced_at":"2026-06-11T07:31:15.098Z","repository":{"id":221465291,"uuid":"694094034","full_name":"AgoraIO/signaling-sdk-samples-unity","owner":"AgoraIO","description":null,"archived":false,"fork":false,"pushed_at":"2024-02-17T19:01:48.000Z","size":1417,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-03-03T23:03:20.860Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AgoraIO.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-09-20T10:14:50.000Z","updated_at":"2024-02-11T12:59:32.000Z","dependencies_parsed_at":"2024-11-14T12:29:47.462Z","dependency_job_id":null,"html_url":"https://github.com/AgoraIO/signaling-sdk-samples-unity","commit_stats":null,"previous_names":["agoraio/signaling-sdk-samples-unity"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/AgoraIO/signaling-sdk-samples-unity","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgoraIO%2Fsignaling-sdk-samples-unity","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgoraIO%2Fsignaling-sdk-samples-unity/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgoraIO%2Fsignaling-sdk-samples-unity/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgoraIO%2Fsignaling-sdk-samples-unity/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AgoraIO","download_url":"https://codeload.github.com/AgoraIO/signaling-sdk-samples-unity/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgoraIO%2Fsignaling-sdk-samples-unity/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34188272,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-11T02:00:06.485Z","response_time":57,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2024-11-14T12:19:05.496Z","updated_at":"2026-06-11T07:31:15.082Z","avatar_url":"https://github.com/AgoraIO.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Unity reference app for Agora Signaling SDK\n\nThis repository holds the code examples used for the [Agora Signaling SDK for Unity](https://docs-beta.agora.io/en/signaling/overview/product-overview?platform=android) documentation. It is a robust and comprehensive documentation reference app for Unity, designed to enhance your productivity and understanding. It's built to be flexible, easily extensible, and beginner-friendly.\n\nClone the repo, run, and test the samples, and use the code in your own project. Enjoy.\n\n- [Samples](#samples)\n- [Prerequisites](#prerequisites)\n- [Run the app](#run-the-app)\n- [Contact](#contact)\n\n## Samples\n\nThis reference app includes several samples that illustrate the functionality and features of Agora Signaling SDK. Each sample is self-contained and the relevant code can be found in its own folder in the root directory. For more information about each sample, see:\n\n- [SDK quickstart](/Assets/signaling-manager/) - the minimum code you need to integrate low-latency, high-concurrency\n  signaling features into your app using Signaling SDK.\n- [Secure authentication with tokens](/Assets/authentication-workflow) - quickly set up an authentication token server, retrieve a token from the server, and use it to connect securely to Signaling as a specific user.\n- [Stream channels](/Assets/stream-channel/) - communicate to other users in topics.\n- [Store channel and user data](/Assets/storage) - easily store data for users and channels without the need to\n  set up your own databases. \n- [Connect through restricted networks with Cloud Proxy](/Assets/cloud-proxy/) - ensure reliable connectivity for your users when they connect from an\n  environment with a restricted network.\n- [Data encryption](/Assets/data-encryption/) - integrate built-in data encryption into your app using Signaling.\n- [Geofencing](geofencing) - only connect to Signaling within the specified region.\n\nTo view the UI implementation, see [SignalingUI](/Assets/signaling-manager/SignalingUI.cs).\n\n## Prerequisites\n\nBefore getting started with this reference app, ensure you have the following set up:\n\n- [Unity Hub](https://unity.com/download)\n- [Unity Editor 2017.X LTS or higher](https://unity.com/releases/editor/archive)\n- Microsoft Visual Studio 2017 or higher\n\n## Run the app\n\n1. **Clone the repository**\n\n    To clone the repository to your local machine, open Terminal and navigate to the directory where you want to clone the repository. Then, use the following command:\n\n    ```sh\n    git clone https://github.com/AgoraIO/signaling-sdk-samples-unity.git\n    ```\n\n1. **Open the project**\n\n    1. In Unity Hub, Open `signaling-sdk-samples-unity`, Unity Editor opens the project.\n       \n       Unity Editor warns of compile errors. Don't worry, you fix them when you import Signaling SDK for Unity. \n\n    1. Go `Assets\\Scenes`, and open `SampleScene.unity`. The sample scene opens.\n         \n    1. Unzip [the latest version of the Agora Signaling SDK](https://download.agora.io/sdk/release/Agora_Unity_RTM_SDK_v2.1.9.zip?_gl=1*y2lyxl*_ga*MjA2MzYxMjY4Mi4xNzAzMDczMjA1*_ga_BFVGG7E02W*MTcwNzEyMDUzMC4xMi4xLjE3MDcxMjEwODAuMC4wLjA.) to a local folder.\n\n   1. In **Unity**, click **Assets** \u003e **Import Package** \u003e **Custom Package**.\n\n   1. Navigate to the Signaling SDK package and click **Open**.\n\n   1. In **Import Unity Package**, click **Import**.\n   \n      Unity recompiles the Signaling SDK samples for Unity and the warnings disappear. \n\n1. **Modify the project configuration**\n\n   The app loads connection parameters from the [`config.json`](/Assets/utils/Config.json) file. Ensure that the file is populated with the required parameter values before running the application.\n\n    - `uid`: The user ID associated with the application.\n    - `appId`: (Required) The unique ID for the application obtained from [Agora Console](https://console.agora.io). \n    - `channelName`: The default name of the channel to join.\n    - `token`: A token generated for `uid`. You generate a temporary token using the [Agora token builder](https://agora-token-generator-demo.vercel.app/).\n    - `serverUrl`: The URL for the token generator. See [Secure authentication with tokens](https://docs-beta.agora.io/en/signaling/get-started/authentication-workflow) for information on how to set up a token server.\n    - `tokenExpiryTime`: The time in seconds after which a token expires.\n\n    If a valid `serverUrl` is provided, all samples use the token server to obtain a token except the **SDK quickstart** project that uses the `token`. If a `serverUrl` is not specified, all samples except **Secure authentication with tokens** use the `token` from `config.json`.\n\n1. **Build and run the project**\n\n    In **Unity Editor**, click **Play**. A moment later you see the game running on your development device.\n\n1. **Run the samples in the reference app**\n\n    From the main app screen, choose and launch a sample.\n\n## Contact\n\nIf you have any questions, issues, or suggestions, please file an issue in our [GitHub Issue Tracker](https://github.com/AgoraIO/signaling-sdk-samples-android/issues).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fagoraio%2Fsignaling-sdk-samples-unity","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fagoraio%2Fsignaling-sdk-samples-unity","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fagoraio%2Fsignaling-sdk-samples-unity/lists"}