Skip to content

Commit

Permalink
chore: update example overriding scenes networkprefabs dedicated serv…
Browse files Browse the repository at this point in the history 
…er (#3207)

* update

Adding support for a dedicated server build.

* update

adding windows dedicated server build example with DEDICATED_SERVER define
  • Loading branch information
@NoelStephensUnity
NoelStephensUnity authored Jan 16, 2025
1 parent 248aa21 commit 1249843
Show file tree
Hide file tree
Showing 10 changed files with 293 additions and 14 deletions.
6 changes: 6 additions & 0 deletions Examples/OverridingScenesAndPrefabs/Assets/Scripts/MoverScriptNoRigidbody.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,9 @@ protected override void OnNetworkPostSpawn()
}

m_ParentedText?.gameObject.SetActive(true);
#if !DEDICATED_SERVER
UpdateParentedText();
#endif
base.OnNetworkPostSpawn();
}

Expand All @@ -201,7 +203,9 @@ public override void OnNetworkObjectParentChanged(NetworkObject parentNetworkObj
{
Debug.Log($"Parented under {parentNetworkObject.name}");
}
#if !DEDICATED_SERVER
UpdateParentedText();
#endif
base.OnNetworkObjectParentChanged(parentNetworkObject);
}

Expand Down Expand Up @@ -334,6 +338,7 @@ private void ApplyInput()
m_PlayerBallMotion.HasMotion(moveMotion);
}

#if !DEDICATED_SERVER
/// <summary>
/// Updates player TextMesh relative to each client's camera view
/// </summary>
Expand Down Expand Up @@ -373,4 +378,5 @@ private void UpdateParentedText()
}
}
}
#endif
}
205 changes: 197 additions & 8 deletions Examples/OverridingScenesAndPrefabs/Assets/Scripts/NetworkManagerBootstrapper.cs
View file
Original file line number Diff line number Diff line change
@@ -1,13 +1,23 @@
#if !DEDICATED_SERVER || (DEDICATED_SERVER && !UNITY_EDITOR)
using System;
#endif
using System.Collections.Generic;
using System.Linq;
#if !DEDICATED_SERVER
using System.Threading.Tasks;
#endif
using Unity.Netcode;
#if !DEDICATED_SERVER
using Unity.Services.Authentication;
using Unity.Services.Core;
using Unity.Services.Multiplayer;
#else
using Unity.Netcode.Transports.UTP;
#endif
using UnityEngine;
#if !DEDICATED_SERVER
using SessionState = Unity.Services.Multiplayer.SessionState;
#endif

#region NetworkManagerBootstrapperEditor
#if UNITY_EDITOR
Expand Down Expand Up @@ -67,7 +77,7 @@ protected override void OnValidateComponent()
base.OnValidateComponent();
}
#endif
#endregion
#endregion

#region Properties
public static NetworkManagerBootstrapper Instance;
Expand Down Expand Up @@ -98,12 +108,13 @@ private enum ConnectionStates

[SerializeField]
private bool m_ServicesRegistered;
#if !DEDICATED_SERVER
private ISession m_CurrentSession;
private string m_SessionName;
private string m_ProfileName;
private Task m_SessionTask;

#endregion
#endif
#endregion

#region Initialization and Destroy
public static string GetRandomString(int length)
Expand All @@ -120,12 +131,27 @@ public void SetFrameRate(int targetFrameRate, bool enableVsync)

private void Awake()
{
#if !DEDICATED_SERVER
Screen.SetResolution((int)(Screen.currentResolution.width * 0.40f), (int)(Screen.currentResolution.height * 0.40f), FullScreenMode.Windowed);
SetFrameRate(TargetFrameRate, EnableVSync);
#endif
SetSingleton();
m_SceneBootstrapLoader = GetComponent<SceneBootstrapLoader>();
}

#if DEDICATED_SERVER
private void Start()
{
m_SceneBootstrapLoader.OnMainMenuLoaded += OnMainMenuLoaded;
m_SceneBootstrapLoader.LoadMainMenu();
}

private void OnMainMenuLoaded()
{
m_SceneBootstrapLoader.OnMainMenuLoaded -= OnMainMenuLoaded;
StartDedicatedServer();
}
#else
private async void Start()
{
OnClientConnectedCallback += OnClientConnected;
Expand All @@ -152,17 +178,20 @@ private async void Start()
}
}
m_SceneBootstrapLoader.LoadMainMenu();
}

}
private void OnDestroy()
{
OnClientConnectedCallback -= OnClientConnected;
OnClientDisconnectCallback -= OnClientDisconnect;
OnConnectionEvent -= OnClientConnectionEvent;
}
#endregion
#endif
#endregion

#region Session and Connection Event Handling

#if !DEDICATED_SERVER
private void OnClientConnectionEvent(NetworkManager networkManager, ConnectionEventData eventData)
{
LogMessage($"[{Time.realtimeSinceStartup}] Connection event {eventData.EventType} for Client-{eventData.ClientId}.");
Expand Down Expand Up @@ -235,9 +264,11 @@ private async Task<ISession> ConnectThroughLiveService()
}
return null;
}
#endregion
#endif
#endregion

#region GUI Menu
#if !DEDICATED_SERVER
public void StartOrConnectToDistributedAuthoritySession()
{
m_SessionTask = ConnectThroughLiveService();
Expand Down Expand Up @@ -364,9 +395,11 @@ private void OnGUI()
}
GUILayout.EndArea();
}
#endregion
#endif
#endregion

#region Server Camera Handling
#if !DEDICATED_SERVER
private Vector3 m_CameraOriginalPosition;
private Quaternion m_CameraOriginalRotation;
private int m_CurrentFollowPlayerIndex = -1;
Expand Down Expand Up @@ -438,9 +471,159 @@ public void ClearFollowPlayer()
SetCameraDefaults();
}
}
#endregion
#endif
#endregion

#region Update Methods and Properties
#if DEDICATED_SERVER
private UnityTransport m_UnityTransport;
/// <summary>
/// All of the dedicated server specific script logic is contained and only compiled when DEDICATED_SERVER is defined
/// </summary>

private void StartDedicatedServer()
{
m_UnityTransport = NetworkConfig.NetworkTransport as UnityTransport;
if (m_UnityTransport != null)
{
// Always good to know what scenes are currently loaded since you might have
// different scenes to load for a DGS vs client
var scenesPreloaded = new System.Text.StringBuilder();
scenesPreloaded.Append("Scenes Preloaded: ");
for (int i = 0; i < UnityEngine.SceneManagement.SceneManager.sceneCount; i++)
{
var scene = UnityEngine.SceneManagement.SceneManager.GetSceneAt(i);
scenesPreloaded.Append($"[{scene.name}]");
}
Debug.Log(scenesPreloaded.ToString());

// Set the application frame rate to like 30 to reduce frame processing overhead
Application.targetFrameRate = 30;

Debug.Log($"[Pre-Init] Server Address Endpoint: {m_UnityTransport.ConnectionData.ServerEndPoint}");
Debug.Log($"[Pre-Init] Server Listen Endpoint: {m_UnityTransport.ConnectionData.ListenEndPoint}");
// Setup your IP and port sepcific to your DGS
//unityTransport.SetConnectionData(ListenAddress, ListenPort, ListenAddress);

//Debug.Log($"[Post-Init] Server Address Endpoint: {unityTransport.ConnectionData.ServerEndPoint}");
//Debug.Log($"[Post-Init] Server Listen Endpoint: {unityTransport.ConnectionData.ListenEndPoint}");

// Get the server started notification
OnServerStarted += ServerStarted;

// Start the server listening
m_SceneBootstrapLoader.StartSession(SceneBootstrapLoader.StartAsTypes.Server);
}
else
{
Debug.LogError("Failed to get the UnityTransport!");
}
}

/// <summary>
/// Register callbacks when the OnServerStarted callback is invoked.
/// This makes it easier to know you are registering for events only
/// when the server successfully has started.
/// </summary>
private void ServerStarted()
{
Debug.Log("Dedicated Server Started!");
Debug.Log($"[Started] Server Address Endpoint: {m_UnityTransport.ConnectionData.ServerEndPoint}");
Debug.Log($"[Started] Server Listen Endpoint: {m_UnityTransport.ConnectionData.ListenEndPoint}");
Debug.Log("===============================================================");
Debug.Log("[X] Exits session (Shutdown) | [ESC] Exits application instance");
Debug.Log("===============================================================");
OnServerStarted -= ServerStarted;
OnClientConnectedCallback += ClientConnectedCallback;
OnClientDisconnectCallback += ClientDisconnectCallback;
// Register for OnServerStopped
OnServerStopped += ServerStopped;
}

private void ServerStopped(bool obj)
{
OnClientConnectedCallback -= ClientConnectedCallback;
OnClientDisconnectCallback -= ClientDisconnectCallback;
OnServerStopped -= ServerStopped;
Debug.Log("Dedicated Server Stopped!");
Debug.Log("===============================================================");
Debug.Log("[S] Starts new session (StartServer) | [ESC] Exits application");
Debug.Log("===============================================================");
}

private void ClientConnectedCallback(ulong clientId)
{
Debug.Log($"Client-{clientId} connected and approved.");
}

private void ClientDisconnectCallback(ulong clientId)
{
Debug.Log($"Client-{clientId} disconnected.");
}

#if UNITY_EDITOR
private void HandleEditorKeyCommands()
{
// Shutdown/Stop the server
if (Input.GetKeyDown(KeyCode.X) && IsListening && !ShutdownInProgress)
{
Shutdown();
}
else // Start the server (this example makes it automatically start when the application first starts)
if (Input.GetKeyDown(KeyCode.S) && !IsListening)
{
StartDedicatedServer();
}
}
#else
private void HandleConsoleKeyCommands()
{
if (Console.KeyAvailable)
{
var networkManager = NetworkManager.Singleton;
var keyPressed = Console.ReadKey(true);
switch(keyPressed.Key)
{
case ConsoleKey.X:
{
if(networkManager.IsListening && !networkManager.ShutdownInProgress)
{
networkManager.Shutdown();
}
break;
}
case ConsoleKey.S:
{
if (!networkManager.IsListening && !networkManager.ShutdownInProgress)
{
StartDedicatedServer();
}
break;
}
case ConsoleKey.Escape:
{
Application.Quit();
break;
}
}
}
}
#endif

/// <summary>
/// Update that is only included in the build and invoked when running as a dedicated server
/// </summary>
private void DedicatedServerUpdate()
{
#if UNITY_EDITOR
HandleEditorKeyCommands();
#else
HandleConsoleKeyCommands();
#endif
}

#else // End of DEDICATED_SERVER defined region

/// <summary>
/// General update for server-side
/// </summary>
Expand All @@ -459,9 +642,13 @@ private void ClientSideUpdate()
{

}
#endif

private void Update()
{
#if DEDICATED_SERVER
DedicatedServerUpdate();
#else
if (IsListening)
{
if (IsServer)
Expand All @@ -473,6 +660,7 @@ private void Update()
ClientSideUpdate();
}
}
#endif

if (m_MessageLogs.Count == 0)
{
Expand All @@ -487,6 +675,7 @@ private void Update()
}
}
}

#endregion

#region Message Logging
Expand Down
2 changes: 2 additions & 0 deletions Examples/OverridingScenesAndPrefabs/Assets/Scripts/NetworkPrefabOverrideHandler.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,13 +52,15 @@ public NetworkObject Instantiate(ulong ownerClientId, Vector3 position, Quaterni

public void Destroy(NetworkObject networkObject)
{
#if !DEDICATED_SERVER
// Another useful thing about handling this instantiation and destruction of a NetworkObject is that you can do house cleaning
// prior to the object being destroyed. This handles the scenario where the server is following a player and the player disconnects.
// Before destroying the player object, we want to unparent the camera and reset the player being followed.
if (m_NetworkManager.IsServer && !m_NetworkManager.IsHost && Camera.main != null && Camera.main.transform.parent == networkObject.transform)
{
m_NetworkManager.ClearFollowPlayer();
}
#endif
Destroy(networkObject.gameObject);
}
}
Expand Down
Loading

0 comments on commit 1249843

Please sign in to comment.