The main menu panel for the roleplay framework. Home page has the menu entries, the s&box news feed, a gamemode picker and status bar; the other pages are a two step server browser (gamemode list, then server list with details and join), a start new game page (gamemode, map, max players, password, lobby privacy) and a diagnostics report. Also handles the connecting overlay and the framework startup failure banner.
@using System
@using System.Collections.Generic
@using System.Linq
@using Sandbox
@using Sandbox.UI
@using RoleplayFramework.Bootstrap
@using RoleplayFramework.Core
@using RoleplayFramework.Diagnostics
@using RoleplayFramework.ServerBrowser
@inherits PanelComponent
@namespace RoleplayFramework.UI
@* Main menu in the layout of Garry's Mod's: logo and menu top left, news on the right, gamemode picker bottom right.
The other pages (server browser, start new game, ...) open as full panels with a back button. *@
<root>
<div class="bg"></div>
<div class="bg-shade"></div>
@if ( Page == MenuPage.Home )
{
<div class="home">
<div class="home-left">
<div class="logo">
<label class="logo-text">roleplay</label>
<label class="logo-sub">s&box, but with Lua</label>
</div>
<div class="menu">
@foreach ( var item in Items )
{
<div class="menu-item @(item.Available ? "" : "disabled") @(item.Id == "quit" ? "spaced" : "")" @onclick=@(() => Activate( item ))>
<label class="menu-label">@item.Label</label>
</div>
}
</div>
@if ( !string.IsNullOrEmpty( Notice ) )
{
<div class="toast"><i>info</i><label>@Notice</label></div>
}
</div>
<div class="news">
<div class="news-header">
<label class="news-title">News</label>
<label class="news-sub">from s&box</label>
</div>
<div class="news-list">
<div class="news-card pinned">
<div class="news-text">
<label class="news-kicker">@($"{FrameworkInfo.Name} {FrameworkInfo.Version}")</label>
<label class="news-headline">s&box, but with Lua</label>
<label class="news-summary">Gamemodes are plain Lua: edit them in your data folder, derive from base, reload live with rp_lua_reload. Host a server or find one below.</label>
</div>
</div>
@if ( MenuData.NewsLoading )
{
<label class="news-empty">Loading news...</label>
}
else if ( MenuData.News.Count == 0 )
{
<label class="news-empty">@(MenuData.NewsError ?? "No news right now.")</label>
}
@foreach ( var n in MenuData.News )
{
<div class="news-card" @onclick=@(() => OpenNews( n ))>
@if ( !string.IsNullOrEmpty( n.Media ) )
{
<div class="news-media" style="background-image: url( @n.Media );"></div>
}
<div class="news-text">
<label class="news-kicker">@MenuData.Age( n.Created )</label>
<label class="news-headline">@n.Title</label>
<label class="news-summary">@n.Summary</label>
</div>
</div>
}
</div>
</div>
</div>
<div class="bottom-bar">
<div class="status">
<label class="dot @StateClass"></label>
<label>@($"{FrameworkInfo.Name} {FrameworkInfo.Version} · Lua API v{FrameworkInfo.LuaApiVersion} · {FrameworkHost.State}")</label>
</div>
<div class="bar-right">
<div class="bar-button" @onclick=@OpenDiagnostics><i>monitor_heart</i><label>Diagnostics</label></div>
<div class="gamemode-button @(GamemodePickerOpen ? "open" : "")" @onclick=@ToggleGamemodePicker>
<i>sports_esports</i>
<label>@SelectedGamemodeTitle</label>
<i class="caret">expand_less</i>
</div>
</div>
</div>
@if ( GamemodePickerOpen )
{
<div class="gamemode-picker">
<label class="picker-title">Gamemode</label>
@foreach ( var gm in AvailableGamemodes )
{
<div class="picker-item @(SelectedGamemode == gm.Id ? "selected" : "")" @onclick=@(() => PickGamemode( gm.Id ))>
<label class="picker-name">@gm.Title</label>
<label class="picker-version">@gm.Version</label>
</div>
}
</div>
}
}
else
{
<div class="window">
<div class="window-header">
<div class="back" @onclick=@GoHome><i>arrow_back</i><label>Back</label></div>
<label class="window-title">@PageTitle</label>
<div class="window-actions">
@if ( Page == MenuPage.Browse )
{
<div class="tabs">
<div class="tab @(FriendsOnly ? "" : "active")" @onclick=@(() => SetFriends( false ))><i>public</i><label>Internet</label></div>
<div class="tab @(FriendsOnly ? "active" : "")" @onclick=@(() => SetFriends( true ))><i>group</i><label>Friends</label></div>
</div>
<div class="search"><i>search</i><TextEntry class="search-input" Value:bind=@Search Placeholder="@(GamemodeFilter is null ? "Search gamemodes" : "Search servers or maps")" /></div>
<div class="icon-button @(ServerBrowserService.State == BrowserState.Loading ? "spinning" : "")" @onclick=@RefreshClicked><i>refresh</i></div>
}
else if ( Page == MenuPage.Diagnostics )
{
<div class="icon-button" @onclick=@Refresh><i>refresh</i></div>
}
</div>
</div>
@if ( Page == MenuPage.Browse )
{
@if ( GamemodeFilter is null )
{
@* Step 1, like Garry's Mod: the gamemodes being played, busiest first. *@
<div class="gamemodes">
@if ( ServerBrowserService.State == BrowserState.Loading && ServerBrowserService.Servers.Count == 0 )
{
<div class="list-empty"><i class="spin">progress_activity</i><label>Searching for servers...</label></div>
}
else if ( ServerBrowserService.State == BrowserState.Failed )
{
<div class="list-empty error"><i>cloud_off</i><label>@ServerBrowserService.Error</label></div>
}
else if ( GamemodeRows.Count == 0 )
{
<div class="list-empty"><i>travel_explore</i><label>@EmptyText</label></div>
}
@foreach ( var g in GamemodeRows )
{
<div class="gamemode-row" @onclick=@(() => SetGamemodeFilter( g.Gamemode ))>
<div class="gamemode-icon"><label>@GamemodeInitial( g.Gamemode )</label></div>
<div class="gamemode-text">
<label class="gamemode-name">@GamemodeTitle( g.Gamemode )</label>
<label class="gamemode-id">@g.Gamemode</label>
</div>
<div class="gamemode-stat"><label class="stat-value">@g.Servers</label><label class="stat-label">@(g.Servers == 1 ? "server" : "servers")</label></div>
<div class="gamemode-stat"><label class="stat-value">@g.Players</label><label class="stat-label">@(g.Players == 1 ? "player" : "players")</label></div>
<i class="chevron">chevron_right</i>
</div>
}
<label class="list-foot">@ListFootText</label>
</div>
}
else
{
@* Step 2: that gamemode's servers, list + details. *@
<div class="browser">
<div class="list">
<div class="list-bar">
<div class="crumb" @onclick=@(() => SetGamemodeFilter( null ))><i>arrow_back</i><label>Gamemodes</label></div>
<label class="crumb-title">@GamemodeTitle( GamemodeFilter )</label>
<div class="filters">
<div class="toggle @(HideFull ? "on" : "")" @onclick=@ToggleHideFull><i>@(HideFull ? "check_box" : "check_box_outline_blank")</i><label>Hide full</label></div>
<div class="toggle @(HideEmpty ? "on" : "")" @onclick=@ToggleHideEmpty><i>@(HideEmpty ? "check_box" : "check_box_outline_blank")</i><label>Hide empty</label></div>
<div class="toggle @(HidePassword ? "on" : "")" @onclick=@ToggleHidePassword><i>@(HidePassword ? "check_box" : "check_box_outline_blank")</i><label>Hide passworded</label></div>
</div>
</div>
<div class="list-head">
<label class="col-icons"></label>
<label class="col-name sortable @SortClass( SortMode.Name )" @onclick=@(() => SetSort( SortMode.Name ))>Server</label>
<label class="col-players sortable @SortClass( SortMode.Players )" @onclick=@(() => SetSort( SortMode.Players ))>Players</label>
<label class="col-map sortable @SortClass( SortMode.Map )" @onclick=@(() => SetSort( SortMode.Map ))>Map</label>
<label class="col-ping sortable @SortClass( SortMode.Ping )" @onclick=@(() => SetSort( SortMode.Ping ))>Ping</label>
</div>
<div class="list-body">
@if ( ServerBrowserService.State == BrowserState.Loading && ServerBrowserService.Servers.Count == 0 )
{
<div class="list-empty"><i class="spin">progress_activity</i><label>Searching for servers...</label></div>
}
else if ( ServerBrowserService.State == BrowserState.Failed )
{
<div class="list-empty error"><i>cloud_off</i><label>@ServerBrowserService.Error</label></div>
}
else if ( VisibleServers.Count == 0 )
{
<div class="list-empty"><i>travel_explore</i><label>@EmptyText</label></div>
}
@foreach ( var srv in VisibleServers )
{
<div class="server @(Selected?.LobbyId == srv.LobbyId ? "selected" : "") @(srv.Compatible ? "" : "incompatible")" @onclick=@(() => Select( srv ))>
<div class="col-icons">
@if ( srv.Password ) { <i title="Password">lock</i> }
@if ( srv.Friends ) { <i class="friends" title="Friends playing">group</i> }
</div>
<div class="col-name">
<label class="server-name">@srv.Name</label>
<label class="server-gm">@srv.Gamemode</label>
</div>
<div class="col-players">
<label>@($"{srv.Players} / {srv.MaxPlayers}")</label>
<div class="fill-bar"><div class="fill" style="width: @(FillPercent( srv ))%;"></div></div>
</div>
<label class="col-map">@MapTitle( srv.Map )</label>
<label class="col-ping @PingClass( srv.Ping )">@($"{(srv.PingEstimated ? "~" : "")}{srv.Ping}")</label>
</div>
}
</div>
<label class="list-foot">@ListFootText</label>
</div>
<div class="details">
@if ( Selected is null )
{
<div class="details-empty"><i>dns</i><label>Select a server to see its details.</label></div>
}
else
{
var info = MenuData.Map( Selected.Map );
<div class="details-map" style="@(info?.Thumb is null ? "" : $"background-image: url( {info.Thumb} );")">
<label class="details-map-name">@(info?.Title ?? Selected.Map)</label>
</div>
<label class="details-name">@Selected.Name</label>
<div class="details-grid">
<label class="k">Gamemode</label><label class="v">@Selected.Gamemode</label>
<label class="k">Map</label><label class="v">@Selected.Map</label>
<label class="k">Players</label><label class="v">@($"{Selected.Players} / {Selected.MaxPlayers}")</label>
<label class="k">Ping</label><label class="v">@($"{(Selected.PingEstimated ? "~" : "")}{Selected.Ping} ms")</label>
<label class="k">Framework</label><label class="v">@($"{Selected.FrameworkVersion} (protocol {Selected.Protocol})")</label>
<label class="k">Access</label><label class="v">@(Selected.Password ? "Password" : "Open")</label>
</div>
@if ( !Selected.Compatible )
{
<div class="details-warning"><i>warning</i><label>@(Selected.Outdated ? "This server runs a different game version." : "This server runs an incompatible framework version.")</label></div>
}
<div class="join @(CanJoin( Selected ) ? "" : "disabled")" @onclick=@(() => Join( Selected ))>
<i>play_arrow</i><label>@(Selected.Full ? "Server full" : "Join server")</label>
</div>
}
</div>
</div>
}
}
else if ( Page == MenuPage.Host )
{
<div class="newgame">
<div class="sidebar">
<label class="sidebar-title">Gamemode</label>
@foreach ( var gm in AvailableGamemodes )
{
<div class="gm-row @(Host.Gamemode == gm.Id ? "active" : "")" @onclick=@(() => SetGamemode( gm.Id ))>
<div class="gm-text">
<label class="gm-name">@gm.Title</label>
<label class="gm-players">@($"{gm.Id} · {gm.Version}")</label>
</div>
</div>
}
</div>
<div class="maps">
<label class="section-title">Map</label>
<div class="map-grid">
@foreach ( var m in MapsForSelectedGamemode )
{
var info = MenuData.Map( m );
<div class="map-tile @(Host.ResolvedMap == m ? "selected" : "")" @onclick=@(() => SetMap( m ))>
<div class="map-thumb" style="@(info?.Thumb is null ? "" : $"background-image: url( {info.Thumb} );")">
@if ( info?.Thumb is null ) { <i>map</i> }
</div>
<label class="map-name">@(info?.Title ?? m)</label>
<label class="map-ident">@(MapCatalog.IsBuiltIn( m ) ? "built-in" : m)</label>
</div>
}
</div>
<label class="field-label">Other map (sbox.game package)</label>
<TextEntry class="input" Value:[email protected] MaxLength=@(130) Placeholder="e.g. org.mapname" />
</div>
<div class="settings">
<label class="section-title">Server</label>
<label class="field-label">Name</label>
<TextEntry class="input" Value:[email protected] MaxLength=@(64) Placeholder="My Roleplay Server" />
<label class="field-label">Max players</label>
<div class="stepper">
<div class="icon-button" @onclick=@(() => ChangePlayers( -1 ))><i>remove</i></div>
<label class="value">@Host.MaxPlayers</label>
<div class="icon-button" @onclick=@(() => ChangePlayers( 1 ))><i>add</i></div>
</div>
<label class="field-label">Password</label>
<TextEntry class="input" Value:[email protected] MaxLength=@(64) Placeholder="None" />
<label class="field-label">Visibility</label>
<div class="segmented">
@foreach ( var p in PrivacyOptions )
{
<div class="segment @(Host.Privacy == p ? "selected" : "")" @onclick=@(() => SetPrivacy( p ))><label>@(p == Sandbox.Network.LobbyPrivacy.FriendsOnly ? "Friends" : p.ToString())</label></div>
}
</div>
<div class="settings-spacer"></div>
@if ( !string.IsNullOrEmpty( HostError ) )
{
<div class="details-warning"><i>error</i><label>@HostError</label></div>
}
<label class="field-hint">Your game is the server and you play on it. Cloud maps download on first use.</label>
<div class="join" @onclick=@StartHost><i>play_arrow</i><label>Start Game</label></div>
</div>
</div>
}
else if ( Page == MenuPage.Diagnostics )
{
<div class="report">
<label class="mono">@ReportText</label>
</div>
}
</div>
}
@if ( ConnectService.State == ConnectState.Connecting )
{
<div class="overlay">
<div class="overlay-card">
<i class="spin big">progress_activity</i>
<label class="section-title">@($"Joining {ConnectService.Target}")</label>
<label class="field-hint">Waiting for the server. If it needs a password, s&box will ask for it.</label>
<div class="bar-button" @onclick=@CancelConnect><i>close</i><label>Cancel</label></div>
</div>
</div>
}
@if ( FrameworkHost.State == StartupState.Failed )
{
<div class="banner"><i>error</i><label>@($"Framework failed to start: {FrameworkHost.FailureReason}. Open Diagnostics for details.")</label></div>
}
</root>
@code
{
public enum MenuPage { Home, Host, Browse, Diagnostics }
// ---------------------------------------------------------------- server browser
string Search = "";
string GamemodeFilter;
bool HideFull, HideEmpty, HidePassword, FriendsOnly;
SortMode SortBy = SortMode.Players;
bool SortDescending;
ServerEntry Selected;
List<ServerEntry> VisibleServers => ServerBrowserService.View( Search, GamemodeFilter, HideFull, HideEmpty, HidePassword, SortBy, FriendsOnly, SortDescending );
string EmptyText => ServerBrowserService.Servers.Count == 0
? "No public servers right now. Start your own with Start New Game (or join one by id with rp_connect <id> in the console)."
: FriendsOnly ? "None of your Steam friends is hosting a public server right now." : "No servers match your filters.";
string ListFootText
{
get
{
var all = ServerBrowserService.Servers;
var when = ServerBrowserService.LastRefreshUtc is { } t ? $"updated {MenuData.Age( t )}" : "";
return $"{VisibleServers.Count} of {all.Count} servers · {all.Sum( s => s.Players )} players {(when == "" ? "" : "· " + when)}";
}
}
string PageTitle => Page switch
{
MenuPage.Browse => "Find Multiplayer Game",
MenuPage.Host => "Start New Game",
MenuPage.Diagnostics => "Diagnostics",
_ => "",
};
IEnumerable<RoleplayFramework.Scripting.GamemodeManifest> AvailableGamemodes =>
RoleplayFramework.Scripting.GamemodeRegistry.Current.Valid.Values.OrderBy( g => g.Title );
void OpenBrowse()
{
Page = MenuPage.Browse;
Selected = null;
_ = ServerBrowserService.Refresh();
}
void RefreshClicked() => _ = ServerBrowserService.Refresh();
void SetSort( SortMode m )
{
if ( SortBy == m ) SortDescending = !SortDescending;
else { SortBy = m; SortDescending = false; }
_version++;
}
string SortClass( SortMode m ) => SortBy != m ? "" : SortDescending ? "sorted desc" : "sorted";
void SetGamemodeFilter( string gm ) { GamemodeFilter = gm; Selected = null; _version++; }
List<(string Gamemode, int Servers, int Players)> GamemodeRows => ServerBrowserService.GamemodeSummary( FriendsOnly )
.Where( g => string.IsNullOrWhiteSpace( Search ) || g.Gamemode.Contains( Search.Trim(), StringComparison.OrdinalIgnoreCase )
|| GamemodeTitle( g.Gamemode ).Contains( Search.Trim(), StringComparison.OrdinalIgnoreCase ) ).ToList();
/// <summary>A gamemode's title if this game knows it (e.g. "DarkRP"), else its id from the server.</summary>
static string GamemodeTitle( string id ) =>
id is not null && RoleplayFramework.Scripting.GamemodeRegistry.Current.Valid.TryGetValue( id, out var gm ) ? gm.Title : (id ?? "");
static string GamemodeInitial( string id ) { var t = GamemodeTitle( id ); return t.Length == 0 ? "?" : t.Substring( 0, 1 ).ToUpperInvariant(); }
void SetFriends( bool on ) { FriendsOnly = on; GamemodeFilter = null; _version++; }
void ToggleHideFull() { HideFull = !HideFull; _version++; }
void ToggleHideEmpty() { HideEmpty = !HideEmpty; _version++; }
void ToggleHidePassword() { HidePassword = !HidePassword; _version++; }
void Select( ServerEntry srv ) { Selected = srv; _version++; }
static int FillPercent( ServerEntry s ) => s.MaxPlayers <= 0 ? 0 : Math.Clamp( s.Players * 100 / s.MaxPlayers, 0, 100 );
static string PingClass( int ping ) => ping < 60 ? "good" : ping < 140 ? "ok" : "bad";
static string MapTitle( string map ) => MenuData.Map( map )?.Title ?? map;
static bool CanJoin( ServerEntry s ) => s.Compatible && !s.Full;
void Join( ServerEntry srv )
{
if ( srv is null || !CanJoin( srv ) ) return;
ConnectService.Connect( srv.LobbyId.ToString(), srv.Name );
_version++;
}
void CancelConnect()
{
ConnectService.Cancel();
_version++;
}
// ---------------------------------------------------------------- news
void OpenNews( Sandbox.Services.News n )
{
try { Game.Overlay.ShowNewsModal( n ); }
catch ( Exception e ) { Notice = $"Could not open the article: {e.Message}"; _version++; }
}
// ---------------------------------------------------------------- gamemode picker (bottom right, like GMod)
bool GamemodePickerOpen;
string SelectedGamemode;
string SelectedGamemodeTitle =>
RoleplayFramework.Scripting.GamemodeRegistry.Current.Valid.TryGetValue( SelectedGamemode ?? "", out var gm ) ? gm.Title : (SelectedGamemode ?? "No gamemode");
void ToggleGamemodePicker() { GamemodePickerOpen = !GamemodePickerOpen; _version++; }
void PickGamemode( string id )
{
SelectedGamemode = id;
GamemodePickerOpen = false;
_version++;
}
// ---------------------------------------------------------------- start new game
void SetGamemode( string id )
{
Host.Gamemode = id;
SelectedGamemode = id;
Host.Map = ""; // switch to the new gamemode's default map
_version++;
}
void SetMap( string map ) { Host.Map = map; _version++; }
IEnumerable<string> MapsForSelectedGamemode =>
RoleplayFramework.Scripting.GamemodeRegistry.Current.Valid.TryGetValue( Host.Gamemode ?? "", out var gm )
? gm.AvailableMaps
: new List<string> { "minimal" };
protected override void OnUpdate()
{
var before = ConnectService.State;
ConnectService.Tick();
if ( before == ConnectState.Connecting && ConnectService.State == ConnectState.Failed )
{
Notice = $"Could not join: {ConnectService.Error}";
if ( Page != MenuPage.Home ) Page = MenuPage.Home;
_version++;
}
}
static readonly Sandbox.Network.LobbyPrivacy[] PrivacyOptions =
{
Sandbox.Network.LobbyPrivacy.Public,
Sandbox.Network.LobbyPrivacy.FriendsOnly,
Sandbox.Network.LobbyPrivacy.Private,
};
RoleplayFramework.Net.HostSettings Host = new();
string HostError;
/// <summary>
/// One main-menu entry. Unavailable entries are shown greyed out, and clicking one says why,
/// never a button that silently does nothing.
/// </summary>
public sealed record MenuItem( string Id, string Label, string Hint, bool Available, Action Run );
public MenuPage Page { get; private set; } = MenuPage.Home;
string Notice;
string ReportText = "";
int _version;
List<MenuItem> Items;
protected override void OnStart()
{
FrameworkHost.EnsureBooted();
Items = BuildItems();
SelectedGamemode = FrameworkHost.Config.DefaultGamemode;
_ = MenuData.LoadNews();
var reason = RoleplayFramework.Net.SessionService.LastDisconnectReason;
if ( !string.IsNullOrEmpty( reason ) )
{
Notice = $"Session ended: {reason}";
RoleplayFramework.Net.SessionService.LastDisconnectReason = null;
}
RpLog.Info( "ui", "Main menu shown" );
}
List<MenuItem> BuildItems() => new()
{
new( "browse", "Find Multiplayer Game", "Public servers", true, OpenBrowse ),
new( "host", "Start New Game", "Host a server and play on it", true, OpenHost ),
new( "settings", "Options", "not available yet - use the s&box settings", false, null ),
new( "quit", "Quit", "Close the game", true, Quit ),
};
void Activate( MenuItem item )
{
GamemodePickerOpen = false;
if ( !item.Available )
{
Notice = $"{item.Label}: {item.Hint}.";
_version++;
return;
}
Notice = null;
item.Run?.Invoke();
_version++;
}
void OpenHost()
{
// Rescan every time: gamemodes may have been added to (or edited in) the Lua folder since startup.
var reg = RoleplayFramework.Scripting.GamemodeRegistry.Discover( RoleplayFramework.Scripting.LuaSource.Snapshot() );
foreach ( var (id, problems) in reg.Invalid )
RpLog.Warn( "gamemodes", $"Gamemode '{id}' can't be hosted: {string.Join( "; ", problems )}" );
Host = RoleplayFramework.Net.HostSettings.FromConfig( FrameworkHost.Config );
if ( !string.IsNullOrEmpty( SelectedGamemode ) && reg.Valid.ContainsKey( SelectedGamemode ) )
{
Host.Gamemode = SelectedGamemode;
Host.Map = "";
}
HostError = null;
Page = MenuPage.Host;
}
void ChangePlayers( int delta )
{
Host.MaxPlayers = Math.Clamp( Host.MaxPlayers + delta, 1, FrameworkConfig.ProjectMaxPlayers );
_version++;
}
void SetPrivacy( Sandbox.Network.LobbyPrivacy p )
{
Host.Privacy = p;
_version++;
}
void StartHost()
{
if ( !RoleplayFramework.Net.SessionService.StartLocalHost( Host, out var error ) )
HostError = error;
else
HostError = null;
_version++;
}
void OpenDiagnostics()
{
GamemodePickerOpen = false;
ReportText = DiagnosticsReport.Build();
Page = MenuPage.Diagnostics;
}
void Refresh()
{
ReportText = DiagnosticsReport.Build();
_version++;
}
void GoHome()
{
Page = MenuPage.Home;
_version++;
}
void Quit()
{
RpLog.Info( "ui", "Quit requested from main menu" );
Game.Close();
}
string StateClass => FrameworkHost.State switch
{
StartupState.Ready => "ok",
StartupState.Failed => "bad",
_ => "pending",
};
protected override int BuildHash() => HashCode.Combine(
HashCode.Combine( Page, Notice, _version, FrameworkHost.State, HostError, GamemodePickerOpen ),
HashCode.Combine( ServerBrowserService.Version, ConnectService.Version, MenuData.Version ),
Search, Host?.Map, Selected?.LobbyId );
}