- Beat Saber Server Browser (PC)
+ Beat Saber Server Browser (BSSB)
-**Beat Saber multiplayer mod that adds a Server Browser to the Online menu, making it easy to share and join multiplayer games.**
+**Easily share, browse and connect to multiplayer lobbies from the Online menu.**
-| ⏬ PC Mod | -💚 Download latest release | -
| 🆕 Quest Mod | -BeatSaberServerBrowserQuest | -
| 🌎 Online | -https://bssb.app | -
The connection timed out"; + break; + case DisconnectedReason.ServerAtCapacity: + errMsg += "
The server is full"; + break; + case DisconnectedReason.Kicked: + case DisconnectedReason.ServerConnectionClosed: // base game would say: "Server was shut down" ??? + errMsg += "
You were kicked by the server"; + break; + case DisconnectedReason.ServerTerminated: + errMsg += "
The server is shutting down"; + break; + default: + errMsg += "
Check your internet connection and try again"; + break; + } + errMsg += $" ({errCode})"; + + _log.Error($"Multiplayer connection failed with disconnect error: {errCode} ({errKey}): \"{errMsg}\""); + } + else if (_multiplayerUnavailableReason != null) + { + // Multiplayer unavailable (MUR, status check failure) + errKey = _multiplayerUnavailableReason.Value.LocalizedKey(); + errCode = _multiplayerUnavailableReason.Value.ErrorCode(); + + if (_multiplayerUnavailableMessage != null) + errMsg = _multiplayerUnavailableMessage; + else if (_multiplayerUnavailableReason == MultiplayerUnavailableReason.MaintenanceMode) + errMsg = Localization.Instance.GetFormatOrKey(errKey, (_multiplayerMaintenanceEndTime.GetValueOrDefault().AsUnixTime() - DateTime.UtcNow).ToString("h':'mm")); + else + errMsg = $"{Localization.Get(errKey)} ({errCode})"; + + _log.Error($"Multiplayer unavailable error (status check failure): {errCode} ({errKey}): \"{errMsg}\""); + } + else + { + // Normal connection failure (CFR) + _log.Error($"Multiplayer connection failed error: {errCode} ({errKey}): \"{errMsg}\""); + } + + _simpleDialogPromptViewController.Init(errTitle, errMsg, btnOk, btnRetry, + (int btnId) => + { + if (btnId == 1) + { + // Retry + _ = ConnectToServer(_serverInfo!); + } + else + { + // OK + ShowMainView(); + } + }); + + showBackButton = false; + ReplaceTopViewController(_simpleDialogPromptViewController, + animationType: ViewController.AnimationType.In, + animationDirection: ViewController.AnimationDirection.Vertical); + SetTitle(""); + SetMenuLights(MenuLightsErrorPreset); + } + + #endregion + + #region Multiplayer Connection - Base Game + + private async Task LoadAvatar() + { + _multiplayerAvatarsData = await _avatarSystemCollection.GetMultiplayerAvatarsData(_playerDataModel + .playerData + .selectedAvatarSystemTypeId); + + _unifiedNetworkPlayerModel.connectedPlayerManager?.SetLocalPlayerAvatar(_multiplayerAvatarsData.Value); + } + + private void HandleCpmCreated(INetworkPlayerModel networkPlayerModel) + { + if (_multiplayerAvatarsData != null) + networkPlayerModel.connectedPlayerManager.SetLocalPlayerAvatar(_multiplayerAvatarsData.Value); + + _multiplayerSessionManager.StartSession(MultiplayerSessionManager.SessionType.Player, + _unifiedNetworkPlayerModel.connectedPlayerManager); + } + + private void HandleCpmDestroyed(INetworkPlayerModel obj) + { + } + + private void HandleSessionConnected() + { + _log.Info("Multiplayer session connected"); + + _lobbyDataModelsManager.Activate(); + + _ = StartLobbyFlowCoordinator(); + } + + private async Task StartLobbyFlowCoordinator() + { + await _lobbyGameStateController.GetGameStateAndConfigurationAsync( + _joiningLobbyCancellationTokenSource!.Token); + + _log.Info("Lobby join successful"); + + _serverRepository.StopDiscovery(); + + _fadeInOutController.FadeOut(() => + { + _gameServerLobbyFlowCoordinator.didFinishEvent -= HandleGameServerLobbyFlowCoordinatorDidFinish; + _gameServerLobbyFlowCoordinator.didFinishEvent += HandleGameServerLobbyFlowCoordinatorDidFinish; + _gameServerLobbyFlowCoordinator.willFinishEvent -= HandleGameServerLobbyFlowCoordinatorWillFinish; + _gameServerLobbyFlowCoordinator.willFinishEvent += HandleGameServerLobbyFlowCoordinatorWillFinish; + + PresentFlowCoordinator(_gameServerLobbyFlowCoordinator, immediately: true, + replaceTopViewController: false); + + // Hack needed to setup UI properly because we're not replacing the top view controller + // TODO: Can we do better? + _gameServerLobbyFlowCoordinator.TopViewControllerWillChange(_joiningLobbyViewController, + _gameServerLobbyFlowCoordinator._lobbySetupViewController, + ViewController.AnimationType.In); + }); + } + + private void HandleGameServerLobbyFlowCoordinatorDidFinish() + { + _log.Info("Lobby has ended, returning to menu"); + + _gameServerLobbyFlowCoordinator.didFinishEvent -= HandleGameServerLobbyFlowCoordinatorDidFinish; + DismissFlowCoordinator(_gameServerLobbyFlowCoordinator, immediately: true); + _joiningLobbyViewController.HideLoading(); + DisconnectFromServer(); + _lobbyDataModelsManager.Deactivate(); + _fadeInOutController.FadeIn(); + } + + private void HandleGameServerLobbyFlowCoordinatorWillFinish() + { + _gameServerLobbyFlowCoordinator.willFinishEvent -= HandleGameServerLobbyFlowCoordinatorWillFinish; + _lobbyDataModelsManager.Deactivate(); + + if (_connectionFailedReason == null) + // Default: return to main browser view. Lobby flow coordinator will have shown its own errors. + _connectionFailedReason = ConnectionFailedReason.ConnectionCanceled; + } + + private void HandleSessionConnectionFailed(ConnectionFailedReason reason) + { + _log.Info($"Multiplayer session connection failed: {reason}"); + _connectionFailedReason = reason; + DisconnectFromServer(); + } + + public static BeatmapLevelSelectionMask DefaultLevelSelectionMask => + new(BeatmapDifficultyMask.All, GameplayModifierMask.All, SongPackMask.all); + + public static GameplayServerConfiguration DefaultGameplayServerConfiguration => + new(5, DiscoveryPolicy.WithCode, InvitePolicy.AnyoneCanInvite, GameplayServerMode.Countdown, + SongSelectionMode.Vote, GameplayServerControlSettings.All); + + #endregion + + #region Multiplayer Connection - Patches + + [AffinityPrefix] + [AffinityPatch(typeof(MultiplayerSessionManager), nameof(MultiplayerSessionManager.UpdateConnectionState))] + private void PrefixUpdateConnectionState(UpdateConnectionStateReason updateReason, + DisconnectedReason disconnectedReason, ConnectionFailedReason connectionFailedReason) + { + // Read internal session updates to get actually useful error messages + + _log.Debug($"Connection state changed: updateReason={updateReason}," + + $" disconnectedReason={disconnectedReason}, connectionFailedReason={connectionFailedReason}"); + + if (updateReason == UpdateConnectionStateReason.Connected && !_wasEverConnected) + { + _wasEverConnected = true; + _log.Info("Connected to server"); + } + + if (disconnectedReason is not DisconnectedReason.Unknown and not DisconnectedReason.UserInitiated + && _realDisconnectReason != disconnectedReason) + { + _realDisconnectReason = disconnectedReason; + _log.Info($"Disconnect reason: {disconnectedReason} ({connectionFailedReason})"); + } + + if (connectionFailedReason == ConnectionFailedReason.ServerIsTerminating) + { + // Base game message is completely useless ("server does not exist"), so push our disconnect reason instead + _realDisconnectReason = DisconnectedReason.ServerTerminated; + } + } + + [AffinityPrefix] + [AffinityPatch(typeof(IgnoranceClient), nameof(IgnoranceClient.Start))] + // ReSharper disable once InconsistentNaming + private void PrefixIgnoranceClientStart(IgnoranceClient __instance) + { + if (_serverInfo == null) + // We are not managing this connection - patch does not apply + return; + + __instance.UseSsl = _serverInfo.UseDtlsEncryption; + __instance.ValidateCertificate = _serverInfo.UseDtlsEncryption; + } + + [AffinityPrefix] + [AffinityPatch(typeof(GameLiftConnectionManager), nameof(GameLiftConnectionManager.GameLiftConnectToServer))] + // ReSharper disable once InconsistentNaming + private bool PrefixGameLiftConnectToServer(string secret, string code, GameLiftConnectionManager __instance) + { + if (_serverInfo is not { ConnectionMethod: ServerRepository.ConnectionMethod.DirectConnect }) + // We are not managing this connection, or it is a regular GameLift connection - patch does not apply + return true; + + // We will skip the entire GameLift API and move to immediate connection + __instance.HandleConnectToServerSuccess + ( + playerSessionId: "DirectConnect", + hostName: _serverInfo.ServerEndPoint!.Address.ToString(), + port: _serverInfo.ServerEndPoint.Port, + gameSessionId: _serverInfo.ServerUserId, + secret: secret, + code: "DIRECT", + selectionMask: _serverInfo.BeatmapLevelSelectionMask ?? DefaultLevelSelectionMask, + configuration: _serverInfo.GameplayServerConfiguration ?? DefaultGameplayServerConfiguration + ); + return false; + } + + [AffinityPrefix] + [AffinityPatch(typeof(GameServerLobbyFlowCoordinator), + nameof(GameServerLobbyFlowCoordinator.GetLocalizedTitle))] + // ReSharper disable once InconsistentNaming + private bool PrefixGameServerLobbyFlowCoordinatorGetLocalizedTitle(ref string __result) + { + if (_serverInfo == null) + // We are not managing this connection - patch does not apply + return true; + + __result = _serverInfo.ServerName; + return false; + } + + [AffinityPrefix] + [AffinityPatch(typeof(MultiplayerLevelSelectionFlowCoordinator), + nameof(MultiplayerLevelSelectionFlowCoordinator.enableCustomLevels), AffinityMethodType.Getter)] + [AffinityAfter("com.goobwabber.multiplayercore.affinity")] + [AffinityPriority(1)] + // ReSharper disable twice InconsistentNaming + private bool PrefixCustomLevelsEnabled(ref bool __result, SongPackMask ____songPackMask) + { + // MultiplayerCore requires an override API server to be set for custom songs to be enabled + // We have to take over that job here if direct connecting + + if (_serverInfo is not { ConnectionMethod: ServerRepository.ConnectionMethod.DirectConnect }) + // We are not managing this connection, or it is a regular GameLift connection - patch does not apply + return true; + + __result = ____songPackMask.Contains(new SongPackMask("custom_levelpack_CustomLevels")); + return false; + } + + #endregion + + #region Menu Lights + + private MenuLightsPresetSO BakeMenuLightsPreset(Color color) + { + var colorSo = ScriptableObject.CreateInstance