# Criar plugins

> Construir um plugin, passar pela revisão e ganhar com o prompt que ele acrescenta.

Source: https://reverie.im/pt/docs/plugins/creating-plugins
Language: pt

Qualquer pessoa logada pode escrever um plugin. Abra uma conversa, vá até a aba **Plugins** do painel lateral e aperte **Criar Plugin**. O editor percorre três passos: **Tipo**, **Básico** e **Configuração**.

## Escolha um tipo \[#pick-a-type]

Dos quatro tipos de plugin, você pode criar três. O quarto ajusta as configurações de amostragem do modelo e pertence à Reverie.

| Tipo                     | O que você escreve                                                                                                                                              | Limites                                                                                                                                                               |
| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Plugin de Prompt**     | Um modelo de prompt, escrito em Handlebars, que é acrescentado ao prompt de sistema do personagem                                                               | Modelo de até 100.000 caracteres                                                                                                                                      |
| **Plugin de Ferramenta** | Um modelo de prompt mais uma definição de ferramenta: nome, descrição, parâmetros de entrada, estrutura de saída e, opcionalmente, um modelo de cartão HTML/CSS | O nome da ferramenta começa com letra e usa letras, dígitos e sublinhados, até 64 caracteres; a descrição até 2.000; o modelo de cartão e os estilos até 100.000 cada |
| **Plugin Interativo**    | Um identificador e ao menos um destes: um botão de disparo com formulário, uma superfície gerada por IA ou uma ferramenta que a IA possa chamar                 | Identificador de até 80 caracteres, letras/dígitos/hífen/sublinhado, começando por letra ou dígito                                                                    |

O tipo não pode ser mudado depois — **O tipo de plugin não pode ser alterado durante a edição**.

> Um plugin de ferramenta não faz nenhuma requisição de rede. Quando o modelo
> chama a sua ferramenta, é o modelo que inventa os argumentos, e a sua
> estrutura de saída e o seu modelo de cartão apenas arrumam esses valores
> inventados para exibição. Escreva ferramentas que apresentem informação —
> painéis de status, medidores, inventários, rolagens de dados — não
> ferramentas que digam consultar alguma coisa.

## Preencha o básico \[#fill-in-the-basics]

**Nome do Plugin** é obrigatório, até 100 caracteres. \**Descrição (Opcional)*\* vai até 1.000.

Há dois interruptores aqui, e eles são independentes — você pode ligar um, os dois ou nenhum:

| Interruptor                      | Efeito                                                                                                 |
| -------------------------------- | ------------------------------------------------------------------------------------------------------ |
| **Tornar Plugin Público**        | Manda essa versão para revisão. Uma vez aprovada, ela é listada na aba **Comunidade** para todo mundo. |
| **Associar ao Personagem Atual** | Restringe o plugin às conversas com o personagem em cuja conversa você está.                           |

O pedido de conteúdo de uma superfície gerada por IA é um modelo como o de um prompt: pode usar os mesmos marcadores, como `{{char}}`, `{{user}}` e `{{date}}`, e as configurações que você expõe a quem instala. A página produzida é composta por um conjunto fixo de componentes (cabeçalhos, parágrafos, citações, blocos de estatísticas, barras de progresso, linhas do tempo, etiquetas, listas de fatos, balões de diálogo, grades de escolha, imagens, um bloco oculto recolhido, botões e um campo de texto em que o leitor pode escrever), e escolhe sua aparência pelo significado: um tom, um estilo de cartão (simples, papel, vidro ou moldura) e uma densidade, todos seguindo o tema do leitor. As imagens vêm do próprio chat (o retrato ou o banner do personagem, o avatar do leitor, a arte do cenário ou do momento) e uma página não pode apontar para mais nada. Seus botões podem falar pelo leitor, dar uma indicação de cena que o personagem interpreta, sortear um resultado no dispositivo do leitor, abrir uma página mais profunda, atualizar a página no lugar ou fechá-la. A hora atual e o cânone do mundo do personagem são fornecidos automaticamente.

## Comece a partir de um exemplo \[#start-from-an-example]

**Carregar Exemplo** abre um catálogo de pontos de partida — Dinâmica de relação, Configuração de cena, Livro de saberes / Banco de memória, Painel de status do personagem, Medidor de afeto, Dados / Teste de perícia, Avanço Temporal, Diário do Personagem, Pensamentos Internos, Verdade ou Desafio e outros, agrupados por categoria.

São modelos para o editor, não plugins que alguém instalou. Escolher um preenche os campos de configuração para você editar a partir de algo que já funciona; nada disso é compartilhado ou publicado até você salvar e publicar o seu próprio plugin.

## Deixe a IA rascunhar \[#let-ai-draft-it]

Cada tipo tem um ajudante de IA — **Gerar com IA** para um modelo de prompt com variáveis, e equivalentes para as configurações de ferramenta e interativa. Você descreve o que quer em uma ou duas frases e o editor preenche os campos. As configurações que você expõe a quem instala também podem ser preenchidas assim, pelo **Preenchimento de Configuração por IA**. Cada geração gasta créditos.

## Visualizar e Depurar são coisas diferentes \[#preview-and-debug-are-different]

|                | **Visualizar**                                                                                                                | **Depurar**                                                                                                        |
| -------------- | ----------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ |
| O que faz      | Renderiza o seu modelo com valores de teste que você digita — o nome do personagem vem como *Alice*, o do usuário como *User* | Roda de verdade o rascunho não salvo contra o personagem de cuja conversa você abriu o editor                      |
| O que mostra   | O prompt gerado, o prompt de sistema e a saída renderizada                                                                    | A resposta do personagem, a saída da ferramenta renderizada, o rastro de execução, o modelo, a duração e os tokens |
| Contexto usado | Só marcadores                                                                                                                 | Um retrato do personagem, do cenário, da identidade, das memórias, das mensagens recentes e dos plugins ligados    |
| Custo          | Grátis                                                                                                                        | Grátis — nenhum crédito é cobrado                                                                                  |
| Cota           | Ilimitada                                                                                                                     | 30 execuções a cada 3 horas; o diálogo mostra quantas restam                                                       |

Depurar ainda limita a mensagem de teste a 1.000 caracteres e a configuração de teste a 50.000. Um plugin de ferramenta só pode ser depurado num modelo que suporte chamada de ferramenta.

## Publicação e revisão \[#publishing-and-review]

Salvar um plugin privado o torna usável na hora — por você — e ele fica instalado na conversa de onde você o criou. Ligar **Tornar Plugin Público** manda essa versão para revisão:

1. O cartão mostra **Aguardando Aprovação** na sua aba **Meus**, e mais ninguém consegue instalá-lo.
2. Uma pré-checagem automática roda em intervalos programados e registra seu veredito.
3. Uma pessoa aprova ou rejeita. Plugins aprovados mostram **Aprovado** e aparecem na aba **Comunidade**.

Editar um plugin aprovado cria uma nova versão, que passa pela revisão de novo — o cartão volta para **Aguardando Aprovação** enquanto a versão aprovada antes continua rodando para todos que a instalaram.

> Cada salvamento congela uma cópia imutável do plugin, traduções incluídas. As
> instalações rodam a cópia que fixaram, então quem instalou a versão 2 fica na
> versão 2 até apertar atualizar. O que um personagem já traz só pode fixar uma
> versão que passou pela revisão.

## O que você ganha \[#what-you-earn]

Quando outra pessoa usa o seu plugin numa mensagem paga, você ganha **5% do custo em créditos do texto que o seu próprio plugin acrescenta ao prompt** — não 5% da mensagem. O valor são os tokens de prompt do próprio plugin, multiplicados pelo multiplicador de créditos do modelo, vezes 5%, ajustados pela fatia daquela mensagem que foi paga com créditos pagos.

Nada é gerado quando:

| Caso                                                 | Por quê                                                                   |
| ---------------------------------------------------- | ------------------------------------------------------------------------- |
| O plugin é oficial                                   | Os plugins da própria Reverie não pagam comissão                          |
| Você usa o seu próprio plugin                        | Não há autopagamento                                                      |
| O plugin não tem modelo de prompt                    | Plugins interativos não ganham nada — eles não acrescentam nada ao prompt |
| A mensagem foi paga inteiramente com créditos grátis | A fatia paga é zero                                                       |

> **Plugins interativos nunca recebem comissão.** Se ganhar importa para você,
> construa um plugin de prompt ou de ferramenta — são os dois tipos que
> acrescentam texto ao prompt.

## Como você recebe \[#getting-paid]

As comissões se acumulam como créditos pendentes e são liquidadas **mensalmente, no dia 1º**. Se o seu saldo pendente estiver abaixo de **100 créditos** na liquidação, nada é pago naquele mês e o saldo rola para o seguinte.

**Ver Ganhos**, na aba **Meus**, mostra **Total Ganho**, **Pendente**, **Este Mês** e **Próxima Liquidação**, um detalhamento por plugin com receita, número de usos e data do último uso, além do seu histórico de liquidações.

## Relacionado \[#related]

* [Usar plugins](https://reverie.im/pt/docs/plugins/using-plugins) — como quem instala enxerga o seu trabalho
* [Plugins](https://reverie.im/pt/docs/plugins) — os três tipos, lado a lado
* [Fontes de receita](https://reverie.im/pt/docs/creators/revenue-streams) — os outros jeitos de um criador ganhar
* [Créditos](https://reverie.im/pt/docs/billing/credits) — o que é um crédito e como as mensagens são precificadas