🕶️
🕶️
🕶️
🕶️
NRSDK
v2.1.0
Ask or search…
K

Setting Up Photon

1. Install photon

Search for Photon Unity Networking in the Unity Asset Store, then download and import it into your project. (Note whether you are downloading PUN1 or PUN2. This tutorial uses PUN2, as there may be some compatibility issues with PUN1. It is recommended to use PUN2).
Pay attention to resolving issues related to assemblies.
  • Open the assembly of NRSDK.
  • Find the "Assembly Definition References" section and click the "+" button to add a new reference. In the new reference, select the Photon assembly PhotonUnityNetworking and PhotonRealtime. Click the "Apply" button to save your changes.

2. Set up Photon in Unity

Use Photon Cloud Server
Use Self-hosted Server
  1. 1.
    Register and create a new application on the official website of Photon, then obtain the App ID for your application.
  1. 2.
    In Unity, open PhotonServerSettings (Window > Photon Unity Networking), and then enter your App ID.
Note that the self-hosted server is only compatible with Windows operating systems. For details, please refer to the official document of photon.
  1. 1.
    Download Photon Server SDK and extract the server package to any place - preferably an empty folder which you prepared beforehand.
  2. 2.
    Get a license, claim it and save it to "deploy\bin_Win64".
  3. 3.
    Start "PhotonControl.exe" and confirm the admin rights for this application. They are needed for the option to set up Photon as a Service. Look out for the tray-bar icon (bottom right by default). Click the white/grey icon to open a menu that controls Photon.
  4. 4.
    Pick LoadBalancing (MyCloud) from the Photon Instances and "Start as Application". Now you started Photon.
  5. 5.
    Now you can connect clients running on the same machine.
  6. 6.
    To connect clients from a local network, simulated device or the public internet, change the IP Address Config. The next steps are to set up the method for local network. (Use one local host as a server, and then connect other client devices to the same Wi-Fi as that server.)
  7. 7.
    In Unity, open PhotonServerSettings (Window > Photon Unity Networking, then click Locate PhotonServerSettings)
  1. 9.
    Modify PhotonServerSettings: unselect "Use Name Server", fill in the IP address and port number of the self-hosted server (if using UDP protocol, the default port number is 5055).
    You can find your local server IP here:
  1. 10.
    Modify the PublicIpAddress field in GameServer.xml.config to the IP address of the self-hosted server (default is 127.0.0.1). You can find this file in: deploy\LoadBalancing\GameServer\bin

3. Joining a room

A crucial prerequisite for sharing an anchor among different users is that they are in the same room. Therefore, we need to set up a script to allow them to join the same room.
The joinedRoomIndicator is used to indicate a successful room joining. The method used here is to change the color of the join button after successfully joining.
using UnityEngine;
using Photon.Pun;
using Photon.Realtime;
using UnityEngine.UI;
public class JoinRoomButton : MonoBehaviourPunCallbacks
{
public Button joinedRoomIndicator;
public void OnButtonClick()
{
// Connect to the Photon master server
if (!PhotonNetwork.IsConnected)
{
PhotonNetwork.ConnectUsingSettings();
}
else
{
TryJoinRoom();
}
}
public override void OnConnectedToMaster()
{
Debug.Log("Connected to Photon master server");
TryJoinRoom();
}
private void TryJoinRoom()
{
// Try to join the room "MyRoom"
PhotonNetwork.JoinRoom("MyRoom");
}
public override void OnJoinedRoom()
{
Debug.Log("Joined room: " + PhotonNetwork.CurrentRoom.Name);
joinedRoomIndicator.image.color = Color.green;
}
public override void OnJoinRoomFailed(short returnCode, string message)
{
Debug.Log("Failed to join room");
// If we failed to join the room, it might not exist, so let's try to create it
PhotonNetwork.CreateRoom("MyRoom");
}
public override void OnCreatedRoom()
{
Debug.Log("Created room: " + PhotonNetwork.CurrentRoom.Name);
}
public override void OnCreateRoomFailed(short returnCode, string message)
{
Debug.Log("Failed to create room");
}
}