From f29ee5a5d93e994d721b4e3624934edf9ff57f03 Mon Sep 17 00:00:00 2001 From: Thomas Smyth Date: Sat, 30 Jan 2021 14:41:54 +0000 Subject: [PATCH] ESLint & README Generation --- README.md | 566 ++++++++++++++++++++++++++-------------------------- config.json | 156 +++++++-------- 2 files changed, 361 insertions(+), 361 deletions(-) diff --git a/README.md b/README.md index c2c767b..ce58ed8 100644 --- a/README.md +++ b/README.md @@ -266,48 +266,66 @@ 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)
- AutoKickUnassigned -

AutoKickUnassigned

-

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

+ 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

-
+ +
+ DiscordTeamkill +

DiscordTeamkill

+

The DiscordTeamkill plugin logs teamkills and related information to a Discord channel for admins to review.

+

Options

+
@@ -324,6 +342,59 @@ Interested in creating your own plugin? [See more here](./squad-server/plugins/r 
Please apologise for ALL TKs in ALL chat!
+
+ DiscordServerStatus +

DiscordServerStatus

+

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

+

Options

+ +
+ +
+ IntervalledBroadcasts +

IntervalledBroadcasts

+

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

+

Options

+ +
+
ChatCommands

ChatCommands

@@ -344,33 +415,9 @@ Interested in creating your own plugin? [See more here](./squad-server/plugins/r
- DBLog -

DBLog

-

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 (NOT YET WORKING WITH V2): -

-

Options

- -
- -
- DiscordAdminBroadcast -

DiscordAdminBroadcast

-

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

+ SCBLInfo +

SCBLInfo

+

The SCBLInfo plugin alerts admins when a harmful player is detected joining their server based on data from the Squad Community Ban List.

Options

-
- -
- DiscordAdminCamLogs -

DiscordAdminCamLogs

-

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

-

Options

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

- + 
6
@@ -534,6 +501,109 @@ Grafana (NOT YET WORKING WITH V2): ]
+
+ 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

+ +
+ +
+ DiscordAdminBroadcast +

DiscordAdminBroadcast

+

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

+

Options

+ +
+ +
+ DiscordAdminCamLogs +

DiscordAdminCamLogs

+

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

+

Options

+ +
+
DiscordRcon

DiscordRcon

@@ -569,6 +639,48 @@ Grafana (NOT YET WORKING WITH V2): 
false
+
+ DiscordSubsystemRestarter +

DiscordSubsystemRestarter

+

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

+

Options

+ +
+ +
+ DBLog +

DBLog

+

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 (NOT YET WORKING WITH V2): +

+

Options

+ +
+
DiscordRoundWinner

DiscordRoundWinner

@@ -593,164 +705,52 @@ Grafana (NOT YET WORKING WITH V2):
- DiscordServerStatus -

DiscordServerStatus

-

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

+ AutoKickUnassigned +

AutoKickUnassigned

+

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

Options

-
-
- DiscordSubsystemRestarter -

DiscordSubsystemRestarter

-

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

-

Options

- -
- -
- DiscordTeamkill -

DiscordTeamkill

-

The DiscordTeamkill plugin logs teamkills and related information to a Discord channel for admins to review.

-

Options

- -
- -
- IntervalledBroadcasts -

IntervalledBroadcasts

-

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

-

Options

- -
- -
- SCBLInfo -

SCBLInfo

-

The SCBLInfo plugin alerts admins when a harmful player is detected joining their server based on data from the Squad Community Ban List.

-

Options

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

- -
-
TeamRandomizer

TeamRandomizer

diff --git a/config.json b/config.json index aba8196..b7e420d 100644 --- a/config.json +++ b/config.json @@ -70,22 +70,42 @@ }, "plugins": [ { - "plugin": "AutoKickUnassigned", + "plugin": "SeedingMode", "enabled": true, - "warningMessage": "Join a squad, you are are unassigned and will be kicked", - "kickMessage": "Unassigned - automatically removed", - "frequencyOfWarnings": 30, - "unassignedTimer": 360, - "playerThreshold": 93, - "roundStartDelay": 900, - "ignoreAdmins": false, - "ignoreWhitelist": false + "interval": 150000, + "seedingThreshold": 50, + "seedingMessage": "Seeding Rules Active! Fight only over the middle flags! No FOB Hunting!", + "liveEnabled": true, + "liveThreshold": 52, + "liveMessage": "Live!" + }, + { + "plugin": "DiscordTeamkill", + "enabled": true, + "discordClient": "discord", + "channelID": "", + "color": 16761867, + "disableSCBL": false }, { "plugin": "AutoTKWarn", "enabled": true, "message": "Please apologise for ALL TKs in ALL chat!" }, + { + "plugin": "DiscordServerStatus", + "enabled": false, + "discordClient": "discord", + "messageIDs": [], + "updateInterval": 60000, + "disableStatus": false + }, + { + "plugin": "IntervalledBroadcasts", + "enabled": false, + "broadcasts": [], + "interval": 300000 + }, { "plugin": "ChatCommands", "enabled": true, @@ -99,36 +119,11 @@ ] }, { - "plugin": "DBLog", - "enabled": false, - "database": "mysql", - "overrideServerID": null - }, - { - "plugin": "DiscordAdminBroadcast", - "enabled": false, - "discordClient": "discord", - "channelID": "", - "color": 16761867 - }, - { - "plugin": "DiscordAdminCamLogs", - "enabled": false, - "discordClient": "discord", - "channelID": "", - "color": 16761867 - }, - { - "plugin": "DiscordAdminRequest", + "plugin": "SCBLInfo", "enabled": true, "discordClient": "discord", "channelID": "", - "ignoreChats": [], - "ignorePhrases": [], - "command": "admin", - "pingGroups": [], - "pingDelay": 60000, - "color": 16761867 + "threshold": 6 }, { "plugin": "DiscordChat", @@ -148,6 +143,32 @@ "channelID": "", "events": [] }, + { + "plugin": "DiscordAdminRequest", + "enabled": true, + "discordClient": "discord", + "channelID": "", + "ignoreChats": [], + "ignorePhrases": [], + "command": "admin", + "pingGroups": [], + "pingDelay": 60000, + "color": 16761867 + }, + { + "plugin": "DiscordAdminBroadcast", + "enabled": false, + "discordClient": "discord", + "channelID": "", + "color": 16761867 + }, + { + "plugin": "DiscordAdminCamLogs", + "enabled": false, + "discordClient": "discord", + "channelID": "", + "color": 16761867 + }, { "plugin": "DiscordRcon", "enabled": false, @@ -156,6 +177,18 @@ "permissions": {}, "prependAdminNameInBroadcast": false }, + { + "plugin": "DiscordSubsystemRestarter", + "enabled": false, + "discordClient": "discord", + "role": "" + }, + { + "plugin": "DBLog", + "enabled": false, + "database": "mysql", + "overrideServerID": null + }, { "plugin": "DiscordRoundWinner", "enabled": true, @@ -164,49 +197,16 @@ "color": 16761867 }, { - "plugin": "DiscordServerStatus", - "enabled": false, - "discordClient": "discord", - "messageIDs": [], - "updateInterval": 60000, - "disableStatus": false - }, - { - "plugin": "DiscordSubsystemRestarter", - "enabled": false, - "discordClient": "discord", - "role": "" - }, - { - "plugin": "DiscordTeamkill", + "plugin": "AutoKickUnassigned", "enabled": true, - "discordClient": "discord", - "channelID": "", - "color": 16761867, - "disableSCBL": false - }, - { - "plugin": "IntervalledBroadcasts", - "enabled": false, - "broadcasts": [], - "interval": 300000 - }, - { - "plugin": "SCBLInfo", - "enabled": true, - "discordClient": "discord", - "channelID": "", - "threshold": 6 - }, - { - "plugin": "SeedingMode", - "enabled": true, - "interval": 150000, - "seedingThreshold": 50, - "seedingMessage": "Seeding Rules Active! Fight only over the middle flags! No FOB Hunting!", - "liveEnabled": true, - "liveThreshold": 52, - "liveMessage": "Live!" + "warningMessage": "Join a squad, you are are unassigned and will be kicked", + "kickMessage": "Unassigned - automatically removed", + "frequencyOfWarnings": 30, + "unassignedTimer": 360, + "playerThreshold": 93, + "roundStartDelay": 900, + "ignoreAdmins": false, + "ignoreWhitelist": false }, { "plugin": "TeamRandomizer",