Updated readme.md

jweigelt · jweigelt · commit f16bd6ea3794 · 2018-02-18T20:31:22.000+01:00
Fixed default permissions
Fixed web panel: max/min players (fields were in wrong order)
diff --git a/DebugFiles/web/game.htm b/DebugFiles/web/game.htm
@@ -92,7 +92,7 @@ <h2>Game Settings</h2>
         
         <tr class="runtime"><th>Assign to player</th><td>
         <select id="game_select_hero_player">
-          <!--TODO: figure values out-->
+          <!--TODO: figure out values-->
           <option value="1">most points</option>
           <option value="2">most kills</option>
           <option value="3">most deaths</option>                  
diff --git a/DebugFiles/web/res/general.js b/DebugFiles/web/res/general.js
@@ -54,8 +54,8 @@ function General() {
                 GameName: $("#general_input_session_name").val(),
                 Password: $("#general_input_password").val(),
                 AdminPw: $("#general_input_admin_password").val(),
-                PlayerCount: $("#general_input_max_players").val(),
-                PlayerLimit: $("#general_input_min_players").val(),
+                PlayerCount: $("#general_input_min_players").val(),
+                PlayerLimit: $("#general_input_max_players").val(),
                 Tps: $("#general_input_tps").val(),
                 IP: $("#general_select_ipa").val(),
                 GamePort: $("#general_input_gameport").val(),
@@ -84,8 +84,8 @@ function General() {
         $("#general_input_session_name").val(s.GameName);
         $("#general_input_password").val(s.Password);
         $("#general_input_admin_password").val(s.AdminPw);
-        $("#general_input_max_players").val(s.PlayerCount);
-        $("#general_input_min_players").val(s.PlayerLimit);
+        $("#general_input_min_players").val(s.PlayerCount);
+        $("#general_input_max_players").val(s.PlayerLimit);
         $("#general_input_tps").val(s.Tps);
         $("#general_select_ipa").val(s.IP);
         $("#general_input_gameport").val(s.GamePort);
diff --git a/SWBF2Admin/Database/SQLHandler.cs b/SWBF2Admin/Database/SQLHandler.cs
@@ -356,8 +356,8 @@ public PlayerGroup GetPlayerGroup(string name)
                         RL(reader, "group_level"),
                         RS(reader, "group_name"),
                         RS(reader, "group_welcome"),
+                         RS(reader, "group_welcome_new"),
                         (RL(reader, "group_welcome_enable") == 1));
-
                 }
             }
             return null;
@@ -376,6 +376,7 @@ public PlayerGroup GetTopGroup()
                         RL(reader, "group_level"),
                         RS(reader, "group_name"),
                         RS(reader, "group_welcome"),
+                        RS(reader, "group_welcome_new"),
                         (RL(reader, "group_welcome_enable") == 1));
 
                 }
@@ -392,6 +393,7 @@ private PlayerGroup ReadGroup(DbDataReader reader)
                      RL(reader, "group_level"),
                      RS(reader, "group_name"),
                      RS(reader, "group_welcome"),
+                     RS(reader, "group_welcome_new"),
                      (RL(reader, "group_welcome_enable") == 1));
             }
             return null;
@@ -400,12 +402,7 @@ private PlayerGroup ReadGroup(DbDataReader reader)
         private PlayerGroup GetDefaultGroup()
         {
             string sql =
-               "SELECT " +
-                   "id, " +
-                   "group_name, " +
-                   "group_welcome, " +
-                   "group_level, " +
-                   "group_welcome_enable " + 
+               "SELECT * " + 
                "FROM " +
                    "prefix_groups " +
                "WHERE group_default = 1";
@@ -420,13 +417,7 @@ private PlayerGroup GetDefaultGroup()
         public PlayerGroup GetTopGroup(Player player)
         {
             string sql =
-                "SELECT " +
-                    "group_name, " +
-                    "group_welcome, " +
-                    "group_level, " +
-                    "group_welcome_enable, " +
-                    "player_id, " +
-                    "prefix_groups.id " +
+                "SELECT * " +
                 "FROM " +
                     "prefix_players_groups " +
                 "INNER JOIN prefix_groups ON prefix_players_groups.group_id = prefix_groups.id " +
@@ -436,19 +427,20 @@ public PlayerGroup GetTopGroup(Player player)
             using (DbDataReader reader = Query(sql, "@player_id", player.DatabaseId))
             {
                 PlayerGroup group = ReadGroup(reader);
-                if (group == null) {
+                if (group == null)
+                {
                     PlayerGroup defaultGroup = GetDefaultGroup();
-                    if(defaultGroup != null) AddPlayerGroup(player, defaultGroup);
+                    if (defaultGroup != null) AddPlayerGroup(player, defaultGroup);
                     return defaultGroup;
                 }
                 return group;
             }
         }
 
-        public bool NoPlayerGroups()
+        public bool GroupEmpty(PlayerGroup group)
         {
-            string sql = "SELECT id FROM prefix_players_groups";
-            return !(HasRows(Query(sql)));
+            string sql = "SELECT id FROM prefix_players_groups where group_id = @group_id";
+            return !(HasRows(Query(sql, "@group_id", group.Id)));
         }
 
         public bool IsGroupMember(Player player, PlayerGroup group)
diff --git a/SWBF2Admin/Gameserver/IngameServerControllerConfiguration.cs b/SWBF2Admin/Gameserver/IngameServerControllerConfiguration.cs
@@ -25,13 +25,13 @@ namespace SWBF2Admin.Gameserver
     public class IngameServerControllerConfiguration
     {
         public int TcpTimeout { get; set; } = 100;
-        public int StartupTime { get; set; } = 30000;
+        public int StartupTime { get; set; } = 60000;
         public int NotRespondingCheckInterval { get; set; } = 5000;
         public int NotRespondingMaxCount { get; set; } = 2;
         public int ReadTimeout { get; set; } = 100;
         public int MapHangTimeout { get; set; } = 20000;
-        public int FreezeTime { get; set; } = 1000;
-        public int FreezesBeforeKill { get; set; } = 10;
+        public int FreezeTime { get; set; } = 6000;
+        public int FreezesBeforeKill { get; set; } = 5;
         public int RdpCloseDelay {get; set;} = 2000;
 
         public string ServerHostname { get; set; } = "127.0.0.1:1138";
@@ -42,8 +42,8 @@ public virtual IPEndPoint ServerIPEP
             get
             {
                 string[] cc = ServerHostname.Split(':');
-                return new IPEndPoint(IPAddress.Parse(cc[0]), (cc.Length > 1 ? int.Parse(cc[1]) : 4658));
+                return new IPEndPoint(IPAddress.Parse(cc[0]), (cc.Length > 1 ? int.Parse(cc[1]) : 1138));
             }
         }
     }
-}
+}
diff --git a/SWBF2Admin/Runtime/Commands/Admin/CmdBan.cs b/SWBF2Admin/Runtime/Commands/Admin/CmdBan.cs
@@ -23,7 +23,6 @@ namespace SWBF2Admin.Runtime.Commands.Admin
     [ConfigFileInfo(fileName: "./cfg/cmd/ban.xml"/*, template: "SWBF2Admin.Resources.cfg.cmd.ban.xml"*/)]
     public class CmdBan : PlayerCommand
     {
-
         public string OnBan { get; set; } = "{player} was banned by {admin}";
         public string OnBanReason { get; set; } = "{player} was kicked by {admin} for {reason}";
         public CmdBan() : base("ban", "ban") { }
diff --git a/SWBF2Admin/Runtime/Commands/ChatCommand.cs b/SWBF2Admin/Runtime/Commands/ChatCommand.cs
@@ -77,7 +77,6 @@ protected void SendFormatted(string message, Player player, params string[] tags
             if (player == null) Core.Rcon.Say(message); else Core.Rcon.Pm(message, player);
         }
 
-
         public virtual bool HasPermission(Player player)
         {
             return Core.Database.HasPermission(player, Permission);
diff --git a/SWBF2Admin/Runtime/Commands/Permissions/CmdGimmeAdmin.cs b/SWBF2Admin/Runtime/Commands/Permissions/CmdGimmeAdmin.cs
@@ -46,7 +46,7 @@ public override bool Run(Player player, string commandLine, string[] parameters)
 
         public override bool HasPermission(Player player)
         {
-            return Core.Database.NoPlayerGroups();
+            return Core.Database.GroupEmpty(Core.Database.GetTopGroup());
         }
     }
 }
diff --git a/SWBF2Admin/Runtime/Players/PlayerHandler.cs b/SWBF2Admin/Runtime/Players/PlayerHandler.cs
@@ -95,7 +95,6 @@ protected override void OnUpdate()
 
                 playerList = plp.PlayerList;
             }
-
         }
 
         /// <summary>
@@ -126,7 +125,15 @@ private void OnNewPlayerJoin(Player p)
             }
             else
             {
-                if ((p.MainGroup != null) && p.MainGroup.EnableWelcome) Core.Rcon.Say(Util.FormatString(p.MainGroup.WelcomeMessage, "{player}", p.Name, "{group}", p.MainGroup.Name, "{joined}", p.TotalVisits.ToString()));
+                if ((p.MainGroup != null) && p.MainGroup.EnableWelcome)
+                {
+                    Core.Rcon.Say(Util.FormatString(
+                      ((p.TotalVisits == 1) ? p.MainGroup.NewWelcomeMessage : p.MainGroup.WelcomeMessage),
+                     "{player}", p.Name,
+                     "{group}", p.MainGroup.Name,
+                     "{joined}", p.TotalVisits.ToString(),
+                     "{id}", p.DatabaseId.ToString()));
+                }
             }
         }
 
diff --git a/SWBF2Admin/Scheduler/SchedulerTask.cs b/SWBF2Admin/Scheduler/SchedulerTask.cs
@@ -38,7 +38,7 @@ public void Run()
             }
             catch (Exception e)
             {
-                Logger.Log(LogLevel.Warning, "Failed to run task {0}::{1} ({2})", task.Target.ToString(), task.Method.Name, e.Message);
+                Logger.Log(LogLevel.Warning, "Failed to run task {0}::{1} ({2})", task.Target.ToString(), task.Method.Name, e.ToString());
             }
         }
     }
diff --git a/SWBF2Admin/Structures/PlayerGroup.cs b/SWBF2Admin/Structures/PlayerGroup.cs
@@ -25,14 +25,16 @@ public class PlayerGroup
         public long Level { get; }
         public string Name { get; }
         public string WelcomeMessage { get; }
+        public string NewWelcomeMessage { get; }
         public bool EnableWelcome { get; }
 
-        public PlayerGroup(long id, long level, string name, string welcomeMessage, bool enableWelcome)
+        public PlayerGroup(long id, long level, string name, string welcomeMessage, string newWelcomeMessage, bool enableWelcome)
         {
             Id = id;
             Level = level;
             Name = name;
             WelcomeMessage = welcomeMessage;
+            NewWelcomeMessage = newWelcomeMessage;
             EnableWelcome = enableWelcome;
         }
     }
diff --git a/SWBF2Admin/Web/WebServer.cs b/SWBF2Admin/Web/WebServer.cs
@@ -217,9 +217,8 @@ private void HandleContext(HttpListenerContext ctx)
         private WebUser CheckAuth(HttpListenerContext ctx)
         {
             HttpListenerBasicIdentity identity = (HttpListenerBasicIdentity)ctx.User.Identity;
-            WebUser user = null;
 
-            if (authCache.TryGetValue(identity.Name, out user))
+            if (authCache.TryGetValue(identity.Name, out WebUser user))
             {
                 if (!Util.Md5(identity.Password).Equals(user.PasswordHash))
                 {
diff --git a/readme.md b/readme.md
@@ -2,7 +2,7 @@
 
 A modern, easy-to-use server manager for Star Wars Battlefront II (2005) dedicated servers
 
-## Getting Started (SWBFSpy)
+## Getting Started
 
 These instructions will get you a minimal SWBF2Admin setup up and running.
 SWBF2Admin is highly configurable - if you're interested in customizing your SWBF2Admin installation, please also check out "Advanced configuration" for further information.
@@ -29,7 +29,7 @@ If you want to host a Steam (GoG) server:
 - Right click the game in your steam library, set launch options to /autonet /win /nointro <map name (e.g tat2g_eli)>
 - Download dedicated server files from http://www.moddb.com/games/star-wars-battlefront-ii/downloads/star-wars-battlefront-ii-v11-dedicated-server
 - Copy the data folder from the dedicated server installation to your SWBF2 installation. Replace all files except shell.lvl!
-- If you're running Windows server: enable sound backend
+- Copy the contents of the GameData folder that came with SWBF2Admin to your server's GameData folder
 
 ### Minimal setup
 
@@ -38,12 +38,19 @@ Extract all files to a folder of your choice
 - OR run SWBF2Admin.exe once, close it again, open core.xml, set  <ServerPath> to the (absolute) path to your server installation
 
 - If you want to host a Steam Server: open core.xml, set SteamMode
+```xml
+<SteamMode>true</SteamMode>
 ```
-<SteamMode>true</SteamMode
+
+- If you want to enable ingame commands / player list / web chat etc.: set EnableRuntime
+```xml
+<EnableRuntime>true</EnableRuntime>
 ```
 
 - Run SWBF2Admin.exe
-- You'll be asked to enter credentials you'll need to access the web panel later on. Enter credentials of your choice.
+- You will be asked to enter credentials which will be used to access the web panel later on. Enter credentials of your choice.
+- Access the web panel and start your server (see Using the web panel)
+- Join your server and enter !gimmeadmin in chat
 
 ### Steam ingame server sustainer
 
@@ -52,19 +59,19 @@ to keep it from crashing.
 
 - Create an additional account on your server machine
 - log in to your new account
-- Run Remote Desktop and connect to your gameserver account, save user name and password
+- Run Remote Desktop and connect to your gameserver account, save user name and password.
 - Get IngameControllerServer.exe from your SWBF2Admin installation, run it and leave it open
 
 IngameControllerServer.exe does not have to be located in the SWBF2Admin installation folder,
-so you can move it to a new location if you want.
+so you can move it to a new location if you like.
 
 ## Using the web panel
 
 ### Accessing the panel
 By default, your web panel's URL is set to http://localhost:8080/ and can only be accessed locally.
 If you want to access your panel from a remote computer, you can adjust the panel's URL in ./cfg/core.xml.
 
-```
+```xml
 <WebAdminPrefix>http://localhost:8080/</WebAdminPrefix>
 ```
 
@@ -157,6 +164,14 @@ If you chose create or edit, a dialog box will open which lets you edit the user
 Notes:
 - The delete option won't appear for your own account
 
+## Ingame commands
+
+### Getting permissions
+
+After you freshly installed SWBF2Admin, join your server and enter !gimmeadmin in chat. This will add your player account to the Administrator group.
+
+TODO
+
 ## Authors
 
 This project was written by Jan "LeKeks" Weigelt (https://github.com/jweigelt) and Yoni (https://github.com/yonilerner).
@@ -182,7 +197,7 @@ Open ./cfg/announce.xml
 You can now add as many announces as you like to the "AnnounceList" attribute.
 Announces must have the following format:
 
-```
+```xml
 <Announce EnableParser="true/false" Message="YourMessage"/>
 ```
 
@@ -218,7 +233,7 @@ Replace (format) with a format string.
 The given formatter has to be a .NET-style format string. (see https://docs.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings)
 
 Example for a broadcast displaying the current time in HH:mm:ss format:
-```
+```xml
 <Announce EnableParser="true" Message="Current time {t:HH:mm:ss}"/>
 ```
 
@@ -240,7 +255,7 @@ Create an empty XML and LUA file in that folder. Rename both files so their name
 
 Use the following template for your XML file:
 
-```
+```xml
 <?xml version="1.0" encoding="utf-8"?>
 <DynamicCommand xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <Enabled>true</Enabled>
@@ -259,7 +274,7 @@ Usage: A small explanation on how to use your command
 UserConfig: You can add custom child nodes to UserConfig to configure your command. These can later be accessed by LUA.
 
 Copy the following template to your LUA file:
-```
+```lua
 function init()
 
 end

Original file line number	Diff line number	Diff line change
`@@ -25,13 +25,13 @@ namespace SWBF2Admin.Gameserver`
`25`	`25`	`public class IngameServerControllerConfiguration`
`26`	`26`	`{`
`27`	`27`	`public int TcpTimeout { get; set; } = 100;`
`28`		`- public int StartupTime { get; set; } = 30000;`
	`28`	`+ public int StartupTime { get; set; } = 60000;`
`29`	`29`	`public int NotRespondingCheckInterval { get; set; } = 5000;`
`30`	`30`	`public int NotRespondingMaxCount { get; set; } = 2;`
`31`	`31`	`public int ReadTimeout { get; set; } = 100;`
`32`	`32`	`public int MapHangTimeout { get; set; } = 20000;`
`33`		`- public int FreezeTime { get; set; } = 1000;`
`34`		`- public int FreezesBeforeKill { get; set; } = 10;`
	`33`	`+ public int FreezeTime { get; set; } = 6000;`
	`34`	`+ public int FreezesBeforeKill { get; set; } = 5;`
`35`	`35`	`public int RdpCloseDelay {get; set;} = 2000;`
`36`	`36`
`37`	`37`	`public string ServerHostname { get; set; } = "127.0.0.1:1138";`
`@@ -42,8 +42,8 @@ public virtual IPEndPoint ServerIPEP`
`42`	`42`	`get`
`43`	`43`	`{`
`44`	`44`	`string[] cc = ServerHostname.Split(':');`
`45`		`- return new IPEndPoint(IPAddress.Parse(cc[0]), (cc.Length > 1 ? int.Parse(cc[1]) : 4658));`
	`45`	`+ return new IPEndPoint(IPAddress.Parse(cc[0]), (cc.Length > 1 ? int.Parse(cc[1]) : 1138));`
`46`	`46`	`}`
`47`	`47`	`}`
`48`	`48`	`}`
`49`		`-}`
	`49`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,6 @@ namespace SWBF2Admin.Runtime.Commands.Admin`
`23`	`23`	`[ConfigFileInfo(fileName: "./cfg/cmd/ban.xml"/, template: "SWBF2Admin.Resources.cfg.cmd.ban.xml"/)]`
`24`	`24`	`public class CmdBan : PlayerCommand`
`25`	`25`	`{`
`26`		`-`
`27`	`26`	`public string OnBan { get; set; } = "{player} was banned by {admin}";`
`28`	`27`	`public string OnBanReason { get; set; } = "{player} was kicked by {admin} for {reason}";`
`29`	`28`	`public CmdBan() : base("ban", "ban") { }`
Original file line number	Diff line number	Diff line change
`@@ -77,7 +77,6 @@ protected void SendFormatted(string message, Player player, params string[] tags`
`77`	`77`	`if (player == null) Core.Rcon.Say(message); else Core.Rcon.Pm(message, player);`
`78`	`78`	`}`
`79`	`79`
`80`		`-`
`81`	`80`	`public virtual bool HasPermission(Player player)`
`82`	`81`	`{`
`83`	`82`	`return Core.Database.HasPermission(player, Permission);`
Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,7 @@ public override bool Run(Player player, string commandLine, string[] parameters)`
`46`	`46`
`47`	`47`	`public override bool HasPermission(Player player)`
`48`	`48`	`{`
`49`		`- return Core.Database.NoPlayerGroups();`
	`49`	`+ return Core.Database.GroupEmpty(Core.Database.GetTopGroup());`
`50`	`50`	`}`
`51`	`51`	`}`
`52`	`52`	`}`
Original file line number	Diff line number	Diff line change
`@@ -95,7 +95,6 @@ protected override void OnUpdate()`
`95`	`95`
`96`	`96`	`playerList = plp.PlayerList;`
`97`	`97`	`}`
`98`		`-`
`99`	`98`	`}`
`100`	`99`
`101`	`100`	`/// <summary>`
`@@ -126,7 +125,15 @@ private void OnNewPlayerJoin(Player p)`
`126`	`125`	`}`
`127`	`126`	`else`
`128`	`127`	`{`
`129`		`- if ((p.MainGroup != null) && p.MainGroup.EnableWelcome) Core.Rcon.Say(Util.FormatString(p.MainGroup.WelcomeMessage, "{player}", p.Name, "{group}", p.MainGroup.Name, "{joined}", p.TotalVisits.ToString()));`
	`128`	`+ if ((p.MainGroup != null) && p.MainGroup.EnableWelcome)`
	`129`	`+ {`
	`130`	`+ Core.Rcon.Say(Util.FormatString(`
	`131`	`+ ((p.TotalVisits == 1) ? p.MainGroup.NewWelcomeMessage : p.MainGroup.WelcomeMessage),`
	`132`	`+ "{player}", p.Name,`
	`133`	`+ "{group}", p.MainGroup.Name,`
	`134`	`+ "{joined}", p.TotalVisits.ToString(),`
	`135`	`+ "{id}", p.DatabaseId.ToString()));`
	`136`	`+ }`
`130`	`137`	`}`
`131`	`138`	`}`
`132`	`139`
Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ public void Run()`
`38`	`38`	`}`
`39`	`39`	`catch (Exception e)`
`40`	`40`	`{`
`41`		`- Logger.Log(LogLevel.Warning, "Failed to run task {0}::{1} ({2})", task.Target.ToString(), task.Method.Name, e.Message);`
	`41`	`+ Logger.Log(LogLevel.Warning, "Failed to run task {0}::{1} ({2})", task.Target.ToString(), task.Method.Name, e.ToString());`
`42`	`42`	`}`
`43`	`43`	`}`
`44`	`44`	`}`
Original file line number	Diff line number	Diff line change
`@@ -25,14 +25,16 @@ public class PlayerGroup`
`25`	`25`	`public long Level { get; }`
`26`	`26`	`public string Name { get; }`
`27`	`27`	`public string WelcomeMessage { get; }`
	`28`	`+ public string NewWelcomeMessage { get; }`
`28`	`29`	`public bool EnableWelcome { get; }`
`29`	`30`
`30`		`- public PlayerGroup(long id, long level, string name, string welcomeMessage, bool enableWelcome)`
	`31`	`+ public PlayerGroup(long id, long level, string name, string welcomeMessage, string newWelcomeMessage, bool enableWelcome)`
`31`	`32`	`{`
`32`	`33`	`Id = id;`
`33`	`34`	`Level = level;`
`34`	`35`	`Name = name;`
`35`	`36`	`WelcomeMessage = welcomeMessage;`
	`37`	`+ NewWelcomeMessage = newWelcomeMessage;`
`36`	`38`	`EnableWelcome = enableWelcome;`
`37`	`39`	`}`
`38`	`40`	`}`