This repository has been archived by the owner on Sep 23, 2020. It is now read-only.
forked from discord-php/DiscordPHP
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
5842e13
commit 65fedfb
Showing
1 changed file
with
6 additions
and
60 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,65 +1,11 @@ | ||
| DiscordPHP | ||
| ==== | ||
| [](https://travis-ci.org/teamreflex/DiscordPHP) [](https://discord.gg/0SBTUU1wZTX4Mjwn) [](https://discord.gg/0duG4FF1ElFGUFVq) | ||
| [](https://travis-ci.org/rocketmates/discord-php) | ||
|
|
||
| A wrapper for the official [Discord](https://discordapp.com) REST, gateway and voice APIs. | ||
| A drop-in replacement wrapper for the DiscordPHP package originally by [teamreflex](https://github.com/teamreflex), improved and under development now by [RocketMates](https://github.com/rocketmates) to power their Discord Bot. | ||
|
|
||
| ## FAQ | ||
| PHP 7.4 compatible. | ||
|
|
||
| 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. | ||
|
|
||
| ## Getting Started | ||
|
|
||
| ### Installing DiscordPHP | ||
|
|
||
| DiscordPHP is installed using [Composer](https://getcomposer.org). Make sure you have installed Composer and are used to how it operates. We require a minimum PHP version of PHP 5.5.9, however it is reccomended that you use PHP 7. PHP 5.x support **will** be removed in the future. | ||
|
|
||
| This library has not been tested with HHVM. | ||
|
|
||
| 1. Run `composer require team-reflex/discord-php`. This will install the lastest release. | ||
| - If you would like, you can also install the development branch by running `composer require team-reflex/discord-php dev-develop`. | ||
| 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 | ||
| <?php | ||
|
|
||
| include __DIR__.'/vendor/autoload.php'; | ||
|
|
||
| use Discord\Discord; | ||
|
|
||
| $discord = new Discord([ | ||
| 'token' => 'bot-token', | ||
| ]); | ||
|
|
||
| $discord->on('ready', function ($discord) { | ||
| echo "Bot is ready!", PHP_EOL; | ||
|
|
||
| // Listen for messages. | ||
| $discord->on('message', function ($message, $discord) { | ||
| echo "{$message->author->username}: {$message->content}",PHP_EOL; | ||
| }); | ||
| }); | ||
|
|
||
| $discord->run(); | ||
| ``` | ||
|
|
||
| ## Notes | ||
|
|
||
| - This library can use a lot of RAM and PHP may hit the memory limit. To increase the memory limit, use `ini_set('memory_limit', '200M')` to increase it to 200 mb. If you would like it to be unlimited, use `ini_set('memory_limit', '-1')`. | ||
|
|
||
| ## Documentation | ||
|
|
||
| Raw documentation can be found in-line in the code and on the [DiscordPHP Class Reference](http://teamreflex.github.io/DiscordPHP/). More user friendly and examples will soon be coming on the [DiscordPHP Wiki](https://discordphp.readme.io/). | ||
|
|
||
| ## Contributing | ||
|
|
||
| We are open to contributions. However, please make sure you follow our coding standards (PSR-4 autoloading and custom styling). We use StyleCI to format our code. Our StyleCI settings can be found [here](https://github.com/teamreflex/DiscordPHP/wiki/StyleCI). | ||
|
|
||
| ## Library Comparison | ||
|
|
||
| See [this chart](https://abal.moe/Discord/Libraries.html) for a feature comparison and list of other Discord API libraries. | ||
| - [rocketmates.de](https://rocketmates.de) | ||
| - [@RocketMates](https://twitter.com/RocketMates) | ||
| - [@Discord](http://twitter.com/Discord) |