Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/imjustnozell/discordwebhookapi
https://github.com/imjustnozell/discordwebhookapi
Last synced: 17 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/imjustnozell/discordwebhookapi
- Owner: imjustnozell
- License: lgpl-3.0
- Created: 2024-11-15T02:08:59.000Z (about 2 months ago)
- Default Branch: master
- Last Pushed: 2024-11-15T02:14:25.000Z (about 2 months ago)
- Last Synced: 2024-12-17T09:50:05.359Z (17 days ago)
- Language: PHP
- Size: 64.5 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
#DiscordWebhookAPI
---
---
DiscordWebhookAPI
A PocketMine-MP Virion to easily send messages via Discord Webhooks
Una Virion para PocketMine-MP para enviar mensajes fácilmente mediante Discord Webhooks
---
## 🎉 Installation / Instalación
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.
La instalación es fácil. Puedes obtener un `.phar` compilado [aquí](https://poggit.pmmp.io/ci/CortexPE/DiscordWebhookAPI/~) o integrar directamente el virion en tu plugin.
This virion is purely object-oriented. To use it, you'll need to import the `Webhook`, `Message`, and optionally, the `Embed` object (if needed).
Esta API es completamente orientada a objetos. Para usarla, deberás importar los objetos `Webhook`, `Message`, y opcionalmente, `Embed` si es necesario.
---
## 🛠 Basic Usage / Uso básico
### Import the classes / Importar las clases
To use this API in your code, you'll need to import the following classes:
Para usar esta API en tu código, necesitarás importar las siguientes clases:
```php
setUsername("USERNAME"); // optional / opcional
$msg->setAvatarURL("https://cortexpe.xyz/utils/kitsu.png"); // optional / opcional
$msg->setContent("INSERT TEXT HERE"); // optional. Max length 2000 characters / opcional. Máximo 2000 caracteres
```
### Send the message / Enviar el mensaje
Now you can send the message using the `send()` method. This will schedule an AsyncTask to avoid blocking the main thread.
Ahora puedes enviar el mensaje usando el método `send()`. Esto programará una AsyncTask para evitar bloquear el hilo principal.
```php
$webHook->send($msg);
```
---
## 📦 Embeds
Before sending a message, you may want to add an embed. You can construct an `Embed` object and use `Message->addEmbed()` to include it.
Antes de enviar un mensaje, quizá quieras agregar un embed. Puedes construir un objeto `Embed` y usar `Message->addEmbed()` para incluirlo.
```php
$embed = new Embed();
$embed->setTitle("Embed Title Here");
$embed->setDescription("A very awesome description / Una descripción muy genial");
```
You can also add a footer:
También puedes añadir un pie de página:
```php
$embed->setFooter("Footer text / Texto del pie de página");
```
Finally, add the embed to the message:
Finalmente, agrega el embed al mensaje:
```php
$msg->addEmbed($embed);
```
---
## Example Code / Código de ejemplo:
```php
$webHook = new Webhook("YOUR WEBHOOK URL");
$msg = new Message();
$msg->setUsername("USERNAME");
$msg->setAvatarURL("https://cortexpe.xyz/utils/kitsu.png");
$msg->setContent("INSERT TEXT HERE");
$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.");
$msg->addEmbed($embed);
$webHook->send($msg);
```
---
**This API was made with ❤️ by CortexPE updated by Nozell. Enjoy!~ :3**
**Esta API fue hecha con ❤️ por CortexPE actualizado por Nozell. ¡Disfrútala!~ :3**