mirror of
https://github.com/AsgardEternal/SquadJS.git
synced 2024-09-28 14:04:25 -05:00
yarn build
This commit is contained in:
SeanWalsh95
parent
6ad552b7b0
commit
46217a4a63
682
README.md
682
README.md
@ -187,74 +187,84 @@ Plugin options are also specified. A full list of plugin options can be seen bel
|
||||
The following is a list of plugins built into SquadJS, you can click their title for more information:
|
||||
|
||||
<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>
|
||||
<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>
|
||||
</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>
|
||||
<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>
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>AutoKickUnassigned</summary>
|
||||
<h2>AutoKickUnassigned</h2>
|
||||
<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>
|
||||
<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>
|
||||
<summary>AutoKickUnassigned</summary>
|
||||
<h2>AutoKickUnassigned</h2>
|
||||
<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>
|
||||
<h4>adminList (Required)</h4>
|
||||
<h6>Description</h6>
|
||||
<p>List of server admins.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>remoteAdminLists</code></pre>
|
||||
<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>
|
||||
<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>
|
||||
<h6>Description</h6>
|
||||
<p>Message to send to players when they are kicked</p>
|
||||
<h6>Default</h6>
|
||||
<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>
|
||||
<h6>Default</h6>
|
||||
<pre><code>30</code></pre>
|
||||
<h6>Description</h6>
|
||||
<p>How often in seconds 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>
|
||||
<h6>Default</h6>
|
||||
<pre><code>6</code></pre>
|
||||
<h6>Description</h6>
|
||||
<p>How long in minutes to wait before a player that is unassigned is kicked</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>6</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>
|
||||
<h6>Default</h6>
|
||||
<pre><code>93</code></pre>
|
||||
<h6>Description</h6>
|
||||
<p>Player count required for AutoKick to start kicking players to disable set to -1 to disable</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>93</code></pre>
|
||||
<h4>queueThreshold</h4>
|
||||
<h6>Description</h6>
|
||||
<p>The number of players in the queue before AutoKick starts kicking players set to -1 to disable</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>-1</code></pre>
|
||||
<h6>Description</h6>
|
||||
<p>The number of players in the queue before AutoKick starts kicking players set to -1 to disable</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>-1</code></pre>
|
||||
<h4>roundStartDelay</h4>
|
||||
<h6>Description</h6>
|
||||
<p>Time delay in minutes from start of the round before AutoKick starts kicking again</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>15</code></pre>
|
||||
<h6>Description</h6>
|
||||
<p>Time delay in minutes from start of the round before AutoKick starts kicking again</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>15</code></pre>
|
||||
<h4>ignoreAdmins</h4>
|
||||
<h6>Description</h6>
|
||||
<p>Whether or not admins will be auto kicked for being unassigned</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>false</code></pre>
|
||||
</details>
|
||||
<h6>Description</h6>
|
||||
<p>Whether or not admins will be auto kicked for being unassigned</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>
|
||||
<h6>Default</h6>
|
||||
<pre><code>false</code></pre>
|
||||
</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>
|
||||
<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>[
|
||||
<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>
|
||||
<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",
|
||||
@ -262,214 +272,214 @@ The following is a list of plugins built into SquadJS, you can click their title
|
||||
"ignoreChats": []
|
||||
}
|
||||
]</code></pre>
|
||||
</details>
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>DiscordAdminBroadcast</summary>
|
||||
<h2>DiscordAdminBroadcast</h2>
|
||||
<p>The <code>DiscordAdminBroadcast</code> plugin will send a copy of admin broadcasts made in game to a Discord channel.</p>
|
||||
<h3>Options</h3>
|
||||
<h4>discordClient (Required)</h4>
|
||||
<h6>Description</h6>
|
||||
<p>Discord connector name.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>discord</code></pre>
|
||||
<summary>DiscordAdminBroadcast</summary>
|
||||
<h2>DiscordAdminBroadcast</h2>
|
||||
<p>The <code>DiscordAdminBroadcast</code> plugin will send a copy of admin broadcasts made in game to a Discord channel.</p>
|
||||
<h3>Options</h3>
|
||||
<h4>discordClient (Required)</h4>
|
||||
<h6>Description</h6>
|
||||
<p>Discord connector name.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>discord</code></pre>
|
||||
<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><h6>Example</h6>
|
||||
<pre><code>667741905228136459</code></pre>
|
||||
<h6>Description</h6>
|
||||
<p>The ID of the channel to log admin broadcasts to.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code></code></pre><h6>Example</h6>
|
||||
<pre><code>667741905228136459</code></pre>
|
||||
<h4>color</h4>
|
||||
<h6>Description</h6>
|
||||
<p>The color of the embed.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>16761867</code></pre>
|
||||
</details>
|
||||
<h6>Description</h6>
|
||||
<p>The color of the embed.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>16761867</code></pre>
|
||||
</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>
|
||||
<h4>discordClient (Required)</h4>
|
||||
<h6>Description</h6>
|
||||
<p>Discord connector name.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>discord</code></pre>
|
||||
<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>
|
||||
<h4>discordClient (Required)</h4>
|
||||
<h6>Description</h6>
|
||||
<p>Discord connector name.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>discord</code></pre>
|
||||
<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><h6>Example</h6>
|
||||
<pre><code>667741905228136459</code></pre>
|
||||
<h6>Description</h6>
|
||||
<p>The ID of the channel to log admin camera usage to.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code></code></pre><h6>Example</h6>
|
||||
<pre><code>667741905228136459</code></pre>
|
||||
<h4>color</h4>
|
||||
<h6>Description</h6>
|
||||
<p>The color of the embed.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>16761867</code></pre>
|
||||
</details>
|
||||
<h6>Description</h6>
|
||||
<p>The color of the embed.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>16761867</code></pre>
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>DiscordAdminRequest</summary>
|
||||
<h2>DiscordAdminRequest</h2>
|
||||
<p>The <code>DiscordAdminRequest</code> plugin will ping admins in a Discord channel when a player requests an admin via the <code>!admin</code> command in in-game chat.</p>
|
||||
<h3>Options</h3>
|
||||
<h4>discordClient (Required)</h4>
|
||||
<h6>Description</h6>
|
||||
<p>Discord connector name.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>discord</code></pre>
|
||||
<summary>DiscordAdminRequest</summary>
|
||||
<h2>DiscordAdminRequest</h2>
|
||||
<p>The <code>DiscordAdminRequest</code> plugin will ping admins in a Discord channel when a player requests an admin via the <code>!admin</code> command in in-game chat.</p>
|
||||
<h3>Options</h3>
|
||||
<h4>discordClient (Required)</h4>
|
||||
<h6>Description</h6>
|
||||
<p>Discord connector name.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>discord</code></pre>
|
||||
<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><h6>Example</h6>
|
||||
<pre><code>667741905228136459</code></pre>
|
||||
<h6>Description</h6>
|
||||
<p>The ID of the channel to log admin broadcasts to.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code></code></pre><h6>Example</h6>
|
||||
<pre><code>667741905228136459</code></pre>
|
||||
<h4>ignoreChats</h4>
|
||||
<h6>Description</h6>
|
||||
<p>A list of chat names to ignore.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>[]</code></pre><h6>Example</h6>
|
||||
<pre><code>[
|
||||
<h6>Description</h6>
|
||||
<p>A list of chat names to ignore.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>[]</code></pre><h6>Example</h6>
|
||||
<pre><code>[
|
||||
"ChatSquad"
|
||||
]</code></pre>
|
||||
<h4>ignorePhrases</h4>
|
||||
<h6>Description</h6>
|
||||
<p>A list of phrases to ignore.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>[]</code></pre><h6>Example</h6>
|
||||
<pre><code>[
|
||||
<h6>Description</h6>
|
||||
<p>A list of phrases to ignore.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>[]</code></pre><h6>Example</h6>
|
||||
<pre><code>[
|
||||
"switch"
|
||||
]</code></pre>
|
||||
<h4>command</h4>
|
||||
<h6>Description</h6>
|
||||
<p>The command that calls an admin.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>admin</code></pre>
|
||||
<h6>Description</h6>
|
||||
<p>The command that calls an admin.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>admin</code></pre>
|
||||
<h4>pingGroups</h4>
|
||||
<h6>Description</h6>
|
||||
<p>A list of Discord role IDs to ping.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>[]</code></pre><h6>Example</h6>
|
||||
<pre><code>[
|
||||
<h6>Description</h6>
|
||||
<p>A list of Discord role IDs to ping.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>[]</code></pre><h6>Example</h6>
|
||||
<pre><code>[
|
||||
"500455137626554379"
|
||||
]</code></pre>
|
||||
<h4>pingDelay</h4>
|
||||
<h6>Description</h6>
|
||||
<p>Cooldown for pings in milliseconds.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>60000</code></pre>
|
||||
<h6>Description</h6>
|
||||
<p>Cooldown for pings in milliseconds.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>60000</code></pre>
|
||||
<h4>color</h4>
|
||||
<h6>Description</h6>
|
||||
<p>The color of the embed.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>16761867</code></pre>
|
||||
</details>
|
||||
<h6>Description</h6>
|
||||
<p>The color of the embed.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>16761867</code></pre>
|
||||
</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>
|
||||
<h4>discordClient (Required)</h4>
|
||||
<h6>Description</h6>
|
||||
<p>Discord connector name.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>discord</code></pre>
|
||||
<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>
|
||||
<h4>discordClient (Required)</h4>
|
||||
<h6>Description</h6>
|
||||
<p>Discord connector name.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>discord</code></pre>
|
||||
<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><h6>Example</h6>
|
||||
<pre><code>667741905228136459</code></pre>
|
||||
<h6>Description</h6>
|
||||
<p>The ID of the channel to log admin broadcasts to.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code></code></pre><h6>Example</h6>
|
||||
<pre><code>667741905228136459</code></pre>
|
||||
<h4>chatColors</h4>
|
||||
<h6>Description</h6>
|
||||
<p>The color of the embed for each chat.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>{}</code></pre><h6>Example</h6>
|
||||
<pre><code>{
|
||||
<h6>Description</h6>
|
||||
<p>The color of the embed for each chat.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>{}</code></pre><h6>Example</h6>
|
||||
<pre><code>{
|
||||
"ChatAll": 16761867
|
||||
}</code></pre>
|
||||
<h4>color</h4>
|
||||
<h6>Description</h6>
|
||||
<p>The color of the embed.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>16761867</code></pre>
|
||||
<h6>Description</h6>
|
||||
<p>The color of the embed.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>16761867</code></pre>
|
||||
<h4>ignoreChats</h4>
|
||||
<h6>Description</h6>
|
||||
<p>A list of chat names to ignore.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>[
|
||||
<h6>Description</h6>
|
||||
<p>A list of chat names to ignore.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>[
|
||||
"ChatSquad"
|
||||
]</code></pre>
|
||||
</details>
|
||||
</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>
|
||||
<h4>discordClient (Required)</h4>
|
||||
<h6>Description</h6>
|
||||
<p>Discord connector name.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>discord</code></pre>
|
||||
<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>
|
||||
<h4>discordClient (Required)</h4>
|
||||
<h6>Description</h6>
|
||||
<p>Discord connector name.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>discord</code></pre>
|
||||
<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><h6>Example</h6>
|
||||
<pre><code>667741905228136459</code></pre>
|
||||
<h6>Description</h6>
|
||||
<p>The ID of the channel to log events to.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code></code></pre><h6>Example</h6>
|
||||
<pre><code>667741905228136459</code></pre>
|
||||
<h4>events (Required)</h4>
|
||||
<h6>Description</h6>
|
||||
<p>A list of events to dump.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>[]</code></pre><h6>Example</h6>
|
||||
<pre><code>[
|
||||
<h6>Description</h6>
|
||||
<p>A list of events to dump.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>[]</code></pre><h6>Example</h6>
|
||||
<pre><code>[
|
||||
"PLAYER_DIED"
|
||||
]</code></pre>
|
||||
</details>
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>DiscordPlaceholder</summary>
|
||||
<h2>DiscordPlaceholder</h2>
|
||||
<p>The <code>DiscordPlaceholder</code> plugin can be used to create placeholder messages in Discord for use by other plugins.</p>
|
||||
<h3>Options</h3>
|
||||
<h4>discordClient (Required)</h4>
|
||||
<h6>Description</h6>
|
||||
<p>Discord connector name.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>discord</code></pre>
|
||||
<summary>DiscordPlaceholder</summary>
|
||||
<h2>DiscordPlaceholder</h2>
|
||||
<p>The <code>DiscordPlaceholder</code> plugin can be used to create placeholder messages in Discord for use by other plugins.</p>
|
||||
<h3>Options</h3>
|
||||
<h4>discordClient (Required)</h4>
|
||||
<h6>Description</h6>
|
||||
<p>Discord connector name.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>discord</code></pre>
|
||||
<h4>command</h4>
|
||||
<h6>Description</h6>
|
||||
<p>Command that triggers the placeholder message.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>!placeholder</code></pre>
|
||||
</details>
|
||||
<h6>Description</h6>
|
||||
<p>Command that triggers the placeholder message.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>!placeholder</code></pre>
|
||||
</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>
|
||||
<h4>discordClient (Required)</h4>
|
||||
<h6>Description</h6>
|
||||
<p>Discord connector name.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>discord</code></pre>
|
||||
<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>
|
||||
<h4>discordClient (Required)</h4>
|
||||
<h6>Description</h6>
|
||||
<p>Discord connector name.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>discord</code></pre>
|
||||
<h4>channelID (Required)</h4>
|
||||
<h6>Description</h6>
|
||||
<p>ID of channel to turn into RCON console.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code></code></pre><h6>Example</h6>
|
||||
<pre><code>667741905228136459</code></pre>
|
||||
<h6>Description</h6>
|
||||
<p>ID of channel to turn into RCON console.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code></code></pre><h6>Example</h6>
|
||||
<pre><code>667741905228136459</code></pre>
|
||||
<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><h6>Example</h6>
|
||||
<pre><code>{
|
||||
<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><h6>Example</h6>
|
||||
<pre><code>{
|
||||
"123456789123456789": [
|
||||
"AdminBroadcast",
|
||||
"AdminForceTeamChange",
|
||||
@ -477,154 +487,154 @@ The following is a list of plugins built into SquadJS, you can click their title
|
||||
]
|
||||
}</code></pre>
|
||||
<h4>prependAdminNameInBroadcast</h4>
|
||||
<h6>Description</h6>
|
||||
<p>Prepend admin names when making announcements.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>false</code></pre>
|
||||
</details>
|
||||
<h6>Description</h6>
|
||||
<p>Prepend admin names when making announcements.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>false</code></pre>
|
||||
</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>
|
||||
<h4>discordClient (Required)</h4>
|
||||
<h6>Description</h6>
|
||||
<p>Discord connector name.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>discord</code></pre>
|
||||
<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>
|
||||
<h4>discordClient (Required)</h4>
|
||||
<h6>Description</h6>
|
||||
<p>Discord connector name.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>discord</code></pre>
|
||||
<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><h6>Example</h6>
|
||||
<pre><code>667741905228136459</code></pre>
|
||||
<h6>Description</h6>
|
||||
<p>The ID of the channel to log admin broadcasts to.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code></code></pre><h6>Example</h6>
|
||||
<pre><code>667741905228136459</code></pre>
|
||||
<h4>color</h4>
|
||||
<h6>Description</h6>
|
||||
<p>The color of the embed.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>16761867</code></pre>
|
||||
</details>
|
||||
<h6>Description</h6>
|
||||
<p>The color of the embed.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>16761867</code></pre>
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>DiscordServerStatus</summary>
|
||||
<h2>DiscordServerStatus</h2>
|
||||
<p>The <code>DiscordServerStatus</code> plugin updates a message in Discord with current server information, e.g. player count.</p>
|
||||
<h3>Options</h3>
|
||||
<h4>discordClient (Required)</h4>
|
||||
<h6>Description</h6>
|
||||
<p>Discord connector name.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>discord</code></pre>
|
||||
<summary>DiscordServerStatus</summary>
|
||||
<h2>DiscordServerStatus</h2>
|
||||
<p>The <code>DiscordServerStatus</code> plugin updates a message in Discord with current server information, e.g. player count.</p>
|
||||
<h3>Options</h3>
|
||||
<h4>discordClient (Required)</h4>
|
||||
<h6>Description</h6>
|
||||
<p>Discord connector name.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>discord</code></pre>
|
||||
<h4>messageIDs (Required)</h4>
|
||||
<h6>Description</h6>
|
||||
<p>ID of messages to update.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>[]</code></pre><h6>Example</h6>
|
||||
<pre><code>[
|
||||
<h6>Description</h6>
|
||||
<p>ID of messages to update.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>[]</code></pre><h6>Example</h6>
|
||||
<pre><code>[
|
||||
{
|
||||
"channelID": "667741905228136459",
|
||||
"messageID": "766688383043895387"
|
||||
}
|
||||
]</code></pre>
|
||||
<h4>updateInterval</h4>
|
||||
<h6>Description</h6>
|
||||
<p>How frequently to update the status in Discord.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>60000</code></pre>
|
||||
<h6>Description</h6>
|
||||
<p>How frequently to update the status in Discord.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>60000</code></pre>
|
||||
<h4>disableStatus</h4>
|
||||
<h6>Description</h6>
|
||||
<p>Disable the bot status.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>false</code></pre>
|
||||
</details>
|
||||
<h6>Description</h6>
|
||||
<p>Disable the bot status.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>false</code></pre>
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>DiscordSubsystemRestarter</summary>
|
||||
<h2>DiscordSubsystemRestarter</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>
|
||||
<h3>Options</h3>
|
||||
<h4>discordClient (Required)</h4>
|
||||
<h6>Description</h6>
|
||||
<p>Discord connector name.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>discord</code></pre>
|
||||
<summary>DiscordSubsystemRestarter</summary>
|
||||
<h2>DiscordSubsystemRestarter</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>
|
||||
<h3>Options</h3>
|
||||
<h4>discordClient (Required)</h4>
|
||||
<h6>Description</h6>
|
||||
<p>Discord connector name.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>discord</code></pre>
|
||||
<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><h6>Example</h6>
|
||||
<pre><code>667741905228136459</code></pre>
|
||||
</details>
|
||||
<h6>Description</h6>
|
||||
<p>ID of role required to run the sub system restart commands.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code></code></pre><h6>Example</h6>
|
||||
<pre><code>667741905228136459</code></pre>
|
||||
</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>
|
||||
<h4>broadcasts</h4>
|
||||
<h6>Description</h6>
|
||||
<p>Messages to broadcast.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>[]</code></pre><h6>Example</h6>
|
||||
<pre><code>[
|
||||
<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>
|
||||
<h4>broadcasts</h4>
|
||||
<h6>Description</h6>
|
||||
<p>Messages to broadcast.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>[]</code></pre><h6>Example</h6>
|
||||
<pre><code>[
|
||||
"This server is powered by SquadJS."
|
||||
]</code></pre>
|
||||
<h4>interval</h4>
|
||||
<h6>Description</h6>
|
||||
<p>Frequency of the broadcasts in milliseconds.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>300000</code></pre>
|
||||
</details>
|
||||
<h6>Description</h6>
|
||||
<p>Frequency of the broadcasts in milliseconds.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>300000</code></pre>
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>SeedingMode</summary>
|
||||
<h2>SeedingMode</h2>
|
||||
<p>The <code>SeedingMode</code> plugin broadcasts seeding rule messages to players at regular intervals when the server is below a specified player count. It can also be configured to display "Live" messages when the server goes live.</p>
|
||||
<h3>Options</h3>
|
||||
<h4>interval</h4>
|
||||
<h6>Description</h6>
|
||||
<p>Frequency of seeding messages in milliseconds.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>150000</code></pre>
|
||||
<summary>SeedingMode</summary>
|
||||
<h2>SeedingMode</h2>
|
||||
<p>The <code>SeedingMode</code> plugin broadcasts seeding rule messages to players at regular intervals when the server is below a specified player count. It can also be configured to display "Live" messages when the server goes live.</p>
|
||||
<h3>Options</h3>
|
||||
<h4>interval</h4>
|
||||
<h6>Description</h6>
|
||||
<p>Frequency of seeding messages in milliseconds.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>150000</code></pre>
|
||||
<h4>seedingThreshold</h4>
|
||||
<h6>Description</h6>
|
||||
<p>Player count required for server not to be in seeding mode.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>50</code></pre>
|
||||
<h6>Description</h6>
|
||||
<p>Player count required for server not to be in seeding mode.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>50</code></pre>
|
||||
<h4>seedingMessage</h4>
|
||||
<h6>Description</h6>
|
||||
<p>Seeding message to display.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>Seeding Rules Active! Fight only over the middle flags! No FOB Hunting!</code></pre>
|
||||
<h6>Description</h6>
|
||||
<p>Seeding message to display.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>Seeding Rules Active! Fight only over the middle flags! No FOB Hunting!</code></pre>
|
||||
<h4>liveEnabled</h4>
|
||||
<h6>Description</h6>
|
||||
<p>Enable "Live" messages for when the server goes live.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>true</code></pre>
|
||||
<h6>Description</h6>
|
||||
<p>Enable "Live" messages for when the server goes live.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>true</code></pre>
|
||||
<h4>liveThreshold</h4>
|
||||
<h6>Description</h6>
|
||||
<p>Player count required for "Live" messages to not bee displayed.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>52</code></pre>
|
||||
<h6>Description</h6>
|
||||
<p>Player count required for "Live" messages to not bee displayed.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>52</code></pre>
|
||||
<h4>liveMessage</h4>
|
||||
<h6>Description</h6>
|
||||
<p>"Live" message to display.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>Live!</code></pre>
|
||||
</details>
|
||||
<h6>Description</h6>
|
||||
<p>"Live" message to display.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>Live!</code></pre>
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>TeamRandomizer</summary>
|
||||
<h2>TeamRandomizer</h2>
|
||||
<p>The <code>TeamRandomizer</code> can be used to randomize teams. It's great for destroying clan stacks or for social events. It can be run by typing, by default, <code>!randomize</code> into in-game admin chat</p>
|
||||
<h3>Options</h3>
|
||||
<h4>command</h4>
|
||||
<h6>Description</h6>
|
||||
<p>The command used to randomize the teams.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>randomize</code></pre>
|
||||
</details>
|
||||
<summary>TeamRandomizer</summary>
|
||||
<h2>TeamRandomizer</h2>
|
||||
<p>The <code>TeamRandomizer</code> can be used to randomize teams. It's great for destroying clan stacks or for social events. It can be run by typing, by default, <code>!randomize</code> into in-game admin chat</p>
|
||||
<h3>Options</h3>
|
||||
<h4>command</h4>
|
||||
<h6>Description</h6>
|
||||
<p>The command used to randomize the teams.</p>
|
||||
<h6>Default</h6>
|
||||
<pre><code>randomize</code></pre>
|
||||
</details>
|
||||
|
||||
## Creating Your Own Plugins
|
||||
To create your own plugin you need a basic knowledge of JavaScript.
|
||||
|
||||
@ -71,6 +71,7 @@
|
||||
{
|
||||
"plugin": "AutoKickUnassigned",
|
||||
"enabled": true,
|
||||
"adminList": "remoteAdminLists",
|
||||
"warningMessage": "Join a squad, you are are unassigned and will be kicked",
|
||||
"kickMessage": "Unassigned - automatically removed",
|
||||
"frequencyOfWarnings": 30,
|
||||
@ -78,7 +79,8 @@
|
||||
"playerThreshold": 93,
|
||||
"queueThreshold": -1,
|
||||
"roundStartDelay": 15,
|
||||
"ignoreAdmins": false
|
||||
"ignoreAdmins": false,
|
||||
"ignoreWhitelist": false
|
||||
},
|
||||
{
|
||||
"plugin": "ChatCommands",
|
||||
|
||||
Loading…
Reference in New Issue
Block a user