Configurando fxmanifest.lua (FiveM)

Configurar um manifesto de recursos (fxmanifest.lua) é essencial para todos os recursos FiveM, incluindo mapas, scripts e outros tipos de conteúdo. fxmanifest.lua O arquivo serve como arquivo de configuração para seu recurso, especificando metadados, arquivos a serem carregados e scripts que devem ser executados no lado do cliente ou do servidor. Este guia ajudará você a fazer a transição do antigo __recurso.lua configuração para o mais moderno e flexível fxmanifest.lua sistema, que agora é o padrão para recursos FiveM.

O que é fxmanifest.lua?

fxmanifest.lua é o arquivo de configuração para recursos FiveM. Ele fornece informações sobre o recurso, especifica quais scripts carregar e define vários configurações necessário para que o recurso funcione corretamente em um servidor FiveM. O manifesto substitui o antigo __recurso.lua arquivo com uma abordagem mais estruturada, oferecendo melhor organização e flexibilidade.

Por que usar fxmanifest.lua?

O fxmanifest.lua sistema oferece várias vantagens sobre __recurso.lua:

• Melhor estrutura: fxmanifest.lua é mais organizado e permite que você use diferentes campos de metadados.
• Compatibilidade: Ele suporta novas compilações de jogos e inclui opções de compatibilidade com versões anteriores.
• Flexibilidade: Você pode definir dados adicionais e campos de metadados personalizados.

Estrutura básica de fxmanifest.lua

Antes de mergulhar na configuração, vamos entender a estrutura básica de um fxmanifest.lua arquivo. Abaixo está um exemplo típico:

-- Metadados de recursos
fx_version 'cerúleo'
jogos { 'gta5' }

autor 'Seu Nome ' -- opcional
descrição 'Uma breve descrição do seu recurso' -- opcional
versão '1.0.0' -- opcional

-- O que executar
scripts_cliente {
    'cliente.lua'
}
scripts_do_servidor {
    'servidor.lua'
}

-- Dados adicionais
arquivos {
    'dados/arquivo1.dat',
    'dados/arquivo2.dat'
}
arquivo_de_dados 'DLC_ITYP_REQUEST' 'stream/nome_do_recurso.ytyp'

Repartição das Seções

1. Metadados de recursos: Esta seção define as informações básicas sobre seu recurso, como a versão FX e os jogos suportados.
2. Roteiros: Especifica quais scripts devem ser executados no cliente ou servidor.
3. Dados adicionais: Seção opcional para especificar arquivos adicionais ou arquivos de dados.

Vamos explorar cada componente em detalhes.

---

Guia passo a passo para configuração fxmanifest.lua

Siga estas etapas para criar um fxmanifest.lua arquivo para seu recurso FiveM:

Etapa 1: Defina a versão FX

A primeira linha do seu fxmanifest.lua deve definir a versão FX. Isso é obrigatório e especifica qual versão do framework FiveM seu recurso está direcionando. Atualmente, as versões mais comuns são:

• ousado
• cerúleo
• inflexível

Use a seguinte linha para definir sua versão FX:

fx_version 'cerúleo'

Etapa 2: especifique os jogos suportados

O jogos seção especifica quais jogos seu recurso suporta. Normalmente, isso será:

• gta5 para Grand Theft Auto V
• rdr3 para Red Dead Redemption 2

Você pode especificar vários jogos, se necessário:

jogos { 'gta5' }

Etapa 3: Adicionar metadados de recursos (opcional)

Embora opcional, adicionar metadados como autor, descrição e versão é uma boa prática, pois ajuda outros desenvolvedores a entender do que se trata seu recurso. Veja como você pode adicionar metadados:

autor 'Seu Nome '
descrição 'Uma breve descrição do seu recurso'
versão '1.0.0'

Etapa 4: Configurar os scripts

Scripts do cliente

Defina os scripts que devem ser executados no lado do cliente. Use scripts do cliente para listar estes:

scripts_cliente {
    'cliente.lua',
    'client_additional.lua' -- Adicione mais scripts se necessário
}

Scripts de Servidor

Defina os scripts que devem ser executados no lado do servidor. Use scripts do servidor para listar estes:

scripts_do_servidor {
    'servidor.lua',
    'server_helper.lua' -- Scripts adicionais do lado do servidor
}

Etapa 5: Adicionar arquivos ao recurso

Se o seu recurso incluir arquivos adicionais, como imagens, arquivos de dados ou arquivos de áudio, especifique-os usando o arquivos seção:

arquivos {
    'html/ui.html',
    'html/estilo.css',
    'html/script.js'
}

Etapa 6: Use arquivos de dados

Certos recursos exigem arquivos de dados para carregar recursos de mapa, animações ou outros dados personalizados. Use o arquivo_de_dados diretiva para especificar estes:

arquivo_de_dados 'DLC_ITYP_REQUEST' 'stream/nome_do_recurso.ytyp'

Etapa 7: Especifique metadados adicionais (opcional)

Você pode adicionar campos de metadados personalizados para armazenar informações extras sobre seu recurso. Esses campos podem ser nomeados arbitrariamente, e você pode adicionar quantos quiser:

meus_dados_personalizados 'algum_valor'
outro_campo_personalizado 'outro_valor'

Casos especiais e opções adicionais

Configurando mapas em fxmanifest.lua

Para mapas, é essencial especificar que o recurso é de fato um mapa. Use o este_é_um_mapa diretiva:

este_é_um_mapa 'sim'

Usando várias versões do jogo

Se o seu recurso precisar oferecer suporte a vários jogos (por exemplo, GTA V e Red Dead Redemption 2), especifique-os no jogos seção:

jogos { 'gta5', 'rdr3' }

Definindo Dependências

Se o seu recurso depender de outros recursos, você poderá especificar essas dependências usando o dependências campo:

dependências {
    'modo essencial',
    'outro_recurso_necessário'
}

Exemplo completo de fxmanifest.lua

Aqui está um exemplo completo de um fxmanifest.lua arquivo que inclui todos os aspectos que discutimos:

-- Metadados de recursos
fx_version 'cerúleo'
jogos { 'gta5' }

autor 'Seu Nome '
descrição 'Exemplo de recurso para um script personalizado'
versão '1.0.0'

-- Configurações de recursos
este_é_um_mapa 'sim'

-- Scripts de cliente e servidor
scripts_cliente {
    'cliente/main.lua',
    'cliente/auxiliar.lua'
}
scripts_do_servidor {
    'servidor/main.lua',
    'servidor/banco de dados.lua'
}

-- Recursos da IU e arquivos adicionais
arquivos {
    'html/ui.html',
    'html/estilo.css',
    'html/script.js',
    'áudio/trilha sonora.mp3'
}

-- Arquivos de dados para ativos de mapas personalizados
arquivo_de_dados 'DLC_ITYP_REQUEST' 'stream/my_custom_map.ytyp'

-- Campos de metadados personalizados
custom_info 'Informações extras sobre o recurso'
configuração_aleatória 'valor_aleatório'

-- Recursos de dependência
dependências {
    'modo essencial',
    'mysql-async'
}

---

Solução de problemas comuns

Problema 1: Recurso não está carregando

• Verifique a versão FX: Certifique-se de que o versão_fx está especificado corretamente e corresponde a uma versão válida.
• Garanta os caminhos de arquivo corretos: Verifique novamente se todos os caminhos no scripts do cliente, scripts do servidor, e arquivos as seções são precisas.

Problema 2: Dados personalizados não funcionam

• Garanta a sintaxe correta: Verifique se os campos de metadados personalizados e os arquivos de dados estão configurados usando a sintaxe correta. Por exemplo, certifique-se de que você está usando chaves {} quando necessário.

Problema 3: Mapa não carrega

• Definir este_é_um_mapa Apropriadamente: Certifique-se de ter incluído este_é_um_mapa 'sim' em seu fxmanifest.lua.
• Use arquivos de dados corretos: Se você estiver carregando ativos de mapa personalizados, certifique-se de que arquivo_de_dados as diretivas são definidas com precisão.

Perguntas frequentes

P: O que o fxmanifest.lua deve incluir?
R: fx_version, jogo, seus scripts cliente/servidor/compartilhados e arquivos que você transmite.

P: O que é cliente, servidor e compartilhado?
R: O cliente é executado nos jogadores, o servidor é executado no host e as cargas compartilhadas são executadas em ambos.

P: Como declaro dependências?
R: Use a dependência 'nome' ou as dependências {'a','b'} e garanta a ordem em server.cfg.

P: Como faço streaming de ativos?
R: Coloque os ativos em /stream e liste os arquivos conforme exigido pelo tipo de recurso.

P: Por que adicionar lua54 'sim'?
R: Habilita recursos e melhorias de desempenho do Lua 5.4.

P: Erros comuns de manifesto?
R: Caminhos/nomes errados, vírgulas ausentes, fx_version inválido ou nome de pasta incorreto.

P: Como exportar/importar funções?
R: Use exports/server_exports no manifesto e chame via exports['resourcename']:function().

P: E quanto a mapas/MLOs?
R: Use this_is_a_map 'yes' e declare entradas data_file para YTYPs, se necessário.

Conclusão

Configurando fxmanifest.lua é uma etapa direta, porém crucial, na criação e execução de recursos para um servidor FiveM. Ao seguir a estrutura e as recomendações descritas neste guia, você pode garantir que seus recursos estejam bem organizados, flexíveis e compatíveis com as últimas atualizações do FiveM. Certifique-se de testar sua configuração após fazer alterações e verifique novamente se há erros para manter tudo funcionando perfeitamente.

Com as dicas e exemplos fornecidos, você agora deve estar equipado para criar ou converter um fxmanifest.lua arquive qualquer recurso FiveM com facilidade.