O que é o kq_link? A ponte por trás dos scripts KuzQuality

Se você já instalou um script da KuzQuality, deve ter reparado que o kq_link aparece como dependência obrigatória. Este post explica o que ele é, por que existe e por que o padrão por trás dele é comum em toda a comunidade de scripts FiveM.

O problema: servidores FiveM não são padronizados

Servidores FiveM rodam em frameworks diferentes. Alguns usam ESX, outros QBCore, outros QBox, vRP, TMC ou algo totalmente personalizado. Além disso, cada servidor pode usar sistemas de inventário, de target e de notificação diferentes.

Um script que conversa direto com o ESX não funciona no QBCore sem mudanças no código. Um script que chama o ox_target quebra em um servidor que usa qb-target. E um script que usa um sistema de notificação vai ficar estranho em um servidor que usa outro.

Isso cria um problema para qualquer desenvolvedor que queira ver o seu trabalho rodando em mais de um tipo de servidor. A solução ingênua é escrever versões separadas para cada framework. Isso toma tempo e é difícil de manter. A solução melhor é uma ponte, a chamada bridge.

O que é uma bridge de script?

Uma bridge é um recurso que fica entre o script e as dependências do servidor. Em vez de o script chamar o ESX ou o QBCore diretamente, ele chama a bridge. A bridge descobre qual framework e quais dependências estão rodando e traduz a chamada de acordo.

Esse não é um conceito exclusivo da KuzQuality. A maioria dos desenvolvedores sérios de scripts FiveM usa algum tipo de bridge. Você já deve ter visto recursos parecidos, como ox_lib, jim_bridge, pp-bridge ou tw_bridge, listados como dependências de outros scripts. O princípio é o mesmo em todos eles: escreva o script uma vez e deixe a bridge cuidar das diferenças entre frameworks.

O que é o kq_link?

O kq_link é o recurso de bridge open source da KuzQuality. Ele conecta os scripts da KuzQuality a qualquer framework, sistema de inventário, sistema de target e sistema de notificação que o servidor estiver usando.

Na prática, é disso que ele cuida:

• Detecção de framework: identifica automaticamente se o servidor roda ESX, QBCore, QBox, vRP, TMC ou nenhum framework
• Integração com inventário: direciona as verificações, adições e remoções de itens para o sistema de inventário certo
• Sistema de notificação: envia as notificações pelo recurso de notificação que o servidor usa
• Sistema de target: funciona com ox_target, qb-target ou um fallback embutido de texto 3D
• Funções auxiliares: utilitários compartilhados dos quais os scripts da KuzQuality dependem, para que não precisem ser reimplementados em cada recurso

Como o kq_link cuida de tudo isso, nenhum script da KuzQuality precisa saber qual framework o servidor está rodando. O script só chama o kq_link, e o kq_link faz o resto.

Por que ele é um recurso separado?

O kq_link é instalado uma vez e compartilhado por todos os scripts da KuzQuality. Todo script do servidor que usa o kq_link aproveita a mesma bridge, em vez de cada script trazer a sua própria cópia do mesmo código.

Isso também significa que as atualizações de compatibilidade com frameworks só precisam acontecer em um lugar. Quando uma nova versão de um framework muda alguma coisa, o kq_link é atualizado e todos os scripts da KuzQuality se beneficiam automaticamente.

Como instalar o kq_link

O kq_link é grátis e open source. Ele está disponível no GitHub em github.com/Kuzkay/kq_link.

A instalação é simples:

1. Baixe ou clone o kq_link na pasta resources/ do servidor. A pasta precisa se chamar exatamente kq_link. Se você renomear, todos os scripts da KuzQuality que dependem dele vão quebrar.
2. Abra o server.cfg e adicione ensure kq_link depois do framework e de dependências como sistemas de target ou de notificação
3. Abra o kq_link/config.lua e defina o framework e as dependências

O kq_link tem detecção automática de framework, mas ainda assim é recomendado definir o framework manualmente na config para evitar qualquer ambiguidade.

Os detalhes completos da instalação estão em docs.kuzquality.com.

Resumo

Bridges de script são um padrão no desenvolvimento para FiveM. Elas resolvem o problema da fragmentação de frameworks funcionando como uma camada de tradução entre o script e as dependências do servidor.

O kq_link é a versão da KuzQuality dessa ideia. Ele é grátis, open source e obrigatório para todos os scripts da KuzQuality. Instale uma vez, configure de acordo com o setup do seu servidor e todos os scripts da KuzQuality vão funcionar, não importa qual framework esteja rodando.