Added ServerInit class, changed how servers are initialized

Facepunch.Steamworks.Test/Client/Inventory.cs

@@ -134,7 +134,7 @@ namespace Facepunch.Steamworks.Test
                 Assert.IsNotNull( client.Inventory.SerializedItems );
                 Assert.IsTrue( client.Inventory.SerializedItems.Length > 4 );
 
-                using ( var server = new Facepunch.Steamworks.Server( 252490, 0, 30002, true, "VersionString" ) )
+                using ( var server = new Facepunch.Steamworks.Server( 252490, new ServerInit( "rust", "Rust" ) ) )
                 {
                     server.LogOnAnonymous();
                     Assert.IsTrue( server.IsValid );

Facepunch.Steamworks.Test/Server/Server.cs

@@ -18,8 +18,16 @@ namespace Facepunch.Steamworks.Test
         [TestMethod]
         public void Init()
         {
-            using ( var server = new Facepunch.Steamworks.Server( 252490, 0, 30003, 30004, 30005, false, "VersionString" ) )
+            var serverInit = new ServerInit( "rust", "Rust" );
+            serverInit.GamePort = 28015;
+            serverInit.Secure = true;
+            serverInit.QueryPort = 28016;
+
+            using ( var server = new Facepunch.Steamworks.Server( 252490, serverInit ) )
             {
+                server.ServerName = "My Test Server";
+                server.LogOnAnonymous();
+
                 Assert.IsTrue( server.IsValid );
             }
         }
@@ -27,7 +35,7 @@ namespace Facepunch.Steamworks.Test
         [TestMethod]
         public void PublicIp()
         {
-            using ( var server = new Facepunch.Steamworks.Server( 252490, 0, 30003, 30004, 30005, false, "VersionString" ) )
+            using ( var server = new Facepunch.Steamworks.Server( 252490, new ServerInit( "rust", "Rust" ) ) )
             {
                 server.LogOnAnonymous();
 
@@ -61,7 +69,7 @@ namespace Facepunch.Steamworks.Test
                 var ticket = client.Auth.GetAuthSessionTicket();
                 var ticketBinary = ticket.Data;
 
-                using ( var server = new Facepunch.Steamworks.Server( 252490, 0, 30002, 30003, 30004, true, "VersionString" ) )
+                using ( var server = new Facepunch.Steamworks.Server( 252490, new ServerInit( "rust", "Rust" ) ) )
                 {
                     server.LogOnAnonymous();
 

Facepunch.Steamworks.Test/Server/Stats.cs

@@ -10,7 +10,7 @@ namespace Facepunch.Steamworks.Test
         [TestMethod]
         public void StatsGet()
         {
-            using ( var server = new Facepunch.Steamworks.Server( 252490, 0, 30003, 30004, 30005, true, "VersionString" ) )
+            using ( var server = new Facepunch.Steamworks.Server( 252490, new ServerInit( "rust", "Rust" ) ) )
             {
                 Assert.IsTrue( server.IsValid );
                 server.LogOnAnonymous();

Facepunch.Steamworks/Server.cs

@@ -1,8 +1,5 @@
-
+using System;
-
-using System;
 using System.Collections.Generic;
-using System.Runtime.InteropServices;
 
 namespace Facepunch.Steamworks
 {
@@ -27,31 +24,17 @@ namespace Facepunch.Steamworks
         /// <summary>
         /// Initialize a Steam Server instance
         /// </summary>
-        /// <param name="appId">You game's AppId</param>
+        public Server( uint appId, ServerInit init )
-        /// <param name="IpAddress">The IP Address to bind to. Can be 0 to mean "any".</param>
-        /// <param name="SteamPort">Port to talk to steam on, can be anything as long as it's not used.".</param>
-        /// <param name="GamePort">The port you game listens to for connections.</param>
-        /// <param name="QueryPort">The port Steam should use for server queries.</param>
-        /// <param name="Secure">True if you want to use VAC</param>
-        /// <param name="VersionString">A string defining version, ie "1001"</param>
-        public Server( uint appId, uint IpAddress, ushort SteamPort, ushort GamePort, ushort QueryPort, bool Secure, string VersionString )
         {
             Instance = this;
             native = new Interop.NativeInterface();
 
-            //
+            if ( init.SteamPort == 0 ) init.RandomSteamPort();
-            // If we don't have a SteamPort defined, choose one at 'random'
-            //
-            if ( SteamPort == 0 )
-            {
-                SteamPort = (ushort) new Random().Next( 10000, 60000 );
-            }
-
 
             //
             // Get other interfaces
             //
-            if ( !native.InitServer( this, IpAddress, SteamPort, GamePort, QueryPort, Secure ? 3 : 2, VersionString ) )
+            if ( !native.InitServer( this, init.IpAddress, init.SteamPort, init.GamePort, init.QueryPort, init.Secure ? 3 : 2, init.VersionString ) )
             {
                 native.Dispose();
                 native = null;
@@ -74,7 +57,11 @@ namespace Facepunch.Steamworks
             native.gameServer.EnableHeartbeats( true );
             MaxPlayers = 32;
             BotCount = 0;
-            MapName = "unset";
+            Product = $"{AppId}";
+            ModDir = init.ModDir;
+            GameDescription = init.GameDescription;
+            Passworded = false;
+            DedicatedServer = true;
 
             //
             // Child classes
@@ -89,29 +76,6 @@ namespace Facepunch.Steamworks
             Update();
         }
 
-        /// <summary>
-        /// Initialize a Steam Server instance
-        /// </summary>
-        /// <param name="appId">You game's AppId</param>
-        /// <param name="IpAddress">The IP Address to bind to. Can be 0 to mean "any".</param>
-        /// <param name="GamePort">The port you game listens to for connections.</param>
-        /// <param name="QueryPort">The port Steam should use for server queries.</param>
-        /// <param name="Secure">True if you want to use VAC</param>
-        /// <param name="VersionString">A string defining version, ie "1001"</param>
-        public Server( uint appId, uint IpAddress, ushort GamePort, ushort QueryPort, bool Secure, string VersionString ) : this( appId, IpAddress, 0, GamePort, QueryPort, Secure, VersionString )
-        {
-            
-        }
-
-        /// <summary>
-        /// Initialize a server - query port will use the same as GamePort (MASTERSERVERUPDATERPORT_USEGAMESOCKETSHARE)
-        /// This means you'll need to detect and manually process and reply to server queries.
-        /// </summary>
-        public Server( uint appId, uint IpAddress, ushort GamePort, bool Secure, string VersionString ) : this( appId, IpAddress, GamePort, 0xFFFF, Secure, VersionString )
-        {
-            
-        }
-
         /// <summary>
         /// Should be called at least once every frame
         /// </summary>
@@ -125,6 +89,17 @@ namespace Facepunch.Steamworks
             base.Update();
         }
 
+        /// <summary>
+        /// Sets whether this should be marked as a dedicated server.
+        /// If not, it is assumed to be a listen server.
+        /// </summary>
+        public bool DedicatedServer
+        {
+            get { return _dedicatedServer; }
+            set { if ( _dedicatedServer == value ) return; native.gameServer.SetDedicatedServer( value ); _dedicatedServer = value; }
+        }
+        private bool _dedicatedServer;
+
         /// <summary>
         /// Gets or sets the current MaxPlayers. 
         /// This doesn't enforce any kind of limit, it just updates the master server.
@@ -163,17 +138,17 @@ namespace Facepunch.Steamworks
         public string ModDir
         {
             get { return _modDir; }
-            set { if ( _modDir == value ) return; native.gameServer.SetModDir( value ); _modDir = value; }
+            internal set { if ( _modDir == value ) return; native.gameServer.SetModDir( value ); _modDir = value; }
         }
         private string _modDir = "";
 
         /// <summary>
-        /// Gets or sets the current product. This isn't really used.
+        /// Gets the current product
         /// </summary>
         public string Product
         {
             get { return _product; }
-            set { if ( _product == value ) return; native.gameServer.SetProduct( value ); _product = value; }
+            internal set { if ( _product == value ) return; native.gameServer.SetProduct( value ); _product = value; }
         }
         private string _product = "";
 
@@ -183,7 +158,7 @@ namespace Facepunch.Steamworks
         public string GameDescription
         {
             get { return _gameDescription; }
-            set { if ( _gameDescription == value ) return; native.gameServer.SetGameDescription( value ); _gameDescription = value; }
+            internal set { if ( _gameDescription == value ) return; native.gameServer.SetGameDescription( value ); _gameDescription = value; }
         }
         private string _gameDescription = "";
 
@@ -224,8 +199,15 @@ namespace Facepunch.Steamworks
         public void LogOnAnonymous()
         {
             native.gameServer.LogOnAnonymous();
+            ForceHeartbeat();
         }
 
+        /// <summary>
+        /// Returns true if the server is connected and registered with the Steam master server
+        /// You should have called LogOnAnonymous etc on startup.
+        /// </summary>
+        public bool LoggedOn => native.gameServer.BLoggedOn();
+
         Dictionary<string, string> KeyValue = new Dictionary<string, string>();
 
         /// <summary>
@@ -261,14 +243,6 @@ namespace Facepunch.Steamworks
             native.gameServer.BUpdateUserData( steamid, name, (uint) score );
         }
 
-        /// <summary>
-        /// Returns true if the server is connected and registered with the Steam master server
-        /// You should have called LogOnAnonymous etc on startup.
-        /// </summary>
-        public bool LoggedOn
-        {
-            get { return native.gameServer.BLoggedOn(); }
-        }
 
         /// <summary>
         /// Shutdown interface, disconnect from Steam
@@ -314,6 +288,33 @@ namespace Facepunch.Steamworks
             }
         }
 
+        /// <summary>
+        /// Enable or disable heartbeats, which are sent regularly to the master server.
+        /// Enabled by default.
+        /// </summary>
+        public bool AutomaticHeartbeats
+        {
+            set { native.gameServer.EnableHeartbeats( value ); }
+        }
+
+        /// <summary>
+        /// Set heartbeat interval, if automatic heartbeats are enabled.
+        /// You can leave this at the default.
+        /// </summary>
+        public int AutomaticHeartbeatRate
+        {
+            set { native.gameServer.SetHeartbeatInterval( value ); }
+        }
+
+        /// <summary>
+        /// Force send a heartbeat to the master server instead of waiting
+        /// for the next automatic update (if you've left them enabled)
+        /// </summary>
+        public void ForceHeartbeat()
+        {
+            native.gameServer.ForceHeartbeat();
+        }
+
 
     }
 }

Facepunch.Steamworks/Server/ServerInit.cs

@@ -0,0 +1,67 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Runtime.InteropServices;
+using System.Text;
+
+namespace Facepunch.Steamworks
+{
+    /// <summary>
+    /// Used to set up the server. 
+    /// The variables in here are all required to be set, and can't be changed once the server is created.
+    /// </summary>
+    public class ServerInit
+    {
+        public uint IpAddress = 0;
+        public ushort SteamPort;
+        public ushort GamePort = 27015;
+        public ushort QueryPort = 27016;
+        public bool Secure = true;
+
+        /// <summary>
+        /// The version string is usually in the form x.x.x.x, and is used by the master server to detect when the server is out of date.
+        /// If you go into the dedicated server tab on steamworks you'll be able to server the latest version. If this version number is
+        /// less than that latest version then your server won't show.
+        /// </summary>
+        public string VersionString = "2.0.0.0";
+
+        /// <summary>
+        /// This should be the same directory game where gets installed into. Just the folder name, not the whole path. I.e. "Rust", "Garrysmod".
+        /// </summary>
+        public string ModDir = "unset";
+
+        /// <summary>
+        /// The game description. Setting this to the full name of your game is recommended.
+        /// </summary>
+        public string GameDescription = "unset";
+
+
+        public ServerInit( string modDir, string gameDesc )
+        {
+            ModDir = modDir;
+            GameDescription = gameDesc;
+        }
+
+        /// <summary>
+        /// Set the Steam quert port 
+        /// </summary>
+        public ServerInit RandomSteamPort()
+        {
+            SteamPort = (ushort)new Random().Next( 10000, 60000 );
+            return this;
+        }
+
+        /// <summary>
+        /// If you pass MASTERSERVERUPDATERPORT_USEGAMESOCKETSHARE into usQueryPort, then it causes the game server API to use 
+        /// "GameSocketShare" mode, which means that the game is responsible for sending and receiving UDP packets for the master
+        /// server updater.
+        /// 
+        /// More info about this here: https://partner.steamgames.com/doc/api/ISteamGameServer#HandleIncomingPacket
+        /// </summary>
+        public ServerInit QueryShareGamePort()
+        {
+            QueryPort = 0xFFFF;
+            return this;
+        }
+    }
+}