SquadJS/plugins/discord-teamkill/README.md
2020-05-30 12:13:01 +01:00

33 lines
1007 B
Markdown

<div align="center">
<img src="../../assets/squadjs-logo.png" alt="Logo" width="500"/>
#### SquadJS - Discord Teamkill
</div>
## About
The Discord Teamkill plugin logs teamkill information to a Discord channel.
## Installation
```js
// Place the following two lines at the top of your index.js file.
import Discord from 'discord.js';
import { discordTeamkill } from 'plugins';
// Place the following two lines in your index.js file before using a Discord plugins.
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 discordTeamkill(
server,
discordClient,
'discordChannelID',
{ // options - the options included below display the defaults and can be removed for simplicity.
teamkillColor: 16761867, // colour of TK embed
suicideColor: 16761867, // colour of suicide embed
ignoreSuicides: false, // ignore suicide events
}
);
```