From 04af5b9c8bc1d94f093764a3985c8b98399d37c9 Mon Sep 17 00:00:00 2001
From: Marek The Frequency of seeding messages in milliseconds. Player count required for server not to be in seeding mode. Seeding message to display. Enable "Live" messages for when the server goes live. Player count required for "Live" messages to not bee displayed. "Live" message to display. Should the plugin wait to be executed on NEW_GAME event. The time to wait before check player counts in seconds. The Discord connector name. The ID of the channel to log admin broadcasts to. The color of the embed for each chat. The color of the embed. A list of chat names to ignore. The SeedingMode
+ SeedingMode
+ 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.Options
+
+ interval
+ Description
+ Default
+ 150000
seedingThreshold
+ Description
+ Default
+ 50
seedingMessage
+ Description
+ Default
+ Seeding Rules Active! Fight only over the middle flags! No FOB Hunting!
liveEnabled
+ Description
+ Default
+ true
liveThreshold
+ Description
+ Default
+ 52
liveMessage
+ Description
+ Default
+ Live!
waitOnNewGames
+ Description
+ Default
+ true
waitTimeOnNewGame
+ Description
+ Default
+ 30
DiscordChat
+ DiscordChat
+ DiscordChat
plugin will log in-game chat to a Discord channel.Options
+ discordClient (Required)
+ Description
+ Default
+ discord
channelID (Required)
+ Description
+ Default
+ Example
+
+667741905228136459
chatColors
+ Description
+ Default
+ {}
Example
+
+{
+ "ChatAll": 16761867
+}
color
+ Description
+ Default
+ 16761867
ignoreChats
+ Description
+ Default
+ [
+ "ChatSquad"
+]
DiscordSubsystemRestarter
+ DiscordSubsystemRestarter
+ 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 AutoTkWarn
plugin will automatically warn players with a message when they teamkill.
The message to warn attacking players with.
+Please apologise for ALL TKs in ALL chat!
The message that will be sent to the victim.
+null
The DiscordRoundWinner
plugin will send the round winner to a Discord channel.
Discord connector name.
+discord
The ID of the channel to log admin broadcasts to.
+
667741905228136459
+The color of the embed.
+16761867
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 DiscordAdminBroadcast
plugin will send a copy of admin broadcasts made in game to a Discord channel.
Discord connector name.
+discord
The ID of the channel to log admin broadcasts to.
+
667741905228136459
+The color of the embed.
+16761867
The DiscordRoundEnded
plugin will send the round winner to a Discord channel.
Discord connector name.
+discord
The ID of the channel to log round end events to.
+
667741905228136459
+The color of the embed.
+16761867
The AutoTkWarn
plugin will automatically warn players with a message when they teamkill.
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 message to warn attacking players with.
-Please apologise for ALL TKs in ALL chat!
The message that will be sent to the victim.
-null
The CBLInfo
plugin alerts admins when a harmful player is detected joining their server based on data from the Community Ban List.
Discord connector name.
-discord
The ID of the channel to alert admins through.
+The port for the websocket.
667741905228136459
-3000
+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
-6
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 mysql-log
plugin will log various server statistics and events to a database. This is great for server performance monitoring and/or player stat tracking.
-
-Grafana:
-
SquadJS
.The Sequelize connector to log server information to.
-mysql
A overridden server ID.
-null
The DiscordAdminBroadcast
plugin will send a copy of admin broadcasts made in game to a Discord channel.
Discord connector name.
-discord
The ID of the channel to log admin broadcasts to.
+Your secret token/password for connecting.
667741905228136459
-The color of the embed.
-16761867
The DiscordAdminCamLogs
plugin will log in game admin camera usage to a Discord channel.
Discord connector name.
-discord
The ID of the channel to log admin camera usage to.
-
667741905228136459
-The color of the embed.
-16761867
MySecretPassword
The DiscordChat
plugin will log in-game chat to a Discord channel.
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
Discord connector name.
+The command used to randomize the teams.
discord
The ID of the channel to log admin broadcasts to.
-
667741905228136459
-The color of the embed for each chat.
-{}
{
- "ChatAll": 16761867
-}
-The color of the embed.
-16761867
A list of chat names to ignore.
-[
- "ChatSquad"
-]
The DiscordDebug
plugin can be used to help debug SquadJS by dumping SquadJS events to a Discord channel.
Discord connector name.
-discord
The ID of the channel to log events to.
-
667741905228136459
-A list of events to dump.
-[]
[
- "PLAYER_DIED"
-]
- 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
The ID of the channel to log FOB/HAB explosion damage to.
-
667741905228136459
-The color of the embeds.
-16761867
randomize
The DiscordPlaceholder
plugin allows you to make your bot create placeholder messages that can be used when configuring other plugins.
The DiscordAdminCamLogs
plugin will log in game admin camera usage to a Discord channel.
Discord connector name.
discord
Command to create Discord placeholder.
-!placeholder
The bot will only answer with a placeholder on this channel
+The ID of the channel to log admin camera usage to.
667741905228136459
+The color of the embed.
+16761867
The mysql-log
plugin will log various server statistics and events to a database. This is great for server performance monitoring and/or player stat tracking.
+
+Grafana:
+
SquadJS
.The Sequelize connector to log server information to.
+mysql
A overridden server ID.
+null
The CBLInfo
plugin alerts admins when a harmful player is detected joining their server based on data from the Community Ban List.
Discord connector name.
+discord
The ID of the channel to alert admins through.
+
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
+6
The DiscordDebug
plugin can be used to help debug SquadJS by dumping SquadJS events to a Discord channel.
Discord connector name.
+discord
The ID of the channel to log events to.
+
667741905228136459
+A list of events to dump.
+[]
[
+ "PLAYER_DIED"
+]
The DiscordRoundWinner
plugin will send the round winner to a Discord channel.
The DiscordFOBHABExplosionDamage
plugin logs damage done to FOBs and HABs by explosions to help identify engineers blowing up friendly FOBs and HABs.
discord
The ID of the channel to log admin broadcasts to.
+The ID of the channel to log FOB/HAB explosion damage to.
667741905228136459
The color of the embed.
+The color of the embeds.
16761867
The DiscordRoundEnded
plugin will send the round winner to a Discord channel.
Stores into a DB every association of SteamID-EOSID
+The Sequelize connector.
+sqlite
The DiscordPlaceholder
plugin allows you to make your bot create placeholder messages that can be used when configuring other plugins.
Discord connector name.
+discord
Command to create Discord placeholder.
+!placeholder
The bot will only answer with a placeholder on this channel
+
The DiscordTeamkill
plugin logs teamkills and related information to a Discord channel for admins to review.
discord
The ID of the channel to log round end events to.
+The ID of the channel to log teamkills to.
+
667741905228136459
+The color of the embeds.
+16761867
Disable Community Ban List information.
+false
The SquadCreated
plugin will log Squad Creation events to a Discord channel.
Discord connector name.
+discord
The ID of the channel to log Squad Creation events to.
667741905228136459
@@ -659,7 +824,12 @@ Grafana:
The color of the embed.
16761867
+ 16761867
+Send message as Embed
+true
true
The SquadCreated
plugin will log Squad Creation events to a Discord channel.
Discord connector name.
-discord
The ID of the channel to log Squad Creation events to.
-
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 DiscordTeamkill
plugin logs teamkills and related information to a Discord channel for admins to review.
Discord connector name.
-discord
The ID of the channel to log teamkills to.
-
667741905228136459
-The color of the embeds.
-16761867
Disable Community Ban List information.
-false
300000
Stores into a DB every association of SteamID-EOSID
-The Sequelize connector.
-sqlite
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 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 port for the websocket.
-
3000
-Your secret token/password for connecting.
-
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 command used to randomize the teams.
-randomize