From 46217a4a63a75756f09595302bee0e54268c119e Mon Sep 17 00:00:00 2001 From: SeanWalsh95 Date: Thu, 5 Nov 2020 11:33:00 -0500 Subject: [PATCH] yarn build --- README.md | 682 ++++++++++++++++++++++++++-------------------------- config.json | 4 +- 2 files changed, 349 insertions(+), 337 deletions(-) diff --git a/README.md b/README.md index 6af6f49..8653564 100644 --- a/README.md +++ b/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:
- AutoTKWarn -

AutoTKWarn

-

The AutoTkWarn plugin will automatically warn players with a message when they teamkill.

-

Options

-

message

-
Description
-

The message to warn players with.

-
Default
- 
Please apologise for ALL TKs in ALL chat!
-
+ AutoTKWarn +

AutoTKWarn

+

The AutoTkWarn plugin will automatically warn players with a message when they teamkill.

+

Options

+

message

+
Description
+

The message to warn players with.

+
Default
+ 
Please apologise for ALL TKs in ALL chat!
+
- AutoKickUnassigned -

AutoKickUnassigned

-

The AutoKickUnassigned plugin will automatically kick players that are not in a squad after a specified ammount of time.

-

Options

-

warningMessage

-
Description
-

Message SquadJS will send to players warning them they will be kicked

-
Default
- 
Join a squad, you are are unassigned and will be kicked
+ AutoKickUnassigned +

AutoKickUnassigned

+

The AutoKickUnassigned plugin will automatically kick players that are not in a squad after a specified ammount of time.

+

Options

+

adminList (Required)

+
Description
+

List of server admins.

+
Default
+ 
remoteAdminLists
+

warningMessage

+
Description
+

Message SquadJS will send to players warning them they will be kicked

+
Default
+ 
Join a squad, you are are unassigned and will be kicked

kickMessage

-
Description
-

Message to send to players when they are kicked

-
Default
- 
Unassigned - automatically removed
+
Description
+

Message to send to players when they are kicked

+
Default
+ 
Unassigned - automatically removed

frequencyOfWarnings

-
Description
-

How often in seconds should we warn the player about being unassigned?

-
Default
- 
30
+
Description
+

How often in seconds should we warn the player about being unassigned?

+
Default
+ 
30

unassignedTimer

-
Description
-

How long in minutes to wait before a player that is unassigned is kicked

-
Default
- 
6
+
Description
+

How long in minutes to wait before a player that is unassigned is kicked

+
Default
+ 
6

playerThreshold

-
Description
-

Player count required for AutoKick to start kicking players to disable set to -1 to disable

-
Default
- 
93
+
Description
+

Player count required for AutoKick to start kicking players to disable set to -1 to disable

+
Default
+ 
93

queueThreshold

-
Description
-

The number of players in the queue before AutoKick starts kicking players set to -1 to disable

-
Default
- 
-1
+
Description
+

The number of players in the queue before AutoKick starts kicking players set to -1 to disable

+
Default
+ 
-1

roundStartDelay

-
Description
-

Time delay in minutes from start of the round before AutoKick starts kicking again

-
Default
- 
15
+
Description
+

Time delay in minutes from start of the round before AutoKick starts kicking again

+
Default
+ 
15

ignoreAdmins

-
Description
-

Whether or not admins will be auto kicked for being unassigned

-
Default
- 
false
-
+
Description
+

Whether or not admins will be auto kicked for being unassigned

+
Default
+ 
false
+

ignoreWhitelist

+
Description
+

Whether or not players in the whitelist will be auto kicked for being unassigned

+
Default
+ 
false
+
- ChatCommands -

ChatCommands

-

The ChatCommands plugin can be configured to make chat commands that broadcast or warn the caller with present messages.

-

Options

-

commands

-
Description
-

An array of objects containing the following properties:

-
Default
- 
[
+          ChatCommands
+          
ChatCommands

+          
The ChatCommands plugin can be configured to make chat commands that broadcast or warn the caller with present messages.

+          
Options

+          
commands

+           
Description

+           
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.

+           
Default

+           
[
   {
     "command": "squadjs",
     "type": "warn",
@@ -262,214 +272,214 @@ The following is a list of plugins built into SquadJS, you can click their title
     "ignoreChats": []
   }
 ]

-
+
- DiscordAdminBroadcast -

DiscordAdminBroadcast

-

The DiscordAdminBroadcast plugin will send a copy of admin broadcasts made in game to a Discord channel.

-

Options

-

discordClient (Required)

-
Description
-

Discord connector name.

-
Default
- 
discord
+ DiscordAdminBroadcast +

DiscordAdminBroadcast

+

The DiscordAdminBroadcast plugin will send a copy of admin broadcasts made in game to a Discord channel.

+

Options

+

discordClient (Required)

+
Description
+

Discord connector name.

+
Default
+ 
discord

channelID (Required)

-
Description
-

The ID of the channel to log admin broadcasts to.

-
Default
-
Example
- 
667741905228136459
+
Description
+

The ID of the channel to log admin broadcasts to.

+
Default
+
Example
+ 
667741905228136459

color

-
Description
-

The color of the embed.

-
Default
- 
16761867
-
+
Description
+

The color of the embed.

+
Default
+ 
16761867
+
- DiscordAdminCamLogs -

DiscordAdminCamLogs

-

The DiscordAdminCamLogs plugin will log in game admin camera usage to a Discord channel.

-

Options

-

discordClient (Required)

-
Description
-

Discord connector name.

-
Default
- 
discord
+ DiscordAdminCamLogs +

DiscordAdminCamLogs

+

The DiscordAdminCamLogs plugin will log in game admin camera usage to a Discord channel.

+

Options

+

discordClient (Required)

+
Description
+

Discord connector name.

+
Default
+ 
discord

channelID (Required)

-
Description
-

The ID of the channel to log admin camera usage to.

-
Default
-
Example
- 
667741905228136459
+
Description
+

The ID of the channel to log admin camera usage to.

+
Default
+
Example
+ 
667741905228136459

color

-
Description
-

The color of the embed.

-
Default
- 
16761867
-
+
Description
+

The color of the embed.

+
Default
+ 
16761867
+
- DiscordAdminRequest -

DiscordAdminRequest

-

The DiscordAdminRequest plugin will ping admins in a Discord channel when a player requests an admin via the !admin command in in-game chat.

-

Options

-

discordClient (Required)

-
Description
-

Discord connector name.

-
Default
- 
discord
+ DiscordAdminRequest +

DiscordAdminRequest

+

The DiscordAdminRequest plugin will ping admins in a Discord channel when a player requests an admin via the !admin command in in-game chat.

+

Options

+

discordClient (Required)

+
Description
+

Discord connector name.

+
Default
+ 
discord

channelID (Required)

-
Description
-

The ID of the channel to log admin broadcasts to.

-
Default
-
Example
- 
667741905228136459
+
Description
+

The ID of the channel to log admin broadcasts to.

+
Default
+
Example
+ 
667741905228136459

ignoreChats

-
Description
-

A list of chat names to ignore.

-
Default
- 
[]
Example
- 
[
+           
Description

+           
A list of chat names to ignore.

+           
Default

+           
[]
Example

+           
[
   "ChatSquad"
 ]

 
ignorePhrases

-       
Description

-       
A list of phrases to ignore.

-       
Default

-       
[]
Example

-       
[
+           
Description

+           
A list of phrases to ignore.

+           
Default

+           
[]
Example

+           
[
   "switch"
 ]

 
command

-       
Description

-       
The command that calls an admin.

-       
Default

-       
admin

+           
Description

+           
The command that calls an admin.

+           
Default

+           
admin

 
pingGroups

-       
Description

-       
A list of Discord role IDs to ping.

-       
Default

-       
[]
Example

-       
[
+           
Description

+           
A list of Discord role IDs to ping.

+           
Default

+           
[]
Example

+           
[
   "500455137626554379"
 ]

 
pingDelay

-       
Description

-       
Cooldown for pings in milliseconds.

-       
Default

-       
60000

+           
Description

+           
Cooldown for pings in milliseconds.

+           
Default

+           
60000

 
color

-       
Description

-       
The color of the embed.

-       
Default

-       
16761867

-
+
Description
+

The color of the embed.

+
Default
+ 
16761867
+
- DiscordChat -

DiscordChat

-

The DiscordChat plugin will log in-game chat to a Discord channel.

-

Options

-

discordClient (Required)

-
Description
-

Discord connector name.

-
Default
- 
discord
+ DiscordChat +

DiscordChat

+

The DiscordChat plugin will log in-game chat to a Discord channel.

+

Options

+

discordClient (Required)

+
Description
+

Discord connector name.

+
Default
+ 
discord

channelID (Required)

-
Description
-

The ID of the channel to log admin broadcasts to.

-
Default
-
Example
- 
667741905228136459
+
Description
+

The ID of the channel to log admin broadcasts to.

+
Default
+
Example
+ 
667741905228136459

chatColors

-
Description
-

The color of the embed for each chat.

-
Default
- 
{}
Example
- 
{
+           
Description

+           
The color of the embed for each chat.

+           
Default

+           
{}
Example

+           
{
   "ChatAll": 16761867
 }

 
color

-       
Description

-       
The color of the embed.

-       
Default

-       
16761867

+           
Description

+           
The color of the embed.

+           
Default

+           
16761867

 
ignoreChats

-       
Description

-       
A list of chat names to ignore.

-       
Default

-       
[
+           
Description

+           
A list of chat names to ignore.

+           
Default

+           
[
   "ChatSquad"
 ]

-
+
- DiscordDebug -

DiscordDebug

-

The DiscordDebug plugin can be used to help debug SquadJS by dumping SquadJS events to a Discord channel.

-

Options

-

discordClient (Required)

-
Description
-

Discord connector name.

-
Default
- 
discord
+ DiscordDebug +

DiscordDebug

+

The DiscordDebug plugin can be used to help debug SquadJS by dumping SquadJS events to a Discord channel.

+

Options

+

discordClient (Required)

+
Description
+

Discord connector name.

+
Default
+ 
discord

channelID (Required)

-
Description
-

The ID of the channel to log events to.

-
Default
-
Example
- 
667741905228136459
+
Description
+

The ID of the channel to log events to.

+
Default
+
Example
+ 
667741905228136459

events (Required)

-
Description
-

A list of events to dump.

-
Default
- 
[]
Example
- 
[
+           
Description

+           
A list of events to dump.

+           
Default

+           
[]
Example

+           
[
   "PLAYER_DIED"
 ]

-
+
- DiscordPlaceholder -

DiscordPlaceholder

-

The DiscordPlaceholder plugin can be used to create placeholder messages in Discord for use by other plugins.

-

Options

-

discordClient (Required)

-
Description
-

Discord connector name.

-
Default
- 
discord
+ DiscordPlaceholder +

DiscordPlaceholder

+

The DiscordPlaceholder plugin can be used to create placeholder messages in Discord for use by other plugins.

+

Options

+

discordClient (Required)

+
Description
+

Discord connector name.

+
Default
+ 
discord

command

-
Description
-

Command that triggers the placeholder message.

-
Default
- 
!placeholder
-
+
Description
+

Command that triggers the placeholder message.

+
Default
+ 
!placeholder
+
- DiscordRcon -

DiscordRcon

-

The DiscordRcon plugin allows a specified Discord channel to be used as a RCON console to run RCON commands.

-

Options

-

discordClient (Required)

-
Description
-

Discord connector name.

-
Default
- 
discord
+ DiscordRcon +

DiscordRcon

+

The DiscordRcon plugin allows a specified Discord channel to be used as a RCON console to run RCON commands.

+

Options

+

discordClient (Required)

+
Description
+

Discord connector name.

+
Default
+ 
discord

channelID (Required)

-
Description
-

ID of channel to turn into RCON console.

-
Default
-
Example
- 
667741905228136459
+
Description
+

ID of channel to turn into RCON console.

+
Default
+
Example
+ 
667741905228136459

permissions

-
Description
-

-
Default
- 
{}
Example
- 
{
+           
Description

+           

+           
Default

+           
{}
Example

+           
{
   "123456789123456789": [
     "AdminBroadcast",
     "AdminForceTeamChange",
@@ -477,154 +487,154 @@ The following is a list of plugins built into SquadJS, you can click their title
   ]
 }

 
prependAdminNameInBroadcast

-       
Description

-       
Prepend admin names when making announcements.

-       
Default

-       
false

-
+
Description
+

Prepend admin names when making announcements.

+
Default
+ 
false
+
- DiscordRoundWinner -

DiscordRoundWinner

-

The DiscordRoundWinner plugin will send the round winner to a Discord channel.

-

Options

-

discordClient (Required)

-
Description
-

Discord connector name.

-
Default
- 
discord
+ DiscordRoundWinner +

DiscordRoundWinner

+

The DiscordRoundWinner plugin will send the round winner to a Discord channel.

+

Options

+

discordClient (Required)

+
Description
+

Discord connector name.

+
Default
+ 
discord

channelID (Required)

-
Description
-

The ID of the channel to log admin broadcasts to.

-
Default
-
Example
- 
667741905228136459
+
Description
+

The ID of the channel to log admin broadcasts to.

+
Default
+
Example
+ 
667741905228136459

color

-
Description
-

The color of the embed.

-
Default
- 
16761867
-
+
Description
+

The color of the embed.

+
Default
+ 
16761867
+
- DiscordServerStatus -

DiscordServerStatus

-

The DiscordServerStatus plugin updates a message in Discord with current server information, e.g. player count.

-

Options

-

discordClient (Required)

-
Description
-

Discord connector name.

-
Default
- 
discord
+ DiscordServerStatus +

DiscordServerStatus

+

The DiscordServerStatus plugin updates a message in Discord with current server information, e.g. player count.

+

Options

+

discordClient (Required)

+
Description
+

Discord connector name.

+
Default
+ 
discord

messageIDs (Required)

-
Description
-

ID of messages to update.

-
Default
- 
[]
Example
- 
[
+           
Description

+           
ID of messages to update.

+           
Default

+           
[]
Example

+           
[
   {
     "channelID": "667741905228136459",
     "messageID": "766688383043895387"
   }
 ]

 
updateInterval

-       
Description

-       
How frequently to update the status in Discord.

-       
Default

-       
60000

+           
Description

+           
How frequently to update the status in Discord.

+           
Default

+           
60000

 
disableStatus

-       
Description

-       
Disable the bot status.

-       
Default

-       
false

-
+
Description
+

Disable the bot status.

+
Default
+ 
false
+
- DiscordSubsystemRestarter -

DiscordSubsystemRestarter

-

The DiscordSubSystemRestarter plugin allows you to manually restart SquadJS subsystems in case an issues arises with them.

  • !squadjs restartsubsystem rcon
  • !squadjs restartsubsystem logparser

-

Options

-

discordClient (Required)

-
Description
-

Discord connector name.

-
Default
- 
discord
+ DiscordSubsystemRestarter +

DiscordSubsystemRestarter

+

The DiscordSubSystemRestarter plugin allows you to manually restart SquadJS subsystems in case an issues arises with them.

  • !squadjs restartsubsystem rcon
  • !squadjs restartsubsystem logparser

+

Options

+

discordClient (Required)

+
Description
+

Discord connector name.

+
Default
+ 
discord

role (Required)

-
Description
-

ID of role required to run the sub system restart commands.

-
Default
-
Example
- 
667741905228136459
-
+
Description
+

ID of role required to run the sub system restart commands.

+
Default
+
Example
+ 
667741905228136459
+
- IntervalledBroadcasts -

IntervalledBroadcasts

-

The IntervalledBroadcasts plugin allows you to set broadcasts, which will be broadcasted at preset intervals

-

Options

-

broadcasts

-
Description
-

Messages to broadcast.

-
Default
- 
[]
Example
- 
[
+          IntervalledBroadcasts
+          
IntervalledBroadcasts

+          
The IntervalledBroadcasts plugin allows you to set broadcasts, which will be broadcasted at preset intervals

+          
Options

+          
broadcasts

+           
Description

+           
Messages to broadcast.

+           
Default

+           
[]
Example

+           
[
   "This server is powered by SquadJS."
 ]

 
interval

-       
Description

-       
Frequency of the broadcasts in milliseconds.

-       
Default

-       
300000

-
+
Description
+

Frequency of the broadcasts in milliseconds.

+
Default
+ 
300000
+
- SeedingMode -

SeedingMode

-

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.

-

Options

-

interval

-
Description
-

Frequency of seeding messages in milliseconds.

-
Default
- 
150000
+ SeedingMode +

SeedingMode

+

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.

+

Options

+

interval

+
Description
+

Frequency of seeding messages in milliseconds.

+
Default
+ 
150000

seedingThreshold

-
Description
-

Player count required for server not to be in seeding mode.

-
Default
- 
50
+
Description
+

Player count required for server not to be in seeding mode.

+
Default
+ 
50

seedingMessage

-
Description
-

Seeding message to display.

-
Default
- 
Seeding Rules Active! Fight only over the middle flags! No FOB Hunting!
+
Description
+

Seeding message to display.

+
Default
+ 
Seeding Rules Active! Fight only over the middle flags! No FOB Hunting!

liveEnabled

-
Description
-

Enable "Live" messages for when the server goes live.

-
Default
- 
true
+
Description
+

Enable "Live" messages for when the server goes live.

+
Default
+ 
true

liveThreshold

-
Description
-

Player count required for "Live" messages to not bee displayed.

-
Default
- 
52
+
Description
+

Player count required for "Live" messages to not bee displayed.

+
Default
+ 
52

liveMessage

-
Description
-

"Live" message to display.

-
Default
- 
Live!
-
+
Description
+

"Live" message to display.

+
Default
+ 
Live!
+
- TeamRandomizer -

TeamRandomizer

-

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

-

Options

-

command

-
Description
-

The command used to randomize the teams.

-
Default
- 
randomize
-
+ TeamRandomizer +

TeamRandomizer

+

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

+

Options

+

command

+
Description
+

The command used to randomize the teams.

+
Default
+ 
randomize
+ ## Creating Your Own Plugins To create your own plugin you need a basic knowledge of JavaScript. diff --git a/config.json b/config.json index cdfae86..37ac557 100644 --- a/config.json +++ b/config.json @@ -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",