seatplus/discord

This package brings discord support to seatplus

Fund package maintenance!
seatplus

1.1.0 2023-12-14 22:07 UTC

This package is auto-updated.

Last update: 2024-11-15 00:17:52 UTC


README

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Maintainability Test Coverage Total Downloads

This repo brings discord tribes to seatplus.

Installation

You can install the package via composer:

composer require seatplus/discord

You can publish and run the migrations with:

php artisan vendor:publish --tag="web"
php artisan migrate

Setup

to setup the package you need to create a discord application and bot. Finally you must add the credentials to your .env file

Create a discord application

  • Go to https://discord.com/developers/applications
  • Create a new application and give it a name
  • Go to OAuth2
    • Add a redirect url (e.g. {seatplus-public-url}/discord/callback)
  • Go to Bot
    • Add a bot
    • Enable "require OAuth2 code grant"
    • Enable "Server Members Intent"

Retrieve credentials

Below you find instructions on where to find the credentials and how to fill them into your .env file

  • From the oauth2 tab copy the client id, client secret and redirect uri tab copy the token (sometimes you need to reset the token first)
DISCORD_CLIENT_ID=  // your discord client id
DISCORD_CLIENT_SECRET= // your discord client secret
DISCORD_BOT_TOKEN= // your discord bot token
DISCORD_REDIRECT_URI= // your discord redirect uri

Usage

php artisan tribe:nickname:discord
php artisan tribe:role:discord

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Credits

License

The MIT License (MIT). Please see License File for more information.