From f65852f1f09e08861db4473589658f73e9794bbf Mon Sep 17 00:00:00 2001
From: werewolfboy13 The The Discord connector name. The ID of the channel to log admin camera usage to. The color of the embed. Message SquadJS will send to players warning them they will be kicked The Discord connector name. Message to send to players when they are kicked The ID of the channel to log admin broadcasts to. How often in Seconds should we warn the player about being unassigned? The color of the embed. How long in Seconds to wait before a unassigned player is kicked The Discord connector name. Player count required for AutoKick to start kicking players, set to -1 to disable ID of channel to turn into RCON console. Time delay in Seconds from start of the round before AutoKick starts kicking againDiscordAdminCamLogs
- DiscordAdminCamLogs
- DiscordAdminCamLogs
plugin will log in game admin camera usage to a Discord channel.AutoKickUnassigned
+ AutoKickUnassigned
+ AutoKickUnassigned
plugin will automatically kick players that are not in a squad after a specified ammount of time.Options
- discordClient (Required)
- Description
- Default
- discord
channelID (Required)
- Description
- Default
- Example
-
-667741905228136459
color
+
- warningMessage
Description
- Default
- 16761867
DiscordAdminBroadcast
- DiscordAdminBroadcast
- DiscordAdminBroadcast
plugin will send a copy of admin broadcasts made in game to a Discord channel.Options
- discordClient (Required)
+ Join a squad, you are unassigned and will be kicked
kickMessage
Description
- Default
- discord
channelID (Required)
+ Unassigned - automatically removed
frequencyOfWarnings
Description
- Default
- Example
-
-667741905228136459
color
+ 30
unassignedTimer
Description
- Default
- 16761867
DiscordRcon
- DiscordRcon
- DiscordRcon
plugin allows a specified Discord channel to be used as a RCON console to run RCON commands.Options
- discordClient (Required)
+ 360
playerThreshold
Description
- Default
- discord
channelID (Required)
+ 93
roundStartDelay
Description
- Default
- Example
-
-667741905228136459
permissions
+ 900
ignoreAdmins
Description
- {}
) permissions will be disabled
true
: Admins will NOT be kickedfalse
: Admins WILL be kicked{}
{
- "123456789123456789": [
- "AdminBroadcast",
- "AdminForceTeamChange",
- "AdminDemoteCommander"
- ]
-}
-false
Prepend admin names when making announcements.
+true
: Reserve slot players will NOT be kickedfalse
: Reserve slot players WILL be kickedfalse
The DiscordRoundWinner
plugin will send the round winner to a Discord channel.
The AutoTkWarn
plugin will automatically warn players with a message when they teamkill.
Discord connector name.
-discord
The ID of the channel to log admin broadcasts to.
+The message to warn attacking players with.
667741905228136459
-Please apologise for ALL TKs in ALL chat!
The color of the embed.
+The message that will be sent to the victim.
16761867
null
The DiscordKillFeed
plugin logs all wounds and related information to a Discord channel for admins to review.
The CBLInfo
plugin alerts admins when a harmful player is detected joining their server based on data from the Community Ban List.
discord
The ID of the channel to log teamkills to.
+The ID of the channel to alert admins through.
667741905228136459
-The color of the embeds.
-16761867
Disable Community Ban List information.
+Admins will be alerted when a player has this or more reputation points. For more information on reputation points, see the Community Ban List's FAQ
false
6
The DiscordPlaceholder
plugin allows you to make your bot create placeholder messages that can be used when configuring other plugins.
The ChatCommands
plugin can be configured to make chat commands that broadcast or warn the caller with present messages.
Discord connector name.
-discord
Command to create Discord placeholder.
-!placeholder
The bot will only answer with a placeholder on this channel
+An array of objects containing the following properties:
command
- The command that initiates the message.type
- Either warn
or broadcast
.response
- The message to respond with.ignoreChats
- A list of chats to ignore the commands in. Use this to limit it to admins.
[
+ {
+ "command": "squadjs",
+ "type": "warn",
+ "response": "This server is powered by SquadJS.",
+ "ignoreChats": []
+ }
+]
The CBLInfo
plugin alerts admins when a harmful player is detected joining their server based on data from the Community Ban List.
The DiscordAdminBroadcast
plugin will send a copy of admin broadcasts made in game to a Discord channel.
discord
The ID of the channel to alert admins through.
+The ID of the channel to log admin broadcasts to.
667741905228136459
-Admins will be alerted when a player has this or more reputation points. For more information on reputation points, see the Community Ban List's FAQ
+The color of the embed.
6
16761867
The DiscordRoundEnded
plugin will send the round winner to a Discord channel.
The DiscordAdminCamLogs
plugin will log in game admin camera usage to a Discord channel.
discord
The ID of the channel to log round end events to.
+The ID of the channel to log admin camera usage to.
667741905228136459
@@ -435,71 +387,75 @@ Grafana:
The ChatCommands
plugin can be configured to make chat commands that broadcast or warn the caller with present messages.
An array of objects containing the following properties:
command
- The command that initiates the message.type
- Either warn
or broadcast
.response
- The message to respond with.ignoreChats
- A list of chats to ignore the commands in. Use this to limit it to admins.[
- {
- "command": "squadjs",
- "type": "warn",
- "response": "This server is powered by SquadJS.",
- "ignoreChats": []
- }
-]
The DiscordServerStatus
plugin can be used to get the server status in Discord.
The DiscordAdminRequest
plugin will ping admins in a Discord channel when a player requests an admin via the !admin
command in in-game chat.
Discord connector name.
discord
Sequelize connector name.
+The ID of the channel to log admin broadcasts to.
sqlite
667741905228136459
+A list of chat names to ignore.
+[]
[
+ "ChatSquad"
+]
+A list of phrases to ignore.
+[]
[
+ "switch"
+]
Command name to get message.
+The command that calls an admin.
!status
admin
Whether to allow messages to be subscribed to automatic updates.
+A list of Discord role IDs to ping.
+[]
[
+ "500455137626554379"
+]
+Ping @here. Great if Admin Requests are posted to a Squad Admin ONLY channel, allows pinging only Online Admins.
false
How frequently to update the time in Discord.
+Cooldown for pings in milliseconds.
60000
Whether to update the bot's status with server information.
+The color of the embed.
true
The TeamRandomizer
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, !randomize
into in-game admin chat
16761867
The command used to randomize the teams.
+Should in-game admins be warned after a players uses the command and should we tell how much admins are active in-game right now.
randomize
false
+Should players know how much in-game admins there are active/online?
+true
The SeedingMode
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.
Frequency of seeding messages in milliseconds.
-150000
Player count required for server not to be in seeding mode.
-50
Seeding message to display.
-Seeding Rules Active! Fight only over the middle flags! No FOB Hunting!
Enable "Live" messages for when the server goes live.
-true
Player count required for "Live" messages to not bee displayed.
-52
"Live" message to display.
-Live!
Should the plugin wait to be executed on NEW_GAME event.
-true
The time to wait before check player counts in seconds.
-30
The DiscordSubSystemRestarter
plugin allows you to manually restart SquadJS subsystems in case an issues arises with them.
!squadjs restartsubsystem rcon
!squadjs restartsubsystem logparser
The DiscordFOBHABExplosionDamage
plugin logs damage done to FOBs and HABs by explosions to help identify engineers blowing up friendly FOBs and HABs.
Discord connector name.
discord
ID of role required to run the sub system restart commands.
+The ID of the channel to log FOB/HAB explosion damage to.
667741905228136459
+ 667741905228136459
+The color of the embeds.
+16761867
The SquadCreated
plugin will log Squad Creation events to a Discord channel.
The DiscordKillFeed
plugin logs all wounds and related information to a Discord channel for admins to review.
discord
The ID of the channel to log Squad Creation events to.
+The ID of the channel to log teamkills to.
667741905228136459
The color of the embed.
+The color of the embeds.
16761867
Send message as Embed
+Disable Community Ban List information.
true
false
The FogOfWar
plugin can be used to automate setting fog of war mode.
The DiscordPlaceholder
plugin allows you to make your bot create placeholder messages that can be used when configuring other plugins.
Fog of war mode to set.
+Discord connector name.
1
discord
Delay before setting fog of war mode.
+Command to create Discord placeholder.
10000
!placeholder
The bot will only answer with a placeholder on this channel
+
The IntervalledBroadcasts
plugin allows you to set broadcasts, which will be broadcasted at preset intervals
The DiscordRcon
plugin allows a specified Discord channel to be used as a RCON console to run RCON commands.
Messages to broadcast.
+Discord connector name.
[]
[
- "This server is powered by SquadJS."
-]
-discord
Frequency of the broadcasts in milliseconds.
+ID of channel to turn into RCON console.
300000
667741905228136459
+{}
) permissions will be disabled{}
{
+ "123456789123456789": [
+ "AdminBroadcast",
+ "AdminForceTeamChange",
+ "AdminDemoteCommander"
+ ]
+}
+Prepend admin names when making announcements.
+false
The SocketIOAPI
plugin allows remote access to a SquadJS instance via Socket.IO
As a client example you can use this to connect to the socket.io server;
- const socket = io.connect('ws://IP:PORT', {
- auth: {
- token: "MySecretPassword"
- }
- })
-
If you need more documentation about socket.io please go ahead and read the following;The DiscordRoundWinner
plugin will send the round winner to a Discord channel.
The port for the websocket.
+Discord connector name.
3000
-discord
Your secret token/password for connecting.
+The ID of the channel to log admin broadcasts to.
MySecretPassword
+ 667741905228136459
+The color of the embed.
+16761867
The AutoTkWarn
plugin will automatically warn players with a message when they teamkill.
The DiscordRoundEnded
plugin will send the round winner to a Discord channel.
The message to warn attacking players with.
+Discord connector name.
Please apologise for ALL TKs in ALL chat!
discord
The message that will be sent to the victim.
+The ID of the channel to log round end events to.
null
667741905228136459
+The color of the embed.
+16761867
The AutoKickUnassigned
plugin will automatically kick players that are not in a squad after a specified ammount of time.
The DiscordServerStatus
plugin can be used to get the server status in Discord.
Message SquadJS will send to players warning them they will be kicked
+Discord connector name.
Join a squad, you are unassigned and will be kicked
discord
Message to send to players when they are kicked
+Sequelize connector name.
Unassigned - automatically removed
sqlite
How often in Seconds should we warn the player about being unassigned?
+Command name to get message.
30
!status
How long in Seconds to wait before a unassigned player is kicked
+Whether to allow messages to be subscribed to automatic updates.
360
false
Player count required for AutoKick to start kicking players, set to -1 to disable
+How frequently to update the time in Discord.
93
60000
Time delay in Seconds from start of the round before AutoKick starts kicking again
+Whether to update the bot's status with server information.
900
true
The SquadCreated
plugin will log Squad Creation events to a Discord channel.
true
: Admins will NOT be kickedfalse
: Admins WILL be kickedDiscord connector name.
false
discord
true
: Reserve slot players will NOT be kickedfalse
: Reserve slot players WILL be kickedThe ID of the channel to log Squad Creation events to.
false
667741905228136459
+The color of the embed.
+16761867
Send message as Embed
+true
The DiscordSubSystemRestarter
plugin allows you to manually restart SquadJS subsystems in case an issues arises with them.
!squadjs restartsubsystem rcon
!squadjs restartsubsystem logparser
Discord connector name.
+discord
ID of role required to run the sub system restart commands.
+
667741905228136459
The DiscordAdminRequest
plugin will ping admins in a Discord channel when a player requests an admin via the !admin
command in in-game chat.
The FogOfWar
plugin can be used to automate setting fog of war mode.
Discord connector name.
+Fog of war mode to set.
discord
1
The ID of the channel to log admin broadcasts to.
+Delay before setting fog of war mode.
667741905228136459
-10000
The IntervalledBroadcasts
plugin allows you to set broadcasts, which will be broadcasted at preset intervals
A list of chat names to ignore.
+Messages to broadcast.
[]
[
- "ChatSquad"
+ "This server is powered by SquadJS."
]
-A list of phrases to ignore.
+Frequency of the broadcasts in milliseconds.
[]
[
- "switch"
-]
-300000
The SeedingMode
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.
The command that calls an admin.
+Frequency of seeding messages in milliseconds.
admin
150000
A list of Discord role IDs to ping.
+Player count required for server not to be in seeding mode.
[]
[
- "500455137626554379"
-]
-50
Ping @here. Great if Admin Requests are posted to a Squad Admin ONLY channel, allows pinging only Online Admins.
+Seeding message to display.
false
Seeding Rules Active! Fight only over the middle flags! No FOB Hunting!
Cooldown for pings in milliseconds.
+Enable "Live" messages for when the server goes live.
60000
true
The color of the embed.
+Player count required for "Live" messages to not bee displayed.
16761867
52
Should in-game admins be warned after a players uses the command and should we tell how much admins are active in-game right now.
+"Live" message to display.
false
Live!
Should players know how much in-game admins there are active/online?
+Should the plugin wait to be executed on NEW_GAME event.
true
true
+The time to wait before check player counts in seconds.
+30
The DiscordFOBHABExplosionDamage
plugin logs damage done to FOBs and HABs by explosions to help identify engineers blowing up friendly FOBs and HABs.
The SocketIOAPI
plugin allows remote access to a SquadJS instance via Socket.IO
As a client example you can use this to connect to the socket.io server;
+ const socket = io.connect('ws://IP:PORT', {
+ auth: {
+ token: "MySecretPassword"
+ }
+ })
+
If you need more documentation about socket.io please go ahead and read the following;Discord connector name.
+The port for the websocket.
discord
3000
+The ID of the channel to log FOB/HAB explosion damage to.
+Your secret token/password for connecting.
667741905228136459
-MySecretPassword
+ The TeamRandomizer
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, !randomize
into in-game admin chat
The color of the embeds.
+The command used to randomize the teams.
16761867
randomize