mirror of
https://github.com/AsgardEternal/SquadJS.git
synced 2024-09-28 17:34:25 -05:00
Build readme
This commit is contained in:
Thomas Smyth
parent
5429e92fe0
commit
5ba0b06cdc
582
README.md
582
README.md
@ -268,78 +268,107 @@ The following is a list of plugins built into SquadJS, you can click their title
|
|||||||
Interested in creating your own plugin? [See more here](./squad-server/plugins/readme.md)
|
Interested in creating your own plugin? [See more here](./squad-server/plugins/readme.md)
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
<summary>DiscordPlaceholder</summary>
|
<summary>AutoKickUnassigned</summary>
|
||||||
<h2>DiscordPlaceholder</h2>
|
<h2>AutoKickUnassigned</h2>
|
||||||
<p>The <code>DiscordPlaceholder</code> plugin allows you to make your bot create placeholder messages that can be used when configuring other plugins.</p>
|
<p>The <code>AutoKickUnassigned</code> plugin will automatically kick players that are not in a squad after a specified ammount of time.</p>
|
||||||
<h3>Options</h3>
|
<h3>Options</h3>
|
||||||
<ul><li><h4>discordClient (Required)</h4>
|
<ul><li><h4>warningMessage</h4>
|
||||||
<h6>Description</h6>
|
<h6>Description</h6>
|
||||||
<p>Discord connector name.</p>
|
<p>Message SquadJS will send to players warning them they will be kicked</p>
|
||||||
<h6>Default</h6>
|
<h6>Default</h6>
|
||||||
<pre><code>discord</code></pre></li>
|
<pre><code>Join a squad, you are are unassigned and will be kicked</code></pre></li>
|
||||||
<li><h4>command</h4>
|
<li><h4>kickMessage</h4>
|
||||||
<h6>Description</h6>
|
<h6>Description</h6>
|
||||||
<p>Command to create Discord placeholder.</p>
|
<p>Message to send to players when they are kicked</p>
|
||||||
<h6>Default</h6>
|
<h6>Default</h6>
|
||||||
<pre><code>!placeholder</code></pre></li></ul>
|
<pre><code>Unassigned - automatically removed</code></pre></li>
|
||||||
|
<li><h4>frequencyOfWarnings</h4>
|
||||||
|
<h6>Description</h6>
|
||||||
|
<p>How often in <b>Seconds</b> should we warn the player about being unassigned?</p>
|
||||||
|
<h6>Default</h6>
|
||||||
|
<pre><code>30</code></pre></li>
|
||||||
|
<li><h4>unassignedTimer</h4>
|
||||||
|
<h6>Description</h6>
|
||||||
|
<p>How long in <b>Seconds</b> to wait before a unassigned player is kicked</p>
|
||||||
|
<h6>Default</h6>
|
||||||
|
<pre><code>360</code></pre></li>
|
||||||
|
<li><h4>playerThreshold</h4>
|
||||||
|
<h6>Description</h6>
|
||||||
|
<p>Player count required for AutoKick to start kicking players, set to -1 to disable</p>
|
||||||
|
<h6>Default</h6>
|
||||||
|
<pre><code>93</code></pre></li>
|
||||||
|
<li><h4>roundStartDelay</h4>
|
||||||
|
<h6>Description</h6>
|
||||||
|
<p>Time delay in <b>Seconds</b> from start of the round before AutoKick starts kicking again</p>
|
||||||
|
<h6>Default</h6>
|
||||||
|
<pre><code>900</code></pre></li>
|
||||||
|
<li><h4>ignoreAdmins</h4>
|
||||||
|
<h6>Description</h6>
|
||||||
|
<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></li>
|
||||||
|
<li><h4>ignoreWhitelist</h4>
|
||||||
|
<h6>Description</h6>
|
||||||
|
<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></li></ul>
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
<summary>DiscordSubsystemRestarter</summary>
|
<summary>AutoTKWarn</summary>
|
||||||
<h2>DiscordSubsystemRestarter</h2>
|
<h2>AutoTKWarn</h2>
|
||||||
<p>The <code>DiscordSubSystemRestarter</code> plugin allows you to manually restart SquadJS subsystems in case an issues arises with them.<ul><li><code>!squadjs restartsubsystem rcon</code></li><li><code>!squadjs restartsubsystem logparser</code></li></ul></p>
|
<p>The <code>AutoTkWarn</code> plugin will automatically warn players with a message when they teamkill.</p>
|
||||||
<h3>Options</h3>
|
<h3>Options</h3>
|
||||||
<ul><li><h4>discordClient (Required)</h4>
|
<ul><li><h4>message</h4>
|
||||||
<h6>Description</h6>
|
<h6>Description</h6>
|
||||||
<p>Discord connector name.</p>
|
<p>The message to warn players with.</p>
|
||||||
<h6>Default</h6>
|
<h6>Default</h6>
|
||||||
<pre><code>discord</code></pre></li>
|
<pre><code>Please apologise for ALL TKs in ALL chat!</code></pre></li></ul>
|
||||||
<li><h4>role (Required)</h4>
|
|
||||||
<h6>Description</h6>
|
|
||||||
<p>ID of role required to run the sub system restart commands.</p>
|
|
||||||
<h6>Default</h6>
|
|
||||||
<pre><code></code></pre></li><h6>Example</h6>
|
|
||||||
<pre><code>667741905228136459</code></pre></ul>
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
<summary>DiscordChat</summary>
|
<summary>ChatCommands</summary>
|
||||||
<h2>DiscordChat</h2>
|
<h2>ChatCommands</h2>
|
||||||
<p>The <code>DiscordChat</code> plugin will log in-game chat to a Discord channel.</p>
|
<p>The <code>ChatCommands</code> plugin can be configured to make chat commands that broadcast or warn the caller with present messages.</p>
|
||||||
<h3>Options</h3>
|
<h3>Options</h3>
|
||||||
<ul><li><h4>discordClient (Required)</h4>
|
<ul><li><h4>commands</h4>
|
||||||
<h6>Description</h6>
|
<h6>Description</h6>
|
||||||
<p>Discord connector name.</p>
|
<p>An array of objects containing the following properties: <ul><li><code>command</code> - The command that initiates the message.</li><li><code>type</code> - Either <code>warn</code> or <code>broadcast</code>.</li><li><code>response</code> - The message to respond with.</li><li><code>ignoreChats</code> - A list of chats to ignore the commands in. Use this to limit it to admins.</li></ul></p>
|
||||||
<h6>Default</h6>
|
|
||||||
<pre><code>discord</code></pre></li>
|
|
||||||
<li><h4>channelID (Required)</h4>
|
|
||||||
<h6>Description</h6>
|
|
||||||
<p>The ID of the channel to log admin broadcasts to.</p>
|
|
||||||
<h6>Default</h6>
|
|
||||||
<pre><code></code></pre></li><h6>Example</h6>
|
|
||||||
<pre><code>667741905228136459</code></pre>
|
|
||||||
<li><h4>chatColors</h4>
|
|
||||||
<h6>Description</h6>
|
|
||||||
<p>The color of the embed for each chat.</p>
|
|
||||||
<h6>Default</h6>
|
|
||||||
<pre><code>{}</code></pre></li><h6>Example</h6>
|
|
||||||
<pre><code>{
|
|
||||||
"ChatAll": 16761867
|
|
||||||
}</code></pre>
|
|
||||||
<li><h4>color</h4>
|
|
||||||
<h6>Description</h6>
|
|
||||||
<p>The color of the embed.</p>
|
|
||||||
<h6>Default</h6>
|
|
||||||
<pre><code>16761867</code></pre></li>
|
|
||||||
<li><h4>ignoreChats</h4>
|
|
||||||
<h6>Description</h6>
|
|
||||||
<p>A list of chat names to ignore.</p>
|
|
||||||
<h6>Default</h6>
|
<h6>Default</h6>
|
||||||
<pre><code>[
|
<pre><code>[
|
||||||
"ChatSquad"
|
{
|
||||||
|
"command": "squadjs",
|
||||||
|
"type": "warn",
|
||||||
|
"response": "This server is powered by SquadJS.",
|
||||||
|
"ignoreChats": []
|
||||||
|
}
|
||||||
]</code></pre></li></ul>
|
]</code></pre></li></ul>
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>DBLog</summary>
|
||||||
|
<h2>DBLog</h2>
|
||||||
|
<p>The <code>mysql-log</code> plugin will log various server statistics and events to a database. This is great for server performance monitoring and/or player stat tracking.
|
||||||
|
|
||||||
|
Grafana (NOT YET WORKING WITH V2):
|
||||||
|
<ul><li> <a href="https://grafana.com/">Grafana</a> is a cool way of viewing server statistics stored in the database.</li>
|
||||||
|
<li>Install Grafana.</li>
|
||||||
|
<li>Add your database as a datasource named <code>SquadJS</code>.</li>
|
||||||
|
<li>Import the <a href="https://github.com/Thomas-Smyth/SquadJS/blob/master/squad-server/templates/SquadJS-Dashboard-v2.json">SquadJS Dashboard</a> to get a preconfigured MySQL only Grafana dashboard.</li>
|
||||||
|
<li>Install any missing Grafana plugins.</li></ul></p>
|
||||||
|
<h3>Options</h3>
|
||||||
|
<ul><li><h4>database (Required)</h4>
|
||||||
|
<h6>Description</h6>
|
||||||
|
<p>The Sequelize connector to log server information to.</p>
|
||||||
|
<h6>Default</h6>
|
||||||
|
<pre><code>mysql</code></pre></li>
|
||||||
|
<li><h4>overrideServerID</h4>
|
||||||
|
<h6>Description</h6>
|
||||||
|
<p>A overridden server ID.</p>
|
||||||
|
<h6>Default</h6>
|
||||||
|
<pre><code>null</code></pre></li></ul>
|
||||||
|
</details>
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
<summary>DiscordAdminBroadcast</summary>
|
<summary>DiscordAdminBroadcast</summary>
|
||||||
<h2>DiscordAdminBroadcast</h2>
|
<h2>DiscordAdminBroadcast</h2>
|
||||||
@ -363,6 +392,29 @@ Interested in creating your own plugin? [See more here](./squad-server/plugins/r
|
|||||||
<pre><code>16761867</code></pre></li></ul>
|
<pre><code>16761867</code></pre></li></ul>
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>DiscordAdminCamLogs</summary>
|
||||||
|
<h2>DiscordAdminCamLogs</h2>
|
||||||
|
<p>The <code>DiscordAdminCamLogs</code> plugin will log in game admin camera usage to a Discord channel.</p>
|
||||||
|
<h3>Options</h3>
|
||||||
|
<ul><li><h4>discordClient (Required)</h4>
|
||||||
|
<h6>Description</h6>
|
||||||
|
<p>Discord connector name.</p>
|
||||||
|
<h6>Default</h6>
|
||||||
|
<pre><code>discord</code></pre></li>
|
||||||
|
<li><h4>channelID (Required)</h4>
|
||||||
|
<h6>Description</h6>
|
||||||
|
<p>The ID of the channel to log admin camera usage to.</p>
|
||||||
|
<h6>Default</h6>
|
||||||
|
<pre><code></code></pre></li><h6>Example</h6>
|
||||||
|
<pre><code>667741905228136459</code></pre>
|
||||||
|
<li><h4>color</h4>
|
||||||
|
<h6>Description</h6>
|
||||||
|
<p>The color of the embed.</p>
|
||||||
|
<h6>Default</h6>
|
||||||
|
<pre><code>16761867</code></pre></li></ul>
|
||||||
|
</details>
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
<summary>DiscordAdminRequest</summary>
|
<summary>DiscordAdminRequest</summary>
|
||||||
<h2>DiscordAdminRequest</h2>
|
<h2>DiscordAdminRequest</h2>
|
||||||
@ -420,6 +472,145 @@ Interested in creating your own plugin? [See more here](./squad-server/plugins/r
|
|||||||
<pre><code>16761867</code></pre></li></ul>
|
<pre><code>16761867</code></pre></li></ul>
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>DiscordChat</summary>
|
||||||
|
<h2>DiscordChat</h2>
|
||||||
|
<p>The <code>DiscordChat</code> plugin will log in-game chat to a Discord channel.</p>
|
||||||
|
<h3>Options</h3>
|
||||||
|
<ul><li><h4>discordClient (Required)</h4>
|
||||||
|
<h6>Description</h6>
|
||||||
|
<p>Discord connector name.</p>
|
||||||
|
<h6>Default</h6>
|
||||||
|
<pre><code>discord</code></pre></li>
|
||||||
|
<li><h4>channelID (Required)</h4>
|
||||||
|
<h6>Description</h6>
|
||||||
|
<p>The ID of the channel to log admin broadcasts to.</p>
|
||||||
|
<h6>Default</h6>
|
||||||
|
<pre><code></code></pre></li><h6>Example</h6>
|
||||||
|
<pre><code>667741905228136459</code></pre>
|
||||||
|
<li><h4>chatColors</h4>
|
||||||
|
<h6>Description</h6>
|
||||||
|
<p>The color of the embed for each chat.</p>
|
||||||
|
<h6>Default</h6>
|
||||||
|
<pre><code>{}</code></pre></li><h6>Example</h6>
|
||||||
|
<pre><code>{
|
||||||
|
"ChatAll": 16761867
|
||||||
|
}</code></pre>
|
||||||
|
<li><h4>color</h4>
|
||||||
|
<h6>Description</h6>
|
||||||
|
<p>The color of the embed.</p>
|
||||||
|
<h6>Default</h6>
|
||||||
|
<pre><code>16761867</code></pre></li>
|
||||||
|
<li><h4>ignoreChats</h4>
|
||||||
|
<h6>Description</h6>
|
||||||
|
<p>A list of chat names to ignore.</p>
|
||||||
|
<h6>Default</h6>
|
||||||
|
<pre><code>[
|
||||||
|
"ChatSquad"
|
||||||
|
]</code></pre></li></ul>
|
||||||
|
</details>
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>DiscordDebug</summary>
|
||||||
|
<h2>DiscordDebug</h2>
|
||||||
|
<p>The <code>DiscordDebug</code> plugin can be used to help debug SquadJS by dumping SquadJS events to a Discord channel.</p>
|
||||||
|
<h3>Options</h3>
|
||||||
|
<ul><li><h4>discordClient (Required)</h4>
|
||||||
|
<h6>Description</h6>
|
||||||
|
<p>Discord connector name.</p>
|
||||||
|
<h6>Default</h6>
|
||||||
|
<pre><code>discord</code></pre></li>
|
||||||
|
<li><h4>channelID (Required)</h4>
|
||||||
|
<h6>Description</h6>
|
||||||
|
<p>The ID of the channel to log events to.</p>
|
||||||
|
<h6>Default</h6>
|
||||||
|
<pre><code></code></pre></li><h6>Example</h6>
|
||||||
|
<pre><code>667741905228136459</code></pre>
|
||||||
|
<li><h4>events (Required)</h4>
|
||||||
|
<h6>Description</h6>
|
||||||
|
<p>A list of events to dump.</p>
|
||||||
|
<h6>Default</h6>
|
||||||
|
<pre><code>[]</code></pre></li><h6>Example</h6>
|
||||||
|
<pre><code>[
|
||||||
|
"PLAYER_DIED"
|
||||||
|
]</code></pre></ul>
|
||||||
|
</details>
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>DiscordPlaceholder</summary>
|
||||||
|
<h2>DiscordPlaceholder</h2>
|
||||||
|
<p>The <code>DiscordPlaceholder</code> plugin allows you to make your bot create placeholder messages that can be used when configuring other plugins.</p>
|
||||||
|
<h3>Options</h3>
|
||||||
|
<ul><li><h4>discordClient (Required)</h4>
|
||||||
|
<h6>Description</h6>
|
||||||
|
<p>Discord connector name.</p>
|
||||||
|
<h6>Default</h6>
|
||||||
|
<pre><code>discord</code></pre></li>
|
||||||
|
<li><h4>command</h4>
|
||||||
|
<h6>Description</h6>
|
||||||
|
<p>Command to create Discord placeholder.</p>
|
||||||
|
<h6>Default</h6>
|
||||||
|
<pre><code>!placeholder</code></pre></li></ul>
|
||||||
|
</details>
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>DiscordRcon</summary>
|
||||||
|
<h2>DiscordRcon</h2>
|
||||||
|
<p>The <code>DiscordRcon</code> plugin allows a specified Discord channel to be used as a RCON console to run RCON commands.</p>
|
||||||
|
<h3>Options</h3>
|
||||||
|
<ul><li><h4>discordClient (Required)</h4>
|
||||||
|
<h6>Description</h6>
|
||||||
|
<p>Discord connector name.</p>
|
||||||
|
<h6>Default</h6>
|
||||||
|
<pre><code>discord</code></pre></li>
|
||||||
|
<li><h4>channelID (Required)</h4>
|
||||||
|
<h6>Description</h6>
|
||||||
|
<p>ID of channel to turn into RCON console.</p>
|
||||||
|
<h6>Default</h6>
|
||||||
|
<pre><code></code></pre></li><h6>Example</h6>
|
||||||
|
<pre><code>667741905228136459</code></pre>
|
||||||
|
<li><h4>permissions</h4>
|
||||||
|
<h6>Description</h6>
|
||||||
|
<p><ul><li>Dictionary of roles and a list of the permissions they are allowed to use.<li>If dictionary is empty (<code>{}</code>) permissions will be disabled</li><li>A list of available RCON commands can be found here <a>https://squad.gamepedia.com/Server_Administration#Admin_Console_Commands</a>.</ul></p>
|
||||||
|
<h6>Default</h6>
|
||||||
|
<pre><code>{}</code></pre></li><h6>Example</h6>
|
||||||
|
<pre><code>{
|
||||||
|
"123456789123456789": [
|
||||||
|
"AdminBroadcast",
|
||||||
|
"AdminForceTeamChange",
|
||||||
|
"AdminDemoteCommander"
|
||||||
|
]
|
||||||
|
}</code></pre>
|
||||||
|
<li><h4>prependAdminNameInBroadcast</h4>
|
||||||
|
<h6>Description</h6>
|
||||||
|
<p>Prepend admin names when making announcements.</p>
|
||||||
|
<h6>Default</h6>
|
||||||
|
<pre><code>false</code></pre></li></ul>
|
||||||
|
</details>
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>DiscordRoundWinner</summary>
|
||||||
|
<h2>DiscordRoundWinner</h2>
|
||||||
|
<p>The <code>DiscordRoundWinner</code> plugin will send the round winner to a Discord channel.</p>
|
||||||
|
<h3>Options</h3>
|
||||||
|
<ul><li><h4>discordClient (Required)</h4>
|
||||||
|
<h6>Description</h6>
|
||||||
|
<p>Discord connector name.</p>
|
||||||
|
<h6>Default</h6>
|
||||||
|
<pre><code>discord</code></pre></li>
|
||||||
|
<li><h4>channelID (Required)</h4>
|
||||||
|
<h6>Description</h6>
|
||||||
|
<p>The ID of the channel to log admin broadcasts to.</p>
|
||||||
|
<h6>Default</h6>
|
||||||
|
<pre><code></code></pre></li><h6>Example</h6>
|
||||||
|
<pre><code>667741905228136459</code></pre>
|
||||||
|
<li><h4>color</h4>
|
||||||
|
<h6>Description</h6>
|
||||||
|
<p>The color of the embed.</p>
|
||||||
|
<h6>Default</h6>
|
||||||
|
<pre><code>16761867</code></pre></li></ul>
|
||||||
|
</details>
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
<summary>DiscordServerStatus</summary>
|
<summary>DiscordServerStatus</summary>
|
||||||
<h2>DiscordServerStatus</h2>
|
<h2>DiscordServerStatus</h2>
|
||||||
@ -454,96 +645,21 @@ Interested in creating your own plugin? [See more here](./squad-server/plugins/r
|
|||||||
</details>
|
</details>
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
<summary>AutoKickUnassigned</summary>
|
<summary>DiscordSubsystemRestarter</summary>
|
||||||
<h2>AutoKickUnassigned</h2>
|
<h2>DiscordSubsystemRestarter</h2>
|
||||||
<p>The <code>AutoKickUnassigned</code> plugin will automatically kick players that are not in a squad after a specified ammount of time.</p>
|
<p>The <code>DiscordSubSystemRestarter</code> plugin allows you to manually restart SquadJS subsystems in case an issues arises with them.<ul><li><code>!squadjs restartsubsystem rcon</code></li><li><code>!squadjs restartsubsystem logparser</code></li></ul></p>
|
||||||
<h3>Options</h3>
|
|
||||||
<ul><li><h4>warningMessage</h4>
|
|
||||||
<h6>Description</h6>
|
|
||||||
<p>Message SquadJS will send to players warning them they will be kicked</p>
|
|
||||||
<h6>Default</h6>
|
|
||||||
<pre><code>Join a squad, you are are unassigned and will be kicked</code></pre></li>
|
|
||||||
<li><h4>kickMessage</h4>
|
|
||||||
<h6>Description</h6>
|
|
||||||
<p>Message to send to players when they are kicked</p>
|
|
||||||
<h6>Default</h6>
|
|
||||||
<pre><code>Unassigned - automatically removed</code></pre></li>
|
|
||||||
<li><h4>frequencyOfWarnings</h4>
|
|
||||||
<h6>Description</h6>
|
|
||||||
<p>How often in <b>Seconds</b> should we warn the player about being unassigned?</p>
|
|
||||||
<h6>Default</h6>
|
|
||||||
<pre><code>30</code></pre></li>
|
|
||||||
<li><h4>unassignedTimer</h4>
|
|
||||||
<h6>Description</h6>
|
|
||||||
<p>How long in <b>Seconds</b> to wait before a unassigned player is kicked</p>
|
|
||||||
<h6>Default</h6>
|
|
||||||
<pre><code>360</code></pre></li>
|
|
||||||
<li><h4>playerThreshold</h4>
|
|
||||||
<h6>Description</h6>
|
|
||||||
<p>Player count required for AutoKick to start kicking players, set to -1 to disable</p>
|
|
||||||
<h6>Default</h6>
|
|
||||||
<pre><code>93</code></pre></li>
|
|
||||||
<li><h4>roundStartDelay</h4>
|
|
||||||
<h6>Description</h6>
|
|
||||||
<p>Time delay in <b>Seconds</b> from start of the round before AutoKick starts kicking again</p>
|
|
||||||
<h6>Default</h6>
|
|
||||||
<pre><code>900</code></pre></li>
|
|
||||||
<li><h4>ignoreAdmins</h4>
|
|
||||||
<h6>Description</h6>
|
|
||||||
<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></li>
|
|
||||||
<li><h4>ignoreWhitelist</h4>
|
|
||||||
<h6>Description</h6>
|
|
||||||
<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></li></ul>
|
|
||||||
</details>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>DiscordDebug</summary>
|
|
||||||
<h2>DiscordDebug</h2>
|
|
||||||
<p>The <code>DiscordDebug</code> plugin can be used to help debug SquadJS by dumping SquadJS events to a Discord channel.</p>
|
|
||||||
<h3>Options</h3>
|
<h3>Options</h3>
|
||||||
<ul><li><h4>discordClient (Required)</h4>
|
<ul><li><h4>discordClient (Required)</h4>
|
||||||
<h6>Description</h6>
|
<h6>Description</h6>
|
||||||
<p>Discord connector name.</p>
|
<p>Discord connector name.</p>
|
||||||
<h6>Default</h6>
|
<h6>Default</h6>
|
||||||
<pre><code>discord</code></pre></li>
|
<pre><code>discord</code></pre></li>
|
||||||
<li><h4>channelID (Required)</h4>
|
<li><h4>role (Required)</h4>
|
||||||
<h6>Description</h6>
|
<h6>Description</h6>
|
||||||
<p>The ID of the channel to log events to.</p>
|
<p>ID of role required to run the sub system restart commands.</p>
|
||||||
<h6>Default</h6>
|
<h6>Default</h6>
|
||||||
<pre><code></code></pre></li><h6>Example</h6>
|
<pre><code></code></pre></li><h6>Example</h6>
|
||||||
<pre><code>667741905228136459</code></pre>
|
<pre><code>667741905228136459</code></pre></ul>
|
||||||
<li><h4>events (Required)</h4>
|
|
||||||
<h6>Description</h6>
|
|
||||||
<p>A list of events to dump.</p>
|
|
||||||
<h6>Default</h6>
|
|
||||||
<pre><code>[]</code></pre></li><h6>Example</h6>
|
|
||||||
<pre><code>[
|
|
||||||
"PLAYER_DIED"
|
|
||||||
]</code></pre></ul>
|
|
||||||
</details>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>IntervalledBroadcasts</summary>
|
|
||||||
<h2>IntervalledBroadcasts</h2>
|
|
||||||
<p>The <code>IntervalledBroadcasts</code> plugin allows you to set broadcasts, which will be broadcasted at preset intervals</p>
|
|
||||||
<h3>Options</h3>
|
|
||||||
<ul><li><h4>broadcasts</h4>
|
|
||||||
<h6>Description</h6>
|
|
||||||
<p>Messages to broadcast.</p>
|
|
||||||
<h6>Default</h6>
|
|
||||||
<pre><code>[]</code></pre></li><h6>Example</h6>
|
|
||||||
<pre><code>[
|
|
||||||
"This server is powered by SquadJS."
|
|
||||||
]</code></pre>
|
|
||||||
<li><h4>interval</h4>
|
|
||||||
<h6>Description</h6>
|
|
||||||
<p>Frequency of the broadcasts in milliseconds.</p>
|
|
||||||
<h6>Default</h6>
|
|
||||||
<pre><code>300000</code></pre></li></ul>
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
@ -574,6 +690,49 @@ Interested in creating your own plugin? [See more here](./squad-server/plugins/r
|
|||||||
<pre><code>false</code></pre></li></ul>
|
<pre><code>false</code></pre></li></ul>
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>IntervalledBroadcasts</summary>
|
||||||
|
<h2>IntervalledBroadcasts</h2>
|
||||||
|
<p>The <code>IntervalledBroadcasts</code> plugin allows you to set broadcasts, which will be broadcasted at preset intervals</p>
|
||||||
|
<h3>Options</h3>
|
||||||
|
<ul><li><h4>broadcasts</h4>
|
||||||
|
<h6>Description</h6>
|
||||||
|
<p>Messages to broadcast.</p>
|
||||||
|
<h6>Default</h6>
|
||||||
|
<pre><code>[]</code></pre></li><h6>Example</h6>
|
||||||
|
<pre><code>[
|
||||||
|
"This server is powered by SquadJS."
|
||||||
|
]</code></pre>
|
||||||
|
<li><h4>interval</h4>
|
||||||
|
<h6>Description</h6>
|
||||||
|
<p>Frequency of the broadcasts in milliseconds.</p>
|
||||||
|
<h6>Default</h6>
|
||||||
|
<pre><code>300000</code></pre></li></ul>
|
||||||
|
</details>
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>SCBLInfo</summary>
|
||||||
|
<h2>SCBLInfo</h2>
|
||||||
|
<p>The <code>SCBLInfo</code> plugin alerts admins when a harmful player is detected joining their server based on data from the <a href="https://squad-community-ban-list.com/">Squad Community Ban List</a>.</p>
|
||||||
|
<h3>Options</h3>
|
||||||
|
<ul><li><h4>discordClient (Required)</h4>
|
||||||
|
<h6>Description</h6>
|
||||||
|
<p>Discord connector name.</p>
|
||||||
|
<h6>Default</h6>
|
||||||
|
<pre><code>discord</code></pre></li>
|
||||||
|
<li><h4>channelID (Required)</h4>
|
||||||
|
<h6>Description</h6>
|
||||||
|
<p>The ID of the channel to alert admins through.</p>
|
||||||
|
<h6>Default</h6>
|
||||||
|
<pre><code></code></pre></li><h6>Example</h6>
|
||||||
|
<pre><code>667741905228136459</code></pre>
|
||||||
|
<li><h4>threshold</h4>
|
||||||
|
<h6>Description</h6>
|
||||||
|
<p>Admins will be alerted when a player has this or more reputation points. For more information on reputation points, see the <a href="https://squad-community-ban-list.com/faq">Squad Community Ban List's FAQ</a></p>
|
||||||
|
<h6>Default</h6>
|
||||||
|
<pre><code>6</code></pre></li></ul>
|
||||||
|
</details>
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
<summary>SeedingMode</summary>
|
<summary>SeedingMode</summary>
|
||||||
<h2>SeedingMode</h2>
|
<h2>SeedingMode</h2>
|
||||||
@ -611,142 +770,6 @@ Interested in creating your own plugin? [See more here](./squad-server/plugins/r
|
|||||||
<pre><code>Live!</code></pre></li></ul>
|
<pre><code>Live!</code></pre></li></ul>
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>AutoTKWarn</summary>
|
|
||||||
<h2>AutoTKWarn</h2>
|
|
||||||
<p>The <code>AutoTkWarn</code> plugin will automatically warn players with a message when they teamkill.</p>
|
|
||||||
<h3>Options</h3>
|
|
||||||
<ul><li><h4>message</h4>
|
|
||||||
<h6>Description</h6>
|
|
||||||
<p>The message to warn players with.</p>
|
|
||||||
<h6>Default</h6>
|
|
||||||
<pre><code>Please apologise for ALL TKs in ALL chat!</code></pre></li></ul>
|
|
||||||
</details>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>DBLog</summary>
|
|
||||||
<h2>DBLog</h2>
|
|
||||||
<p>The <code>mysql-log</code> plugin will log various server statistics and events to a database. This is great for server performance monitoring and/or player stat tracking.
|
|
||||||
|
|
||||||
Grafana (NOT YET WORKING WITH V2):
|
|
||||||
<ul><li> <a href="https://grafana.com/">Grafana</a> is a cool way of viewing server statistics stored in the database.</li>
|
|
||||||
<li>Install Grafana.</li>
|
|
||||||
<li>Add your database as a datasource named <code>SquadJS</code>.</li>
|
|
||||||
<li>Import the <a href="https://github.com/Thomas-Smyth/SquadJS/blob/master/squad-server/templates/SquadJS-Dashboard-v2.json">SquadJS Dashboard</a> to get a preconfigured MySQL only Grafana dashboard.</li>
|
|
||||||
<li>Install any missing Grafana plugins.</li></ul></p>
|
|
||||||
<h3>Options</h3>
|
|
||||||
<ul><li><h4>database (Required)</h4>
|
|
||||||
<h6>Description</h6>
|
|
||||||
<p>The Sequelize connector to log server information to.</p>
|
|
||||||
<h6>Default</h6>
|
|
||||||
<pre><code>mysql</code></pre></li>
|
|
||||||
<li><h4>overrideServerID</h4>
|
|
||||||
<h6>Description</h6>
|
|
||||||
<p>A overridden server ID.</p>
|
|
||||||
<h6>Default</h6>
|
|
||||||
<pre><code>null</code></pre></li></ul>
|
|
||||||
</details>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>DiscordRoundWinner</summary>
|
|
||||||
<h2>DiscordRoundWinner</h2>
|
|
||||||
<p>The <code>DiscordRoundWinner</code> plugin will send the round winner to a Discord channel.</p>
|
|
||||||
<h3>Options</h3>
|
|
||||||
<ul><li><h4>discordClient (Required)</h4>
|
|
||||||
<h6>Description</h6>
|
|
||||||
<p>Discord connector name.</p>
|
|
||||||
<h6>Default</h6>
|
|
||||||
<pre><code>discord</code></pre></li>
|
|
||||||
<li><h4>channelID (Required)</h4>
|
|
||||||
<h6>Description</h6>
|
|
||||||
<p>The ID of the channel to log admin broadcasts to.</p>
|
|
||||||
<h6>Default</h6>
|
|
||||||
<pre><code></code></pre></li><h6>Example</h6>
|
|
||||||
<pre><code>667741905228136459</code></pre>
|
|
||||||
<li><h4>color</h4>
|
|
||||||
<h6>Description</h6>
|
|
||||||
<p>The color of the embed.</p>
|
|
||||||
<h6>Default</h6>
|
|
||||||
<pre><code>16761867</code></pre></li></ul>
|
|
||||||
</details>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>ChatCommands</summary>
|
|
||||||
<h2>ChatCommands</h2>
|
|
||||||
<p>The <code>ChatCommands</code> plugin can be configured to make chat commands that broadcast or warn the caller with present messages.</p>
|
|
||||||
<h3>Options</h3>
|
|
||||||
<ul><li><h4>commands</h4>
|
|
||||||
<h6>Description</h6>
|
|
||||||
<p>An array of objects containing the following properties: <ul><li><code>command</code> - The command that initiates the message.</li><li><code>type</code> - Either <code>warn</code> or <code>broadcast</code>.</li><li><code>response</code> - The message to respond with.</li><li><code>ignoreChats</code> - A list of chats to ignore the commands in. Use this to limit it to admins.</li></ul></p>
|
|
||||||
<h6>Default</h6>
|
|
||||||
<pre><code>[
|
|
||||||
{
|
|
||||||
"command": "squadjs",
|
|
||||||
"type": "warn",
|
|
||||||
"response": "This server is powered by SquadJS.",
|
|
||||||
"ignoreChats": []
|
|
||||||
}
|
|
||||||
]</code></pre></li></ul>
|
|
||||||
</details>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>DiscordAdminCamLogs</summary>
|
|
||||||
<h2>DiscordAdminCamLogs</h2>
|
|
||||||
<p>The <code>DiscordAdminCamLogs</code> plugin will log in game admin camera usage to a Discord channel.</p>
|
|
||||||
<h3>Options</h3>
|
|
||||||
<ul><li><h4>discordClient (Required)</h4>
|
|
||||||
<h6>Description</h6>
|
|
||||||
<p>Discord connector name.</p>
|
|
||||||
<h6>Default</h6>
|
|
||||||
<pre><code>discord</code></pre></li>
|
|
||||||
<li><h4>channelID (Required)</h4>
|
|
||||||
<h6>Description</h6>
|
|
||||||
<p>The ID of the channel to log admin camera usage to.</p>
|
|
||||||
<h6>Default</h6>
|
|
||||||
<pre><code></code></pre></li><h6>Example</h6>
|
|
||||||
<pre><code>667741905228136459</code></pre>
|
|
||||||
<li><h4>color</h4>
|
|
||||||
<h6>Description</h6>
|
|
||||||
<p>The color of the embed.</p>
|
|
||||||
<h6>Default</h6>
|
|
||||||
<pre><code>16761867</code></pre></li></ul>
|
|
||||||
</details>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>DiscordRcon</summary>
|
|
||||||
<h2>DiscordRcon</h2>
|
|
||||||
<p>The <code>DiscordRcon</code> plugin allows a specified Discord channel to be used as a RCON console to run RCON commands.</p>
|
|
||||||
<h3>Options</h3>
|
|
||||||
<ul><li><h4>discordClient (Required)</h4>
|
|
||||||
<h6>Description</h6>
|
|
||||||
<p>Discord connector name.</p>
|
|
||||||
<h6>Default</h6>
|
|
||||||
<pre><code>discord</code></pre></li>
|
|
||||||
<li><h4>channelID (Required)</h4>
|
|
||||||
<h6>Description</h6>
|
|
||||||
<p>ID of channel to turn into RCON console.</p>
|
|
||||||
<h6>Default</h6>
|
|
||||||
<pre><code></code></pre></li><h6>Example</h6>
|
|
||||||
<pre><code>667741905228136459</code></pre>
|
|
||||||
<li><h4>permissions</h4>
|
|
||||||
<h6>Description</h6>
|
|
||||||
<p><ul><li>Dictionary of roles and a list of the permissions they are allowed to use.<li>If dictionary is empty (<code>{}</code>) permissions will be disabled</li><li>A list of available RCON commands can be found here <a>https://squad.gamepedia.com/Server_Administration#Admin_Console_Commands</a>.</ul></p>
|
|
||||||
<h6>Default</h6>
|
|
||||||
<pre><code>{}</code></pre></li><h6>Example</h6>
|
|
||||||
<pre><code>{
|
|
||||||
"123456789123456789": [
|
|
||||||
"AdminBroadcast",
|
|
||||||
"AdminForceTeamChange",
|
|
||||||
"AdminDemoteCommander"
|
|
||||||
]
|
|
||||||
}</code></pre>
|
|
||||||
<li><h4>prependAdminNameInBroadcast</h4>
|
|
||||||
<h6>Description</h6>
|
|
||||||
<p>Prepend admin names when making announcements.</p>
|
|
||||||
<h6>Default</h6>
|
|
||||||
<pre><code>false</code></pre></li></ul>
|
|
||||||
</details>
|
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
<summary>TeamRandomizer</summary>
|
<summary>TeamRandomizer</summary>
|
||||||
<h2>TeamRandomizer</h2>
|
<h2>TeamRandomizer</h2>
|
||||||
@ -759,29 +782,6 @@ Grafana (NOT YET WORKING WITH V2):
|
|||||||
<pre><code>randomize</code></pre></li></ul>
|
<pre><code>randomize</code></pre></li></ul>
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>SCBLInfo</summary>
|
|
||||||
<h2>SCBLInfo</h2>
|
|
||||||
<p>The <code>SCBLInfo</code> plugin alerts admins when a harmful player is detected joining their server based on data from the <a href="https://squad-community-ban-list.com/">Squad Community Ban List</a>.</p>
|
|
||||||
<h3>Options</h3>
|
|
||||||
<ul><li><h4>discordClient (Required)</h4>
|
|
||||||
<h6>Description</h6>
|
|
||||||
<p>Discord connector name.</p>
|
|
||||||
<h6>Default</h6>
|
|
||||||
<pre><code>discord</code></pre></li>
|
|
||||||
<li><h4>channelID (Required)</h4>
|
|
||||||
<h6>Description</h6>
|
|
||||||
<p>The ID of the channel to alert admins through.</p>
|
|
||||||
<h6>Default</h6>
|
|
||||||
<pre><code></code></pre></li><h6>Example</h6>
|
|
||||||
<pre><code>667741905228136459</code></pre>
|
|
||||||
<li><h4>threshold</h4>
|
|
||||||
<h6>Description</h6>
|
|
||||||
<p>Admins will be alerted when a player has this or more reputation points. For more information on reputation points, see the <a href="https://squad-community-ban-list.com/faq">Squad Community Ban List's FAQ</a></p>
|
|
||||||
<h6>Default</h6>
|
|
||||||
<pre><code>6</code></pre></li></ul>
|
|
||||||
</details>
|
|
||||||
|
|
||||||
<br>
|
<br>
|
||||||
|
|
||||||
## Statement on Accuracy
|
## Statement on Accuracy
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user