Merge pull request #3 from jaimeadf/develop

Update to 1.2

Author: jaimeadf

README.md

@@ -19,16 +19,18 @@ You can also read this README in [Portuguese](https://github.com/jaimeadf/discor
 
 `discord-screenshot` is a resource for [FiveM](https://fivem.net) and [RedM](https://redm.gg) that takes a screenshot of a player and uploads it to a discord's webhook.
 
+[![Showcase](https://img.youtube.com/vi/c9h40LoLky8/maxresdefault.jpg)](https://youtu.be/c9h40LoLky8)
+
 ## Installation
 
 1. Make sure your server artifacts ([windows](https://runtime.fivem.net/artifacts/fivem/build_server_windows/master) or [linux](https://runtime.fivem.net/artifacts/fivem/build_proot_linux/master)) are up to date.
-2. Download the latest file at [releases](https://github.com/jaimeadf/discord-screenshot/releases) and extract it at your resources folder.
-3. Add `ensure screenshot-basic` and `ensure discord-screenshot` in your server.cfg before your framework's start.
+2. Download the latest zip file at [releases](https://github.com/jaimeadf/discord-screenshot/releases) and extract it at your resources folder.
+3. Add `ensure screenshot-basic` and `ensure discord-screenshot` in your server.cfg.
 4. Configure the resource in the `settings.json` file inside the discord-screenshot folder.
 
 ## Usage
 
-A `/screenshot` command is created according to the framework you are using.
+A `/screenshot <target>` command is created according to the framework you are using. If you pass `-1` as target, a screenshot of everyone in the server will be taken.
 
 **It only works outside `localhost`!**
 
@@ -37,6 +39,11 @@ A `/screenshot` command is created according to the framework you are using.
 #### /screenshot &lt;player or identifier&gt;
 Can be used via console or by anyone with the `command.screenshot` ace permission.
 
+### ESX
+
+#### /screenshot &lt;player&gt;
+Can be used via console or by any admin.
+
 ### vRP
 
 #### /screenshot &lt;user_id&gt;
@@ -46,41 +53,65 @@ Can be used via console or by anyone with the `command.screenshot` permission.
 
 ### Server
 
-#### requestClientScreenshotDiscordUpload(player: string | number, webhookMessageAuthor?: DiscordWebhookMessageAuthor, webhookMessageContent?: string)
+#### requestClientScreenshotUploadToDiscord(player, webhookMessageDto)
 Takes a screenshot of the specified specific client and uploads it to the configured discord's webhook.
 
 Arguments:
-* **player**: The target player index.
-* **webhookMessageAuthor**: An optional object containing the webhook message author information.
-    * **name**: string? - An optional name for the author.
-    * **avatarUrl**: string? - An optional url for the author avatar.
-* **webhookMessageContent**: An optional text for the webhook message content.
+* **player**: string | number
+* **webhookMessageDto**: [WebhookMessageDto](https://birdie0.github.io/discord-webhooks-guide/discord_webhook.html)
 
 Example:
 ```lua
-exports['discord-screenshot']:requestClientScreenshotDiscordUpload(GetPlayers()[1], {
-    name = 'Screenshot',
-    avatarUrl = 'https://canary.discord.com/assets/f78426a064bc9dd24847519259bc42af.png'
-}, 'This is an example.')
+exports['discord-screenshot']:requestClientScreenshotUploadToDiscord(GetPlayers()[1], {
+    username = 'A cat',
+    avatar_url = 'https://cdn2.thecatapi.com/images/IboDUkK8K.jpg',
+    content = 'Meow!',
+    embeds = {
+        {
+            color = 16771584,
+            author = {
+                name = 'Wow!',
+                icon_url = 'https://cdn.discordapp.com/embed/avatars/0.png'
+            },
+            title = 'I can send anything.'
+        }
+    }
+})
 ```
 
-#### requestCustomClientScreenshotDiscordUpload(player: string | number, webhookUrl: string, webhookMessageAuthor?: DiscordWebhookMessageAuthor, webhookMessageContent?: string)
+#### requestCustomClientScreenshotUploadToDiscord(player, webhookUrl, webhookMessageDto)
 Takes a screenshot of the specified client and uploads it to the passed discord's webhook.
 
 Arguments:
-* **player**: The target player index.
-* **webhookUrl**: The discord's webhook url.
-* **webhookMessageAuthor**: An optional object containing the webhook message author information.
-    * **name**: string? - An optional name for the author.
-    * **avatarUrl**: string? - An optional url for the author.
-* **webhookMessageContent**: An optional text for the webhook message content.
+* **player**: string | number
+* **webhookUrl**: string
+* **options**: object
+  * **encoding**: 'png' | 'jpg' | 'webp'
+  * **quality**: number
+* **webhookMessageDto**: [WebhookMessageDto](https://birdie0.github.io/discord-webhooks-guide/discord_webhook.html)
 
 Example:
 ```lua
-exports['discord-screenshot']:requestCustomClientScreenshotDiscordUpload(GetPlayers()[1], 'https://canary.discord.com/api/webhooks/412884227131886566/qFcXr19SozY5Bej5H74RdbRscsOjH4eVxgJO5Iwh5iawmkpRfjzijezlwdu15wNsCk4w', {
-    name = 'Screenshot',
-    avatarUrl = 'https://canary.discord.com/assets/f78426a064bc9dd24847519259bc42af.png'
-}, 'This is an example.')
+local screenshotOptions = {
+    encoding = 'png',
+    quality = 1
+}
+
+exports['discord-screenshot']:requestCustomClientScreenshotUploadToDiscord(GetPlayers()[1], 'https://ptb.discord.com/api/webhooks/767824413780607097/WLjd77Y0CUvqXmhLCYzqkiZ-BrTpcGfNiZ7hXcJRgQxrU0YR8sy566MgMHgqRx8IZ9iu', screenshotOptions, {
+    username = 'A cat',
+    avatar_url = 'https://cdn2.thecatapi.com/images/IboDUkK8K.jpg',
+    content = 'Meow!',
+    embeds = {
+        {
+            color = 16771584,
+            author = {
+                name = 'Wow!',
+                icon_url = 'https://cdn.discordapp.com/embed/avatars/0.png'
+            },
+            title = 'I can send anything.'
+        }
+    }
+})
 ```
 
 ## Dependencies

README.pt.md

@@ -16,16 +16,18 @@
 
 `discord-screenshot` é um resource para [FiveM](https://fivem.net) e [RedM](https://redm.gg) que tira uma captura de tela de um player e a upa para um webhook do discord.
 
+[![Showcase](https://img.youtube.com/vi/c9h40LoLky8/maxresdefault.jpg)](https://youtu.be/c9h40LoLky8)
+
 ## Instalação
 
 1. Certifique-se que seus artefatos ([windows](https://runtime.fivem.net/artifacts/fivem/build_server_windows/master) ou [linux](https://runtime.fivem.net/artifacts/fivem/build_proot_linux/master)) estejam atualizados.
-2. Baixe o último arquivo em [releases](https://github.com/jaimeadf/discord-screenshot/releases) e extraia na sua pasta resources.
-3. Adicione `ensure screenshot-basic` e `ensure discord-screenshot` no seu server.cfg antes do start de sua framework.
+2. Baixe o último arquivo zip em [releases](https://github.com/jaimeadf/discord-screenshot/releases) e extraia na sua pasta resources.
+3. Adicione `ensure screenshot-basic` e `ensure discord-screenshot` no seu server.cfg.
 4. Configure o resource no arquivo `settings.json` dentro da pasta discord-screenshot.
 
 ## Uso
 
-Um comando `/screenshot` é criado de acordo com a framework que você está utilizando.
+Um comando `/screenshot <alvo>` é criado de acordo com a framework que você está utilizando. Se você passar `-1` como alvo, uma captura da tela de todos no servidor será tirada.
 
 **Ele só funciona fora de `localhost`!**
 
@@ -34,6 +36,11 @@ Um comando `/screenshot` é criado de acordo com a framework que você está uti
 #### /screenshot &lt;player ou identificador&gt;
 Pode ser usado via console ou por qualquer um com a permissão ace `command.screenshot`.
 
+### ESX
+
+#### /screenshot &lt;player&gt;
+Pode ser usado via console ou por qualquer admin.
+
 ### vRP
 
 #### /screenshot &lt;user_id&gt;
@@ -43,41 +50,65 @@ Pode ser usado via console ou por qualquer um com a permissão `command.screensh
 
 ### Servidor
 
-#### requestClientScreenshotDiscordUpload(player: string | number, webhookMessageAuthor?: DiscordWebhookMessageAuthor, webhookMessageContent?: string)
+#### requestClientScreenshotUploadToDiscord(player, webhookMessageDto)
 Tira uma captura de tela do cliente especificado e a envia para o webhook do discord configurado. 
 
 Argumentos:
-* **player**: O índice do player alvo.
-* **webhookMessageAuthor**: Um objeto opcional contendo as informações do autor da mensagem do webhook.
-    * **name**: string? - Um nome opcional para o autor.
-    * **avatarUrl**: string? - Uma url opcional para o avatar do autor.
-* **webhookMessageContent**: Um texto opcional para o contéudo da mensagem do webhook.
+* **player**: string | number
+* **webhookMessageDto**: [WebhookMessageDto](https://birdie0.github.io/discord-webhooks-guide/discord_webhook.html)
 
 Exemplo:
 ```lua
-exports['discord-screenshot']:requestClientScreenshotDiscordUpload(GetPlayers()[1], {
-    name = 'Screenshot',
-    avatarUrl = 'https://canary.discord.com/assets/f78426a064bc9dd24847519259bc42af.png'
-}, 'This is an example.')
+exports['discord-screenshot']:requestClientScreenshotUploadToDiscord(GetPlayers()[1], {
+    username = 'A cat',
+    avatar_url = 'https://cdn2.thecatapi.com/images/IboDUkK8K.jpg',
+    content = 'Meow!',
+    embeds = {
+        {
+            color = 16771584,
+            author = {
+                name = 'Wow!',
+                icon_url = 'https://cdn.discordapp.com/embed/avatars/0.png'
+            },
+            title = 'I can send anything.'
+        }
+    }
+})
 ```
 
-#### requestCustomClientScreenshotDiscordUpload(player: string | number, webhookUrl: string, webhookMessageAuthor?: DiscordWebhookMessageAuthor, webhookMessageContent?: string)
+#### requestCustomClientScreenshotUploadToDiscord(player, webhookUrl, webhookMessageDto)
 Tira uma captura de tela do cliente especificado e a envia para o webhook do discord passado.
 
 Argumentos:
-* **player**: O índice do player alvo.
-* **webhookUrl**: A url do webhook do discord.
-* **webhookMessageAuthor**: Um objeto opcional contendo as informações do autor da mensagem do webhook.
-    * **name**: string? - Um nome opcional para o autor.
-    * **avatarUrl**: string? - Uma url opcional para o avatar do autor.
-* **webhookMessageContent**: Um texto opcional para o contéudo da mensagem do webhook.
+* **player**: string | number
+* **webhookUrl**: string
+* **options**: object
+  * **encoding**: 'png' | 'jpg' | 'webp'
+  * **quality**: number
+* **webhookMessageDto**: [WebhookMessageDto](https://birdie0.github.io/discord-webhooks-guide/discord_webhook.html)
 
 Exemplo:
 ```lua
-exports['discord-screenshot']:requestCustomClientScreenshotDiscordUpload(GetPlayers()[1], 'https://canary.discord.com/api/webhooks/412884227131886566/qFcXr19SozY5Bej5H74RdbRscsOjH4eVxgJO5Iwh5iawmkpRfjzijezlwdu15wNsCk4w', {
-    name = 'Screenshot',
-    avatarUrl = 'https://canary.discord.com/assets/f78426a064bc9dd24847519259bc42af.png'
-}, 'This is an example.')
+local screenshotOptions = {
+    encoding = 'png',
+    quality = 1
+}
+
+exports['discord-screenshot']:requestCustomClientScreenshotUploadToDiscord(GetPlayers()[1], 'https://ptb.discord.com/api/webhooks/767824413780607097/WLjd77Y0CUvqXmhLCYzqkiZ-BrTpcGfNiZ7hXcJRgQxrU0YR8sy566MgMHgqRx8IZ9iu', screenshotOptions, {
+    username = 'A cat',
+    avatar_url = 'https://cdn2.thecatapi.com/images/IboDUkK8K.jpg',
+    content = 'Meow!',
+    embeds = {
+        {
+            color = 16771584,
+            author = {
+                name = 'Wow!',
+                icon_url = 'https://cdn.discordapp.com/embed/avatars/0.png'
+            },
+            title = 'I can send anything.'
+        }
+    }
+})
 ```
 
 ## Dependências

package.json

@@ -1,6 +1,6 @@
 {
   "name": "discord-screenshot",
-  "version": "1.1.5",
+  "version": "1.2",
   "description": "A resource for FiveM and RedM that takes a screenshot of a player and uploads it to a discord's webhook.",
   "main": "index.js",
   "scripts": {
@@ -13,18 +13,24 @@
     "@babel/plugin-transform-typescript": "^7.10.1",
     "@babel/preset-env": "^7.10.2",
     "@citizenfx/server": "^1.0.2613-1",
-    "@types/data-urls": "^2.0.0",
+    "@types/axios": "^0.14.0",
+    "@types/color": "^3.0.1",
     "@types/node": "^14.0.13",
+    "@types/whatwg-mimetype": "^2.1.0",
     "babel-loader": "^8.1.0",
     "copy-webpack-plugin": "^6.2.1",
+    "fivem-esx-js": "^0.1.12",
     "typescript": "^4.0.3",
     "webpack": "^4.44.2",
     "webpack-cli": "^3.3.12"
   },
   "dependencies": {
+    "axios": "^0.21.0",
+    "color": "^3.1.3",
     "cross-blob": "^2.0.0",
-    "data-urls": "^2.0.0",
     "form-data": "^3.0.0",
+    "http-status-codes": "^2.1.4",
+    "typescript-collections": "^1.3.3",
     "whatwg-mimetype": "^2.3.0"
   }
 }

src/server/DiscordScreenshot.ts

@@ -7,7 +7,7 @@ class Command {
         this.handler = handler;
 
         RegisterCommand(name, (player: number, args: string[], rawCommand: string) =>
-            this.handler?.execute(player, args, rawCommand), false);
+            this.handler?.execute(player.toString(), args, rawCommand), false);
     }
 
     public setHandler(handler: CommandHandler) {

src/server/commands/Command.ts

@@ -1,5 +1,5 @@
 interface CommandHandler {
-    execute(player: number, args: string[], rawCommand: string): Promise<void>;
+    execute(player: string, args: string[], rawCommand: string): Promise<void>;
 }
 
 export default CommandHandler;

src/server/commands/CommandHandler.ts

@@ -0,0 +1,32 @@
+import { ESXServer } from 'fivem-esx-js/server/esx_server';
+
+import ScreenshotCommandHandler from './ScreenshotCommandHandler';
+import ScreenshotTaker from '../../screenshot/ScreenshotTaker';
+import DiscordWebhook from '../../discord/DiscordWebhook';
+
+class EsxScreenshotCommandHandler extends ScreenshotCommandHandler {
+    private readonly _esx: ESXServer;
+
+    public constructor(screenshotTaker: ScreenshotTaker, discordWebhook: DiscordWebhook) {
+        super(screenshotTaker, discordWebhook);
+        this._esx = global.exports['es_extended'].getSharedObject();
+    }
+
+    public async execute(player: string, args: string[], rawCommand: string): Promise<void> {
+        if (player !== '0') {
+            const xPlayer = this._esx.GetPlayerFromId(parseInt(player));
+            if (xPlayer.getGroup() !== 'admin') {
+                return;
+            }
+        }
+
+        const target = args[0];
+        if (target === '-1') {
+            this.requestEveryoneScreenshotUploadToDiscord();
+        } else {
+            await this.requestClientScreenshotUploadToDiscord(target);
+        }
+    }
+}
+
+export default EsxScreenshotCommandHandler;