Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/laravel-notification-channels/discord
Discord notification channel for Laravel
https://github.com/laravel-notification-channels/discord
discord laravel
Last synced: 20 days ago
JSON representation
Discord notification channel for Laravel
- Host: GitHub
- URL: https://github.com/laravel-notification-channels/discord
- Owner: laravel-notification-channels
- License: mit
- Created: 2016-08-15T23:44:34.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-07-11T15:58:39.000Z (4 months ago)
- Last Synced: 2024-09-07T02:41:35.038Z (2 months ago)
- Topics: discord, laravel
- Language: PHP
- Homepage: http://laravel-notification-channels.com
- Size: 101 KB
- Stars: 225
- Watchers: 9
- Forks: 57
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Discord notification channel for Laravel 6.0+
[](https://packagist.org/packages/laravel-notification-channels/discord)
[](LICENSE.md)
[](https://github.com/laravel-notification-channels/discord/actions)
[](https://styleci.io/repos/65772492)
[](https://scrutinizer-ci.com/g/laravel-notification-channels/discord)
[](https://scrutinizer-ci.com/g/laravel-notification-channels/discord/?branch=master)
[](https://packagist.org/packages/laravel-notification-channels/discord)
This package makes it easy to send notifications using the [Discord bot API](https://discord.com/developers/docs/intro) with Laravel.
## Contents
- [Discord notification channel for Laravel 6.0+](#discord-notification-channel-for-laravel-56)
- [Contents](#contents)
- [Installation](#installation)
- [Setting up your Discord bot](#setting-up-your-discord-bot)
- [Usage](#usage)
- [Available Message methods](#available-message-methods)
- [Changelog](#changelog)
- [Testing](#testing)
- [Security](#security)
- [Contributing](#contributing)
- [Credits](#credits)
- [License](#license)
## Installation
You can install the package via composer:
```bash
composer require laravel-notification-channels/discord
```
Next, you must load the service provider:
```php
// config/app.php
'providers' => [
// ...
NotificationChannels\Discord\DiscordServiceProvider::class,
],
```
### Setting up your Discord bot
1. [Create a Discord application.](https://discord.com/developers/applications)
2. Click the `Create a Bot User` button on your Discord application.
3. Paste your bot's API token, found under `App Bot User`, in your `services.php` config file:
```php
// config/services.php
'discord' => [
'token' => 'YOUR_API_TOKEN',
],
```
4. Add the bot to your server and identify it by running the artisan command:
```shell
php artisan discord:setup
```
## Usage
In every model you wish to be notifiable via Discord, you must add a channel ID property to that model accessible through a `routeNotificationForDiscord` method:
```php
class Guild extends Eloquent
{
use Notifiable;
public function routeNotificationForDiscord()
{
return $this->discord_channel;
}
}
```
> **NOTE**: Discord handles direct messages as though they are a regular channel. If you wish to allow users to receive direct messages from your bot, you will need to create a private channel with that user.
>
> An example workflow may look like the following:
>
> 1. Your `users` table has two discord columns: `discord_user_id` and `discord_private_channel_id`
> 2. When a user updates their Discord user ID (`discord_user_id`), generate and save a private channel ID (`discord_private_channel_id`)
> 3. Return the user's `discord_private_channel_id` in the `routeNotificationForDiscord` method on the `User` model
>
> You can generate direct message channels by using the `getPrivateChannel` method in the `NotificationChannels\Discord\Discord` class
>
> ```php
> use NotificationChannels\Discord\Discord;
>
> class UserDiscordSettingsController
> {
> public function store(Request $request)
> {
> $userId = $request->input('discord_user_id');
> $channelId = app(Discord::class)->getPrivateChannel($userId);
>
> Auth::user()->update([
> 'discord_user_id' => $userId,
> 'discord_private_channel_id' => $channelId,
> ]);
> }
> }
> ```
>
> Please take note that the `getPrivateChannel` method only accepts [Discord's snowflake IDs](https://discord.com/developers/docs/reference#snowflakes). There is no API route provided by Discord to lookup a user's ID by their name and tag, and the process for copying and pasting a user ID can be confusing to some users. Because of this, it is recommended to add the option for users to connect their Discord account to their account within your application either by logging in with Discord or linking it to their pre-existing account.
You may now tell Laravel to send notifications to Discord channels in the `via` method:
```php
// ...
use NotificationChannels\Discord\DiscordChannel;
use NotificationChannels\Discord\DiscordMessage;
class GameChallengeNotification extends Notification
{
public $challenger;
public $game;
public function __construct(Guild $challenger, Game $game)
{
$this->challenger = $challenger;
$this->game = $game;
}
public function via($notifiable)
{
return [DiscordChannel::class];
}
public function toDiscord($notifiable)
{
return DiscordMessage::create("You have been challenged to a game of *{$this->game->name}* by **{$this->challenger->name}**!");
}
}
```
### Available Message methods
* `body(string)`: Set the content of the message. ([Supports basic markdown](https://support.discord.com/hc/en-us/articles/210298617-Markdown-Text-101-Chat-Formatting-Bold-Italic-Underline-))
* `embed(array)`: Set the embedded content. ([View embed structure](https://discord.com/developers/docs/resources/channel#embed-object))
* `components(array)`: Set the component content. ([View component structure](https://discord.com/developers/docs/interactions/message-components#component-object))
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
## Testing
```bash
$ composer test
```
## Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Credits
- [Cody Scott](https://github.com/codyphobe)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [LICENSE](LICENSE.md) for more information.