Skip to content

Commit 4f18938

Browse files
committed
feat: rewrite doc templates based on real script structure
Replaced the minimal placeholder templates with a richer generic structure modeled after real MRI scripts. Sections now cover main features, quick install, config, commands, exports (client/server), server/client modules, file structure, and troubleshooting — all with clear bracketed placeholders for the AI to fill in per-script.
1 parent e23547c commit 4f18938

2 files changed

Lines changed: 106 additions & 113 deletions

File tree

Lines changed: 54 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -1,103 +1,86 @@
1-
# Manual — Nome do Script
1+
# [Nome do Recurso] - Manual Funcional
22

3-
> Guia completo para instalação, configuração e uso do script.
3+
[Descrição curta do que o recurso oferece e para quem é destinado.]
44

5-
---
5+
## O que o recurso faz
66

7-
## O que este script faz
7+
[Descrição detalhada das funcionalidades principais, explicando o que o recurso oferece para o servidor e para os jogadores.]
88

9-
Descrição detalhada das funcionalidades principais, explicando o que o script oferece para o servidor e para os jogadores.
9+
## Funcionalidades principais
1010

11-
---
11+
- **[Funcionalidade 1]**: [Descrição detalhada].
12+
- **[Funcionalidade 2]**: [Descrição detalhada].
13+
- **[Funcionalidade 3]**: [Descrição detalhada].
1214

13-
## Requisitos
15+
## Como funciona
1416

15-
- **FiveM** atualizado
16-
- **ox_lib** instalado e iniciado antes deste recurso
17-
- **qbx_core** instalado e configurado
17+
1. [Passo 1 do fluxo principal].
18+
2. [Passo 2].
19+
3. [Passo 3].
1820

19-
---
21+
## Configurações disponíveis
2022

21-
## Instalação
23+
[Descreva as opções de configuração disponíveis em `shared/config.lua` ou equivalente.]
2224

23-
### 1. Download
25+
### Permissões
2426

25-
Baixe a última versão em **Releases** e extraia o conteúdo.
27+
[Se houver sistema de permissões, descreva os grupos e níveis de acesso disponíveis.]
2628

27-
### 2. Adicionar ao servidor
29+
## Comandos disponíveis
2830

29-
```
30-
resources/
31-
└── [mri]/
32-
└── nome-do-script/ ← pasta aqui
33-
```
34-
35-
### 3. server.cfg
36-
37-
```cfg
38-
ensure nome-do-script
39-
```
40-
41-
### 4. Configuração
42-
43-
Abra `shared/config.lua` e ajuste as opções conforme necessário (veja seção [Configuração](#configuração)).
44-
45-
---
46-
47-
## Configuração
48-
49-
### Config.Debug
50-
51-
```lua
52-
Config.Debug = false
53-
```
54-
55-
Ativa mensagens de debug no console do servidor e do cliente. Desative em produção.
31+
| Comando | Descrição |
32+
|---------|-----------|
33+
| `/[comando]` | [O que o comando faz]. |
5634

57-
### Config.MaxItems
58-
59-
```lua
60-
Config.MaxItems = 10
61-
```
35+
## Eventos
6236

63-
Define a quantidade máxima de itens que um jogador pode carregar.
37+
### Callbacks principais
6438

65-
---
39+
| Callback | Direção | Descrição |
40+
|----------|---------|-----------|
41+
| `[nome:do:callback]` | C→S | [O que faz]. |
6642

67-
## Comandos
43+
## Exports
6844

69-
### Para jogadores
45+
### Client
7046

71-
#### `/comando`
47+
| Export | Parâmetros | Retorno | Descrição |
48+
|--------|------------|---------|-----------|
49+
| `[ExportName]` | [params ou -] | [tipo ou -] | [O que faz]. |
7250

73-
Descrição do que o comando faz para o jogador.
51+
### Server
7452

75-
**Uso:** `/comando [argumento]`
53+
| Export | Parâmetros | Retorno | Descrição |
54+
|--------|------------|---------|-----------|
55+
| `[ExportName]` | [params ou -] | [tipo ou -] | [O que faz]. |
7656

77-
---
57+
## Módulos Server
7858

79-
### Para administradores
59+
| Módulo | Funcionalidade |
60+
|--------|---------------|
61+
| `main.lua` | Lógica principal do servidor. |
8062

81-
#### `/admincomando [id]`
63+
## Módulos Client
8264

83-
Descrição do que o comando administrativo faz.
65+
| Módulo | Funcionalidade |
66+
|--------|---------------|
67+
| `main.lua` | Entry point do cliente. |
8468

85-
**Uso:** `/admincomando 1`
86-
**Permissão:** `admin`
69+
## Exemplos práticos
8770

88-
---
71+
### [Título do exemplo 1]
8972

90-
## Perguntas frequentes
91-
92-
**O script não inicia, o que verifico?**
93-
Confirme que todas as dependências estão listadas antes deste recurso no `server.cfg`.
73+
```lua
74+
[Código de exemplo mostrando uso típico do recurso]
75+
```
9476

95-
**Como desativar as notificações?**
96-
Defina `Config.Notificacoes = false` no `shared/config.lua`.
77+
### [Título do exemplo 2]
9778

98-
---
79+
```lua
80+
[Outro exemplo prático relevante]
81+
```
9982

100-
## Suporte
83+
## Solução de problemas
10184

102-
- Discord: [MRI Qbox Brasil](https://discord.gg/uEfGD4mmVh)
103-
- Issues: abra uma issue no repositório do GitHub
85+
- **[Problema comum 1]**: [Como resolver].
86+
- **[Problema comum 2]**: [Como resolver].
Lines changed: 52 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,65 +1,75 @@
1-
# Nome do Script
1+
# [Nome do Recurso]
22

3-
> Descrição curta e objetiva do que o script faz.
3+
[Descrição curta e objetiva do que o recurso faz.]
44

5-
![FiveM](https://img.shields.io/badge/FiveM-GTA%20V-green?style=flat-square)
6-
![Lua](https://img.shields.io/badge/Lua-5.4-orange?style=flat-square)
7-
![MRI Qbox](https://img.shields.io/badge/MRI%20Qbox-Brasil-blue?style=flat-square)
5+
## Principais recursos
86

9-
---
7+
- **[Feature principal 1]**[Descrição].
8+
- **[Feature principal 2]**[Descrição].
9+
- **[Feature principal 3]**[Descrição].
1010

11-
## Dependências
11+
## Instalação rápida
1212

13-
| Recurso | Obrigatório |
14-
|---------|-------------|
15-
| `ox_lib` | Sim |
16-
| `qbx_core` | Sim |
13+
1. Copie a pasta `[nome_recurso]` para a pasta de resources do servidor.
14+
2. [Passos adicionais, ex: build do frontend se houver NUI]
15+
3. Adicione `ensure [nome_recurso]` no `server.cfg` (após as dependências obrigatórias).
16+
4. [Execute o script SQL se houver banco de dados]
1717

18-
---
19-
20-
## Instalação
18+
## Configuração
2119

22-
1. Adicione a pasta do recurso em `resources/[mri]/`
23-
2. Adicione `ensure nome-do-script` no `server.cfg`
24-
3. Configure o arquivo `shared/config.lua`
25-
4. Reinicie o servidor
20+
### Dependências obrigatórias
2621

27-
---
22+
- `[dependência]`[Para que é utilizada].
2823

29-
## Configuração
24+
[Se houver banco de dados, descreva o schema e as tabelas aqui.]
3025

31-
| Opção | Tipo | Padrão | Descrição |
32-
|-------|------|--------|-----------|
33-
| `Config.Debug` | `boolean` | `false` | Ativa logs de debug no console |
34-
| `Config.MaxItems` | `number` | `10` | Quantidade máxima de itens permitidos |
26+
### Permissões
3527

36-
---
28+
[Se houver sistema de permissões, descreva os grupos e níveis de acesso aqui.]
3729

3830
## Comandos
3931

40-
| Comando | Permissão | Descrição |
41-
|---------|-----------|-----------|
42-
| `/comando` | Jogador | Descrição do que o comando faz |
43-
| `/admincomando` | Admin | Descrição do comando administrativo |
32+
| Comando | Descrição |
33+
|---|---|
34+
| `/[comando]` | [O que o comando faz]. |
35+
36+
## Exports
37+
38+
### Client
39+
40+
| Export | Descrição |
41+
|---|---|
42+
| `[ExportName]` | [O que faz]. |
43+
44+
### Server
4445

45-
---
46+
| Export | Descrição |
47+
|---|---|
48+
| `[ExportName]` | [O que faz]. |
4649

47-
## Eventos
50+
## Server Modules
4851

49-
### Client → Server
52+
| Módulo | Descrição |
53+
|---|---|
54+
| `main.lua` | Lógica principal do servidor. |
5055

51-
| Evento | Parâmetros | Descrição |
52-
|--------|-----------|-----------|
53-
| `script:client:acao` | `data: table` | Descrição do evento |
56+
## Client Modules
5457

55-
### Exports
58+
| Módulo | Descrição |
59+
|---|---|
60+
| `main.lua` | Entry point do cliente. |
5661

57-
| Export | Retorno | Descrição |
58-
|--------|---------|-----------|
59-
| `exports['script']:funcao()` | `boolean` | Descrição do export |
62+
## Estrutura de arquivos 📁
6063

61-
---
64+
```
65+
[nome_recurso]/
66+
├── client/
67+
├── server/
68+
├── shared/
69+
[└── web/ # Apenas se houver NUI]
70+
└── fxmanifest.lua
71+
```
6272

63-
## Licença
73+
## Observações importantes ⚠️
6474

65-
MIT License — MRI Qbox Team Brasil
75+
- [Observação técnica ou de uso relevante para quem for instalar ou usar o recurso.]

0 commit comments

Comments
 (0)