AsgardEternal/SquadJS
1
0
Fork 0
mirror of https://github.com/AsgardEternal/SquadJS.git synced 2024-09-28 14:04:25 -05:00
Code Issues Packages Projects Releases Wiki Activity

Reformat code and docs

Browse Source
This commit is contained in:
Thomas Smyth 2020-07-08 21:49:48 +01:00
parent 7c33fac099
commit a07af6cd33
4 changed files with 20 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
README.md
View File

@ -38,6 +38,7 @@ SquadJS relies on being able to access the Squad server log directory in order t
## Plugins
* [Discord Admin Cam Logs](https://github.com/Thomas-Smyth/SquadJS/tree/master/plugins/discord-admin-cam-logs) - Log admin cam usage to Discord.
* [Discord Chat](https://github.com/Thomas-Smyth/SquadJS/tree/master/plugins/discord-chat) - Log in game chat to Discord.
* [Discord Chat Admin Request](https://github.com/Thomas-Smyth/SquadJS/tree/master/plugins/discord-chat-admin-request) - Log `!admin` alerts to Discord.
* [Discord Teamkill](https://github.com/Thomas-Smyth/SquadJS/tree/master/plugins/discord-teamkill) - Log teamkills to Discord.
* [Discord Server Status](https://github.com/Thomas-Smyth/SquadJS/tree/master/plugins/discord-server-status) - Add a server status embed to Discord.
* [Map Vote](https://github.com/Thomas-Smyth/SquadJS/tree/master/plugins/mapvote) - In-game chat map voting system.

4
index.js
View File

@ -42,9 +42,7 @@ async function main() {
await discordClient.login('Discord Login Token');
await discordAdminCamLogs(server, discordClient, 'discordChannelID');
await discordChat(server, discordClient, 'discordChannelID');
await discordChatAdminRequest(server, discordClient, 'discordChannelID', {
pingGroups: ['discordGroupID']
});
await discordChatAdminRequest(server, discordClient, 'discordChannelID', { pingGroups: ['discordGroupID'] });
await discordServerStatus(server, discordClient);
await discordTeamkill(server, discordClient, 'discordChannelID');

18
plugins/discord-chat-admin-request/README.md
View File

@ -22,11 +22,15 @@ const discordClient = new Discord.Client();
await discordClient.login('Discord Login Token'); // insert your Discord bot's login token here.
// Place the following lines after all of the above.
await discordChatAdminRequest(server, discordClient, 'discordChannelID', {
// options - the options included below display the defaults and can be removed for simplicity.
adminPrefix: '!admin', // prefix for an admin request.
pingGroups: ['729853701308678154'], // Groups to ping on a request, leave empty for no ping.
ignoreChats: ['ChatSquad', 'ChatAdmin'], // an array of chats to not display.
color: '#f44336' // color of embed
});
await discordChatAdminRequest(
server,
discordClient,
'discordChannelID',
{ // options - the options included below display the defaults and can be removed for simplicity.
adminPrefix: '!admin', // prefix for an admin request.
pingGroups: ['729853701308678154'], // Groups to ping on a request, leave empty for no ping.
ignoreChats: ['ChatSquad', 'ChatAdmin'], // an array of chats to not display.
color: '#f44336' // color of embed
}
);
```

14
plugins/discord-server-status/README.md
View File

@ -22,12 +22,12 @@ await discordClient.login('Discord Login Token'); // insert your Discord bot's l
await discordServerStatus(
server,
discordClient,
{ // options - the options included below display the defaults and can be removed for simplicity.
color: 16761867, // color of embed
colorGradient: true, // gradient color based on player count
connectLink: true, // show Steam connect link
command: '!server', // command used to send message
disableStatus: false // disable bot status as server status
}
{ // options - the options included below display the defaults and can be removed for simplicity.
color: 16761867, // color of embed
colorGradient: true, // gradient color based on player count
connectLink: true, // show Steam connect link
command: '!server', // command used to send message
disableStatus: false // disable bot status as server status
}
);
```