> ## Documentation Index
> Fetch the complete documentation index at: https://docs.fivenetwork.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Apresentação

> Conheça o Five Livestream, o sistema de recompensas por transmissão ao vivo para servidores FiveM.

O **Five Livestream** recompensa jogadores por transmitir a cidade ao vivo na Twitch, Kick, YouTube ou TikTok. A detecção é automática, o tempo assistido é creditado sozinho, e o jogador troca esse tempo por metas, ranking e temporadas configuráveis por um painel visual. A vinculação de conta é um login oficial de verdade, feito na própria plataforma: sem o jogador digitar nome de canal, sem erro de digitação, sem canal fantasma.

## Funcionalidades

<CardGroup cols={2}>
  <Card title="Login oficial" icon="right-to-bracket">
    O jogador clica em "Vincular" e faz login de verdade na Twitch, YouTube, Kick ou TikTok, no navegador do sistema. A conta é confirmada pela própria plataforma. Nada é digitado a mão.
  </Card>

  <Card title="Detecção automática de live" icon="satellite-dish">
    A cada poucos minutos, o servidor confere quem está transmitindo o jogo certo com a tag certa no título, e credita o tempo sozinho, sem o jogador precisar avisar nada.
  </Card>

  <Card title="Metas com recompensa" icon="gift">
    Metas de horas acumuladas (ex: "5 horas → 2500 gemas"). Cada meta entrega uma ou mais recompensas: gemas, item, veículo, grupo/VIP ou caixa de loot.
  </Card>

  <Card title="Ranking por tempo" icon="crown">
    Classificação dos jogadores por tempo total transmitido, com premiação configurável por posição.
  </Card>

  <Card title="Temporada" icon="calendar-days">
    Um período com data de encerramento, editável pelo admin a qualquer momento.
  </Card>

  <Card title="Lives online" icon="tower-broadcast">
    Mostra quem da cidade está ao vivo agora, com a thumbnail real da transmissão, tanto dentro do painel do criador quanto num painel público dedicado (`/live`).
  </Card>

  <Card title="Painel administrativo" icon="sliders">
    Temporada, metas, ranking, canais vinculados e gestão de tempo, tudo por interface visual. Nenhum comando de chat é necessário no dia a dia.
  </Card>

  <Card title="Foto de perfil" icon="image">
    O avatar do jogador vem da própria conta vinculada. Sem nenhuma conta vinculada ainda, o painel mostra as iniciais do nome.
  </Card>
</CardGroup>

***

## Como funciona

<Steps>
  <Step title="O jogador vincula uma conta">
    Pelo comando `/painel`, aba "Visão geral". Ao clicar em "Vincular", abre o login oficial da plataforma no navegador do sistema. O jogador confirma e volta pro jogo.
  </Step>

  <Step title="A transmissão é detectada sozinha">
    O servidor confere periodicamente se algum canal vinculado está ao vivo jogando o jogo configurado com a tag certa no título.
  </Step>

  <Step title="O tempo é creditado">
    A cada checagem que bate, o tempo assistido é somado ao total do jogador. O placar atualiza sozinho, sem esperar o jogador reabrir o painel.
  </Step>

  <Step title="O jogador resgata metas">
    Na "Jornada do criador", cada meta atingida fica resgatável. O servidor sempre confere o tempo acumulado antes de entregar qualquer recompensa.
  </Step>
</Steps>

***

## Plataformas suportadas

O login e a detecção automática de live de todas as plataformas passam pela nossa API central — o script nunca fala direto com Twitch, YouTube, Kick ou TikTok.

| Plataforma  | Login | Detecção automática de live                |
| ----------- | ----- | ------------------------------------------ |
| **Twitch**  | Sim   | Sim, por categoria do jogo + tag no título |
| **Kick**    | Sim   | Sim, por categoria do jogo + tag no título |
| **YouTube** | Sim   | Sim, só por tag no título                  |
| **TikTok**  | Sim   | Não                                        |

<Info>
  Enquanto o app da TikTok estiver em revisão, só contas de teste cadastradas lá conseguem concluir o login; depois de aprovado, funciona pra qualquer jogador sem precisar mudar nada no script.
</Info>

***

## Sistema de recompensas

Cada meta ou posição de ranking entrega uma ou mais recompensas, escolhidas pelo administrador no próprio painel:

| Tipo          | Descrição                                                |
| ------------- | -------------------------------------------------------- |
| **Gemas**     | Credita a moeda do servidor                              |
| **Item**      | Entrega um item do inventário                            |
| **Veículo**   | Entrega um veículo                                       |
| **Grupo/VIP** | Concede um grupo ou permissão especial                   |
| **Caixa**     | Entrega uma caixa de loot, com arte própria por raridade |

Para os tipos Item e Veículo, o painel abre um **catálogo visual** (foto + nome, com busca e paginação) pra escolher direto da lista do servidor, em vez do admin precisar saber o ID de cabeça. Dá pra selecionar vários itens ou veículos de uma vez na mesma meta.

***

## Login das plataformas

Quando o jogador clica em "Vincular", o script abre a tela de login oficial da plataforma no navegador do sistema e aguarda a confirmação. Assim que o login é concluído, o painel atualiza sozinho com a conta vinculada.