Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cortexpe/discordwebhookapi
A PocketMine-MP Virion to easily send messages via Discord Webhooks
https://github.com/cortexpe/discordwebhookapi
api discord-js discordapp pocketmine-mp pocketmine-mp-virion virion
Last synced: about 1 month ago
JSON representation
A PocketMine-MP Virion to easily send messages via Discord Webhooks
- Host: GitHub
- URL: https://github.com/cortexpe/discordwebhookapi
- Owner: CortexPE
- License: lgpl-3.0
- Created: 2018-12-18T05:27:46.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-11-04T02:17:29.000Z (about 1 year ago)
- Last Synced: 2024-09-26T10:02:03.146Z (about 2 months ago)
- Topics: api, discord-js, discordapp, pocketmine-mp, pocketmine-mp-virion, virion
- Language: PHP
- Homepage:
- Size: 57.6 KB
- Stars: 52
- Watchers: 7
- Forks: 26
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
DiscordWebhookAPI
A PocketMine-MP Virion to easily send messages via Discord Webhooks
# Usage:
Installation is easy, you may get a compiled phar [here](https://poggit.pmmp.io/ci/CortexPE/DiscordWebhookAPI/~) or integrate the virion itself into your plugin.
This virion is purely object oriented. So, to use it you'll have to import the `Webhook` object, the `Message` object and the optional `Embed` object (if necessary)
## Basic Usage:
### Import the classes
You'll need to import these classes in order to easily use it within our code.
```php
setUsername("USERNAME"); // optional
$msg->setAvatarURL("https://cortexpe.xyz/utils/kitsu.png"); // optional
$msg->setContent("INSERT TEXT HERE"); // optional. Maximum length is 2000 characters, the limit is set by discord, therefore it is not hardcoded within this API
```
### Sending the message
You can easily send the message to the webhook now! :tada: This will schedule a new AsyncTask on the Server's AsyncPool to prevent blocking the Main Thread. Do take note however, that **you CANNOT send a blank message.** doing so will only produce an error received from Discord itself.
```php
$webHook->send($msg);
```
How easy was that? ^-^ Now for the much more advanced and cooler stuff, Embeds!
### Embeds
Before you send the message, you might want to add an embed. A message can have several embeds in it! You only have to construct an embed and use the `Message->addEmbed()` method to add it into the message object.
```php
$embed = new Embed();
```
Now, the embed has to have something in it to function properly, so we'll add in a title (optional) and a description (optional). **All of the fields are optional, but it should contain ATLEAST one field or it would refuse to add it into the message**
```php
$embed->setTitle("Embed Title Here");
$embed->setDescription("A very awesome description");
```
We can even set a footer text! The text on the bottom part of the embeds...
```php
$embed->setFooter("Erin is kawaii UwU");
```
Or even, add an icon to the footer...
```php
$embed->setFooter("Erin is kawaii UwU","https://cortexpe.xyz/utils/kitsu.png");
```
Now that the embed has been constructed and has a valid content, we will have to add it to the `Message` object... We'll need to use the `Message->addEmbed()` method for that.
```php
$msg->addEmbed($embed);
```
**That's all for the Basic Usage of the API. To learn more, You can explore it by reading the API's source code yourself (the code is simple and explanatory) or by using your favorite IDE to index it yourself. :3**
# Sample Code used to test this API earlier:
```php
// Construct a discord webhook with its URL
$webHook = new Webhook("YOUR WEBHOOK URL");
// Construct a new Message object
$msg = new Message();
$msg->setUsername("USERNAME");
$msg->setAvatarURL("https://cortexpe.xyz/utils/kitsu.png");
$msg->setContent("INSERT TEXT HERE");
// Create an embed object with #FF0000 (RED) as the embed's color and "EMBED 1" as the title
$embed = new Embed();
$embed->setTitle("EMBED 1");
$embed->setColor(0xFF0000);
$msg->addEmbed($embed);
$embed = new Embed();
$embed->setTitle("EMBED 2");
$embed->setColor(0x00FF00);
$embed->setAuthor("AUTHOR", "https://CortexPE.xyz", "https://cortexpe.xyz/utils/kitsu.png");
$embed->setDescription("Lorem ipsum dolor sit amet, consectetur adipiscing elit.");
$msg->addEmbed($embed);
$embed = new Embed();
$embed->setTitle("EMBED 3");
$embed->setColor(0x0000FF);
$embed->addField("FIELD ONE", "Some text here");
$embed->addField("FIELD TWO", "Some text here", true);
$embed->addField("FIELD THREE", "Some text here", true);
$embed->setThumbnail("https://cortexpe.xyz/utils/kitsu.png");
$embed->setImage("https://cortexpe.xyz/utils/kitsu.png");
$embed->setFooter("Erin is kawaii UwU","https://cortexpe.xyz/utils/kitsu.png");
$msg->addEmbed($embed);
$webHook->send($msg);
```
-----
**This API was made with :heart: by CortexPE, Enjoy!~ :3**