Merge pull request #113 from SeanWalsh95/unassigned-kick-patch

Edits to auto-kick-unassigned docs

README.md

@@ -213,32 +213,32 @@ The following is a list of plugins built into SquadJS, you can click their title
            <pre><code>Unassigned - automatically removed</code></pre>
 <h4>frequencyOfWarnings</h4>
            <h6>Description</h6>
-           <p>How often in seconds should we warn the player about being unassigned?</p>
+           <p>How often in <b>Seconds</b> should we warn the player about being unassigned?</p>
            <h6>Default</h6>
            <pre><code>30</code></pre>
 <h4>unassignedTimer</h4>
            <h6>Description</h6>
-           <p>How long in minutes to wait before a player that is unassigned is kicked</p>
+           <p>How long in <b>Seconds</b> to wait before a unassigned player is kicked</p>
            <h6>Default</h6>
-           <pre><code>6</code></pre>
+           <pre><code>360</code></pre>
 <h4>playerThreshold</h4>
            <h6>Description</h6>
-           <p>Player count required for AutoKick to start kicking players to disable set to -1 to disable</p>
+           <p>Player count required for AutoKick to start kicking players, set to -1 to disable</p>
            <h6>Default</h6>
            <pre><code>93</code></pre>
 <h4>roundStartDelay</h4>
            <h6>Description</h6>
-           <p>Time delay in minutes from start of the round before AutoKick starts kicking again</p>
+           <p>Time delay in <b>Seconds</b> from start of the round before AutoKick starts kicking again</p>
            <h6>Default</h6>
-           <pre><code>15</code></pre>
+           <pre><code>900</code></pre>
 <h4>ignoreAdmins</h4>
            <h6>Description</h6>
-           <p>Whether or not admins will be auto kicked for being unassigned</p>
+           <p><ul><li><code>true</code>: Admins will <b>NOT</b> be kicked</li><li><code>false</code>: Admins <b>WILL</b> be kicked</li></ul></p>
            <h6>Default</h6>
            <pre><code>false</code></pre>
 <h4>ignoreWhitelist</h4>
            <h6>Description</h6>
-           <p>Whether or not players in the whitelist will be auto kicked for being unassigned</p>
+           <p><ul><li><code>true</code>: Reserve slot players will <b>NOT</b> be kicked</li><li><code>false</code>: Reserve slot players <b>WILL</b> be kicked</li></ul></p>
            <h6>Default</h6>
            <pre><code>false</code></pre>
         </details>

config.json

@@ -71,8 +71,9 @@
       "kickMessage": "Unassigned - automatically removed",
       "frequencyOfWarnings": 30,
       "unassignedTimer": 6,
+      "unassignedTimer": 360,
       "playerThreshold": 93,
-      "roundStartDelay": 15,
+      "roundStartDelay": 900,
       "ignoreAdmins": false,
       "ignoreWhitelist": false
     },

squad-server/plugins/auto-kick-unassigned.js

@@ -26,35 +26,43 @@ export default class AutoKickUnassigned extends BasePlugin {
       },
       frequencyOfWarnings: {
         required: false,
-        description: 'How often in seconds should we warn the player about being unassigned?',
+        description:
+          'How often in <b>Seconds</b> should we warn the player about being unassigned?',
         default: 30
       },
       unassignedTimer: {
         required: false,
-        description: 'How long in minutes to wait before a player that is unassigned is kicked',
+        description: 'How long in <b>Seconds</b> to wait before a unassigned player is kicked',
-        default: 6
+        default: 360
       },
       playerThreshold: {
         required: false,
         description:
-          'Player count required for AutoKick to start kicking players to disable set to -1 to disable',
+          'Player count required for AutoKick to start kicking players, set to -1 to disable',
         default: 93
       },
       roundStartDelay: {
         required: false,
         description:
-          'Time delay in minutes from start of the round before AutoKick starts kicking again',
+          'Time delay in <b>Seconds</b> from start of the round before AutoKick starts kicking again',
-        default: 15
+        default: 900
       },
       ignoreAdmins: {
         required: false,
-        description: 'Whether or not admins will be auto kicked for being unassigned',
+        description:
+          '<ul>' +
+          '<li><code>true</code>: Admins will <b>NOT</b> be kicked</li>' +
+          '<li><code>false</code>: Admins <b>WILL</b> be kicked</li>' +
+          '</ul>',
         default: false
       },
       ignoreWhitelist: {
         required: false,
         description:
-          'Whether or not players in the whitelist will be auto kicked for being unassigned',
+          '<ul>' +
+          '<li><code>true</code>: Reserve slot players will <b>NOT</b> be kicked</li>' +
+          '<li><code>false</code>: Reserve slot players <b>WILL</b> be kicked</li>' +
+          '</ul>',
         default: false
       }
     };
@@ -77,9 +85,9 @@ export default class AutoKickUnassigned extends BasePlugin {
     this.admins = server.getAdminsWithPermission('canseeadminchat');
     this.whitelist = server.getAdminsWithPermission('reserve');
 
-    this.kickTimeout = options.unassignedTimer * 60 * 1000;
+    this.kickTimeout = options.unassignedTimer * 1000;
     this.warningInterval = options.frequencyOfWarnings * 1000;
-    this.gracePeriod = options.roundStartDelay * 60 * 1000;
+    this.gracePeriod = options.roundStartDelay * 1000;
 
     this.trackingListUpdateFrequency = 1 * 60 * 1000; // 1min
     this.cleanUpFrequency = 20 * 60 * 1000; // 20min