Run the sample project

This page shows you how to install and run the Signaling example project.

In order to follow this procedure you must have:

• Unity Hub
• Unity Editor 2022.2.0b7 or higher
• Microsoft Visual Studio 2017 or higher

• An Agora account and project.

• A computer with Internet access.

  Ensure that no firewall is blocking your network communication.

Create a project in Agora Console, as follows:

1. Log in to Console, and click Project Management in the left navigation menu to enter the Project Management page.

2. Click Create.

   

3. Enter your project name, and select APP ID for the authentication mechanism in the pop-up window. Agora recommends using an App ID for authentication only in a test environment, or if your project has low security requirements.

4. Click Submit. You can see the created project on the Project Management page.

Agora automatically assigns each project an App ID as a unique identifier.

To copy this App ID, find your project on the Project Management page in Agora Console, and click the eye icon to the right of the App ID.

To get an App Certificate, do the following:

1. On the Project Management page, click Config for the project you want to use.

2. Click the copy icon under Primary Certificate.

To ensure communication security, Agora recommends using tokens to authenticate users logging in Signaling.

For testing purposes, Agora Console supports generating Signaling tokens. To generate a Signaling token:

1. Visit https://webdemo.agora.io/token-builder.

2. Fill in the App ID, App certificate, and user ID to log in to Signaling. You need to specify the user ID yourself (for example, "test"). The generated Signaling token is showed on the screen. When calling the login method later, ensure that the user ID is the same with the one that you use to generate the Signaling token.

1. Open Unity and click New to create a new Unity project.

2. Download the latest version of Agora asset package for Unity on GitHub.

3. In the Unity Editor, select Assets > Import Package > Custom Package.

4. Select the Agora asset package and click Open.

5. All files of the asset package are chosen by default. Uncheck the files that you do not need and click Import.

6. Click MainScene > ChatManager in Hierarchy list.

7. Find Agora Properties in Inspector list, and enter the App ID and the Signaling token.

1. Download the latest version of the Agora Signaling SDK.

2. Find ./samples/Unity-Signaling-Demo folder in the SDK package and open it it in Unity.

3. Copy the Rtm-Scripts folder under the libs folder in the SDK package to the Assets folder of the project path.

4. Copy the following files under the libs/Plugins path in the SDK package to the corresponding path of the project:

   Development Platform	File or folder	Project directory
   Android	Plugins/Android	/Assets/Plugins/Android/
   iOS	Plugins/iOS	/Assets/Plugins/iOS
   macOS	Plugins/macOS	/Assets/Plugins/macOS
   Windows	Plugins/x86	/Assets/Plugins/x86
   Windows	Plugins/x86_64	/Assets/Plugins/x86_64

5. Click MainScene > ChatManager in Unity’s Hierarchy list.

6. Find Agora Properties in Inspector list, and enter the App ID and the Signaling token.

Run the sample project according to the following steps:

1. Click the File menu bar in Unity, and set the device you need to run through Build Settings.

2. Click the Play button at the top of the Unity main interface to run the sample project directly, or click File > Build And Run in the menu bar to compile and run the sample project. If the project runs successfully, you can see the following screen on your device:

   

Now you can experience the Signaling. You can also use the Agora Signaling Web sample app to interact with your device. Ensure that you enter the same App ID, channel name, and Signaling token in the Agora Signaling Web sample app.