From bda19a18b21ef02a9c4c7710c163c88e513c5caf Mon Sep 17 00:00:00 2001 From: SeanWalsh95 Date: Thu, 25 Feb 2021 20:34:56 +0000 Subject: [PATCH] ESLint & README Generation --- README.md | 630 ++++++++++++++++++++++++++-------------------------- config.json | 188 ++++++++-------- 2 files changed, 409 insertions(+), 409 deletions(-) diff --git a/README.md b/README.md index c2c767b..da60518 100644 --- a/README.md +++ b/README.md @@ -266,111 +266,9 @@ 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.

-

Options

- -
- -
- AutoTKWarn -

AutoTKWarn

-

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

-

Options

- -
- -
- ChatCommands -

ChatCommands

-

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

-

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

- -
- -
- DiscordAdminBroadcast -

DiscordAdminBroadcast

-

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

+ DiscordRoundWinner +

DiscordRoundWinner

+

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

Options

+
+ DiscordDebug +

DiscordDebug

+

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

+

Options

+ +
+ +
+ DiscordChat +

DiscordChat

+

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

+

Options

+ +
+ +
+ IntervalledBroadcasts +

IntervalledBroadcasts

+

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

+

Options

+ +
+ +
+ DiscordServerStatus +

DiscordServerStatus

+

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

+

Options

+ +
+
DiscordAdminRequest

DiscordAdminRequest

@@ -471,108 +486,40 @@ Grafana (NOT YET WORKING WITH V2):
- DiscordChat -

DiscordChat

-

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

+ ChatCommands +

ChatCommands

+

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

Options

-
- DiscordDebug -

DiscordDebug

-

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

+ AutoTKWarn +

AutoTKWarn

+

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

Options

-
- DiscordRcon -

DiscordRcon

-

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

-

Options

- -
- -
- DiscordRoundWinner -

DiscordRoundWinner

-

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

+ DiscordAdminBroadcast +

DiscordAdminBroadcast

+

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

Options

-
- DiscordServerStatus -

DiscordServerStatus

-

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

-

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

@@ -751,6 +576,29 @@ Grafana (NOT YET WORKING WITH V2): 
Live!
+
+ 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

+ +
+
TeamRandomizer

TeamRandomizer

@@ -763,6 +611,158 @@ Grafana (NOT YET WORKING WITH V2): 
randomize
+
+ DiscordRcon +

DiscordRcon

+

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

+

Options

+ +
+ +
+ DiscordTeamkill +

DiscordTeamkill

+

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

+

Options

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

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

+ +
+
## Statement on Accuracy diff --git a/config.json b/config.json index 05aba60..a94ffcc 100644 --- a/config.json +++ b/config.json @@ -33,43 +33,8 @@ }, "plugins": [ { - "plugin": "AutoKickUnassigned", + "plugin": "DiscordRoundWinner", "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 - }, - { - "plugin": "AutoTKWarn", - "enabled": true, - "message": "Please apologise for ALL TKs in ALL chat!" - }, - { - "plugin": "ChatCommands", - "enabled": true, - "commands": [ - { - "command": "squadjs", - "type": "warn", - "response": "This server is powered by SquadJS.", - "ignoreChats": [] - } - ] - }, - { - "plugin": "DBLog", - "enabled": false, - "database": "mysql", - "overrideServerID": null - }, - { - "plugin": "DiscordAdminBroadcast", - "enabled": false, "discordClient": "discord", "channelID": "", "color": 16761867 @@ -81,6 +46,38 @@ "channelID": "", "color": 16761867 }, + { + "plugin": "DiscordDebug", + "enabled": false, + "discordClient": "discord", + "channelID": "", + "events": [] + }, + { + "plugin": "DiscordChat", + "enabled": true, + "discordClient": "discord", + "channelID": "", + "chatColors": {}, + "color": 16761867, + "ignoreChats": [ + "ChatSquad" + ] + }, + { + "plugin": "IntervalledBroadcasts", + "enabled": false, + "broadcasts": [], + "interval": 300000 + }, + { + "plugin": "DiscordServerStatus", + "enabled": false, + "discordClient": "discord", + "messageIDs": [], + "updateInterval": 60000, + "disableStatus": false + }, { "plugin": "DiscordAdminRequest", "enabled": true, @@ -94,73 +91,29 @@ "color": 16761867 }, { - "plugin": "DiscordChat", + "plugin": "ChatCommands", "enabled": true, - "discordClient": "discord", - "channelID": "", - "chatColors": {}, - "color": 16761867, - "ignoreChats": [ - "ChatSquad" + "commands": [ + { + "command": "squadjs", + "type": "warn", + "response": "This server is powered by SquadJS.", + "ignoreChats": [] + } ] }, { - "plugin": "DiscordDebug", - "enabled": false, - "discordClient": "discord", - "channelID": "", - "events": [] - }, - { - "plugin": "DiscordRcon", - "enabled": false, - "discordClient": "discord", - "channelID": "", - "permissions": {}, - "prependAdminNameInBroadcast": false - }, - { - "plugin": "DiscordRoundWinner", + "plugin": "AutoTKWarn", "enabled": true, + "message": "Please apologise for ALL TKs in ALL chat!" + }, + { + "plugin": "DiscordAdminBroadcast", + "enabled": false, "discordClient": "discord", "channelID": "", "color": 16761867 }, - { - "plugin": "DiscordServerStatus", - "enabled": false, - "discordClient": "discord", - "messageIDs": [], - "updateInterval": 60000, - "disableStatus": false - }, - { - "plugin": "DiscordSubsystemRestarter", - "enabled": false, - "discordClient": "discord", - "role": "" - }, - { - "plugin": "DiscordTeamkill", - "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, @@ -171,10 +124,57 @@ "liveThreshold": 52, "liveMessage": "Live!" }, + { + "plugin": "SCBLInfo", + "enabled": true, + "discordClient": "discord", + "channelID": "", + "threshold": 6 + }, { "plugin": "TeamRandomizer", "enabled": true, "command": "randomize" + }, + { + "plugin": "DiscordRcon", + "enabled": false, + "discordClient": "discord", + "channelID": "", + "permissions": {}, + "prependAdminNameInBroadcast": false + }, + { + "plugin": "DiscordTeamkill", + "enabled": true, + "discordClient": "discord", + "channelID": "", + "color": 16761867, + "disableSCBL": false + }, + { + "plugin": "AutoKickUnassigned", + "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 + }, + { + "plugin": "DiscordSubsystemRestarter", + "enabled": false, + "discordClient": "discord", + "role": "" + }, + { + "plugin": "DBLog", + "enabled": false, + "database": "mysql", + "overrideServerID": null } ], "logger": {