Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/discord-php/DiscordPHP

An API to interact with the popular messaging app Discord
https://github.com/discord-php/DiscordPHP

discord discord-api php team-reflex

Last synced: about 2 months ago
JSON representation

An API to interact with the popular messaging app Discord

Awesome Lists containing this project

README 

        
DiscordPHP

====

[![Latest Stable Version](https://poser.pugx.org/team-reflex/discord-php/v)](https://packagist.org/packages/team-reflex/discord-php) [![Latest Unstable Version](https://poser.pugx.org/team-reflex/discord-php/v/unstable)](https://packagist.org/packages/team-reflex/discord-php) [![Total Downloads](https://poser.pugx.org/team-reflex/discord-php/downloads)](https://packagist.org/packages/team-reflex/discord-php) [![PHP Version Require](https://poser.pugx.org/team-reflex/discord-php/require/php)](https://packagist.org/packages/team-reflex/discord-php)



[![PHP Discorders](https://discord.com/api/guilds/115233111977099271/widget.png?style=banner1)](https://discord.gg/dphp)



A wrapper for the official [Discord](https://discordapp.com) REST, gateway and voice APIs. Documentation is [available here](http://discord-php.github.io/DiscordPHP), albeit limited at the moment, as well as a class reference. Feel free to ask questions in the Discord server above.



For testing and stability it would be greatly appreciated if you were able to add our test bot to your server. We don't store any data - the bot simply idles and does not interact with anyone and is used to test stability with large numbers of guilds. You can invite the bot [here.](https://discord.com/oauth2/authorize?client_id=157746770539970560&scope=bot)



## Cache Interface (experimental)

> **Warning**

> This branch contains an experimental feature, do not use it in production! See [the wiki page for more information](https://github.com/discord-php/DiscordPHP/wiki/Cache-Interface) on how to set it up.



## FAQ



1. Can I run DiscordPHP on a webserver (e.g. Apache, nginx)?

    - No, DiscordPHP will only run in CLI. If you want to have an interface for your bot you can integrate [react/http](https://github.com/ReactPHP/http) with your bot and run it through CLI.

2. PHP is running out of memory?

	- Try unlimit your PHP memory using `ini_set('memory_limit', '-1');`.



## Getting Started



Before you start using this Library, you **need** to know how PHP works, you need to know how Event Loops and Promises work. This is a fundamental requirement before you start. Without this knowledge, you will only suffer.



### Requirements



- [PHP 8.0](https://php.net) or higher (latest version recommended)

	- x86 (32-bit) PHP requires [`ext-gmp`](https://www.php.net/manual/en/book.gmp.php) enabled.

- [`ext-json`](https://www.php.net/manual/en/book.json.php)

- [`ext-zlib`](https://www.php.net/manual/en/book.zlib.php)



#### Recommended Extensions



- One of [`ext-uv`](https://github.com/amphp/ext-uv) (recommended), `ext-ev` or `ext-event` for a faster, and more performant event loop.

- [`ext-mbstring`](https://www.php.net/manual/en/book.mbstring.php) if handling non-latin characters.



#### Voice Requirements



- 64-bit PHP

- [`ext-sodium`](https://www.php.net/manual/en/book.sodium.php)

- [FFmpeg](https://ffmpeg.org/)



### Windows and SSL



Unfortunately PHP on Windows does not have access to the Windows Certificate Store. This is an issue because TLS gets used and as such certificate verification gets applied (turning this off is **not** an option).



You will notice this issue by your script exiting immediately after one loop turn without any errors.



As such users of this library need to download a [Certificate Authority extract](https://curl.haxx.se/docs/caextract.html) from the cURL website.


The path to the caextract must be set in the [`php.ini`](https://secure.php.net/manual/en/openssl.configuration.php) for `openssl.cafile`.



### Installing DiscordPHP



DiscordPHP is installed using [Composer](https://getcomposer.org).



1. Run `composer require team-reflex/discord-php`. This will install the latest stable release.

	- If you would like, you can also install the development branch by running `composer require team-reflex/discord-php dev-master`.

2. Include the Composer autoload file at the top of your main file:

	- `include __DIR__.'/vendor/autoload.php';`

3. Make a bot!



### Basic Example



```php

 'bot-token',

    'intents' => Intents::getDefaultIntents()

//      | Intents::MESSAGE_CONTENT, // Note: MESSAGE_CONTENT is privileged, see https://dis.gd/mcfaq

]);



$discord->on('ready', function (Discord $discord) {

    echo "Bot is ready!", PHP_EOL;



    // Listen for messages.

    $discord->on(Event::MESSAGE_CREATE, function (Message $message, Discord $discord) {

        echo "{$message->author->username}: {$message->content}", PHP_EOL;

        // Note: MESSAGE_CONTENT intent must be enabled to get the content if the bot is not mentioned/DMed.

    });

});



$discord->run();

```



See [examples folder](examples) for more.



## Documentation



Documentation for the latest version can be found [here](//discord-php.github.io/DiscordPHP/guide). Community contributed tutorials can be found on the [wiki](//github.com/discord-php/DiscordPHP/wiki).



## Contributing



We are open to contributions. However, please make sure you follow our coding standards (PSR-4 autoloading and custom styling). Please run php-cs-fixer before opening a pull request by running `composer run-script cs`.



## License



MIT License, © David Cole and other contributers 2016-present.