Skip to content

Commit 23ab807

Browse files
committed
Update README and package description
1 parent 7da3ffb commit 23ab807

File tree

3 files changed

+41
-48
lines changed

3 files changed

+41
-48
lines changed

README.md

Lines changed: 21 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,51 @@
11
# discord-screenshot
22

3-
<p>
4-
<a href="https://github.com/GHMatti/ghmattimysql/blob/master/license.md">
5-
<img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License">
6-
</a>
3+
<p align="center">
4+
<a href="https://github.com/GHMatti/ghmattimysql/blob/master/license.md">
5+
<img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License">
6+
</a>
7+
<a href="https://discord.gg/z6Yx9A8VDR">
8+
<img src="https://discordapp.com/api/guilds/514185816315265068/widget.png" alt="Chat">
9+
</a>
710
</p>
811

9-
<p>
10-
<a href="https://discord.gg/z6Yx9A8VDR">
11-
<img src="https://discordapp.com/api/guilds/514185816315265068/widget.png?style=banner2" alt="Chat">
12-
</a>
13-
</p>
14-
15-
> You can also read this README in [Portuguese](https://github.com/jaimeadf/discord-screenshot/blob/master/README.pt.md).
12+
> You can also read this in [Portuguese](https://github.com/jaimeadf/discord-screenshot/blob/master/README.pt.md).
1613
17-
`discord-screenshot` is a resource for [FiveM](https://fivem.net) that captures a screenshot of a player and upload it to a discord's webhook.
14+
`discord-screenshot` is a resource for [FiveM](https://fivem.net) that capture the screen of a player and upload it to a discord's webhook.
1815

19-
[![Showcase](https://img.youtube.com/vi/c9h40LoLky8/maxresdefault.jpg)](https://youtu.be/c9h40LoLky8)
16+
[![Showcase](https://yt-embed.herokuapp.com/embed?v=c9h40LoLky8)](https://youtu.be/c9h40LoLky8)
2017

21-
## Setup
18+
## Installation
2219
1. Make sure your 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.
2320
2. Extract the latest zip file at [releases](https://github.com/jaimeadf/discord-screenshot/releases) in your resources folder.
2421
3. Add `ensure screenshot-basic` and `ensure discord-screenshot` in your `server.cfg`.
2522
4. Adjust the [configuration](#configuration) of the resource in the `settings.json`.
2623

2724
## Configuration
2825

29-
* **webhookUrl**: The url of your discord's webhook.
30-
* **framework**: The framework you are using (`vrp` or `none`).
31-
* **commandName**: The command name.
32-
* **commandPermission**: The permission to use the command.
26+
* **webhookUrl** - The url of your discord's webhook.
27+
* **framework** - The framework you are using (`vrp` or `none`).
28+
* **commandName** - The command name.
29+
* **commandPermission** - The permission to use the command.
3330
* **screenshotOptions**
34-
* **encoding**: The file format (`png`, `jpg` or `webp`)
35-
* **quality**: The image quality from 0 to 1.
31+
* **encoding** - The file format (`png`, `jpg` or `webp`)
32+
* **quality** - The image quality from 0.0 to 1.0.
3633

37-
## Usage
34+
## Default usage
3835

3936
> **Note:** If you pass `-1` as target, the screen of all the players will be captured.
4037
4138
### Standalone
4239

4340
#### /screenshot &lt;player ou identifier&gt;
4441

45-
Can be used via console or by anyone with the ace permission `discord.screenshot`.
42+
Can be used via the server console or by anyone with the ace permission `command.screenshot`.
4643

4744
### vRP
4845

4946
#### /screenshot &lt;user_id&gt;
5047

51-
Can be used via console or by anyone with the permission `discord.screenshot`.
48+
Can be used via the server console or by anyone with the permission `command.screenshot`.
5249

5350
## Exports
5451

@@ -84,7 +81,7 @@ exports["discord-screenshot"]:requestClientScreenshotUploadToDiscord(
8481
},
8582
function(error)
8683
if error then
87-
return print("^7" .. error)
84+
return print(error)
8885
end
8986
print("Sent screenshot successfully")
9087
end

README.pt.md

Lines changed: 19 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,49 @@
11
# discord-screenshot
22

3-
<p>
4-
<a href="https://github.com/GHMatti/ghmattimysql/blob/master/license.md">
5-
<img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License">
6-
</a>
3+
<p align="center">
4+
<a href="https://github.com/GHMatti/ghmattimysql/blob/master/license.md">
5+
<img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License">
6+
</a>
7+
<a href="https://discord.gg/z6Yx9A8VDR">
8+
<img src="https://discordapp.com/api/guilds/514185816315265068/widget.png" alt="Chat">
9+
</a>
710
</p>
811

9-
<p>
10-
<a href="https://discord.gg/z6Yx9A8VDR">
11-
<img src="https://discordapp.com/api/guilds/514185816315265068/widget.png?style=banner2" alt="Chat">
12-
</a>
13-
</p>
14-
15-
1612
`discord-screenshot` é um resource para [FiveM](https://fivem.net) que captura a tela de um player e a upa para o webhook do discord.
1713

18-
[![Showcase](https://img.youtube.com/vi/c9h40LoLky8/maxresdefault.jpg)](https://youtu.be/c9h40LoLky8)
14+
[![Showcase](https://yt-embed.herokuapp.com/embed?v=c9h40LoLky8)](https://youtu.be/c9h40LoLky8)
1915

20-
## Setup
16+
## Instalação
2117
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)) estão atualizados.
2218
2. Extraia o último arquivo zip em [releases](https://github.com/jaimeadf/discord-screenshot/releases) na sua pasta resources.
2319
3. Adicione `ensure screenshot-basic` e `ensure discord-screenshot` no seu `server.cfg`.
2420
4. Ajuste a [configuração](#configuração) do resource no `settings.json`.
2521

2622
## Configuração
2723

28-
* **webhookUrl**: A url do seu webhook do discord.
29-
* **framework**: A framework que você está usando (`vrp` ou `none`).
30-
* **commandName**: O nome do comando.
31-
* **commandPermission**: A permissão para usar o comando.
24+
* **webhookUrl** - A url do seu webhook do discord.
25+
* **framework** - A framework que você está usando (`vrp` ou `none`).
26+
* **commandName** - O nome do comando.
27+
* **commandPermission** - A permissão para usar o comando.
3228
* **screenshotOptions**
33-
* **encoding**: O formato do arquivo (`png`, `jpg` ou `webp`)
34-
* **quality**: A qualidade da imagem de 0 a 1.
29+
* **encoding** - O formato do arquivo (`png`, `jpg` ou `webp`)
30+
* **quality** - A qualidade da imagem de 0.0 a 1.0.
3531

36-
## Uso
32+
## Uso padrão
3733

3834
> **Nota:** Se você passar `-1` como alvo, a tela de todos os jogadores será capturada.
3935
4036
### Standalone
4137

4238
#### /screenshot &lt;player ou identifier&gt;
4339

44-
Pode ser usado pelo console ou por qualquer um com a permissão ace `discord.screenshot`.
40+
Pode ser usado pelo console do servidor ou por qualquer um com a permissão ace `command.screenshot`.
4541

4642
### vRP
4743

4844
#### /screenshot &lt;user_id&gt;
4945

50-
Pode ser usado pelo console ou por qualquer um com a permissão `discord.screenshot`.
46+
Pode ser usado pelo console do servidor ou por qualquer um com a permissão `command.screenshot`.
5147

5248
## Exports
5349

@@ -130,7 +126,7 @@ exports["discord-screenshot"]:requestCustomClientScreenshotUploadToDiscord(
130126
},
131127
function(error)
132128
if error then
133-
return print("^7" .. error)
129+
return print(error)
134130
end
135131
print("Sent screenshot successfully")
136132
end

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "discord-screenshot",
33
"version": "1.3.1",
4-
"description": "A resource for FiveM and RedM that takes a screenshot of a player and uploads it to a discord's webhook.",
4+
"description": ":",
55
"main": "index.js",
66
"scripts": {
77
"dev": "webpack --watch --mode development",

0 commit comments

Comments
 (0)