Developer Preview

Resource manifest

Every key you can use in resource.toml.

Developer Preview. Scripting is live on Neighborly servers – everything on these pages works today. The API is young, so tell us what you need next on Discord.

resource.toml sits in the root of every resource. It uses TOML – simple key = value lines, strings in double quotes and lists in square brackets. Only name and version are required.

All keys

KeyTypeRequiredExampleDescription
namestringYes"rtx_cafe"The resource name. Must match the folder name. Lowercase letters, numbers, _ and -.
versionstringYes"1.2.0"Your version in major.minor.patch form. Shown in the console and used by dependencies.
authorstringNo"RTX Development"Who made it. Shown when the resource starts.
descriptionstringNo"Café job with tips"A short description for server owners.
repositorystringNo"https://github.com/you/rtx_cafe"Where people can find updates or report bugs.
client_scriptsstring[]No["client/*.lua"]Lua files loaded on every player's PC, in order. Glob patterns like client/*.lua and client/**.lua are allowed.
server_scriptsstring[]No["server/main.lua"]Lua files loaded on the server, in order. Never sent to players.
shared_scriptsstring[]No["config.lua"]Lua files loaded on both sides before client and server scripts.
ui_pagestringNo"html/index.html"The HTML page shown in the overlay for this resource. See NUI.
filesstring[]No["html/**"]Extra files sent to players – everything your ui_page needs (CSS, JS, images, fonts) and data files read with LoadResourceFile on the client.
dependenciesstring[]No["neighborly", "rtx_bank>=2.0.0"]Resources that must be running first. They are started automatically. Add >=x.y.z to require a minimum version.
game_packsstring[]No["EP01", "GP02"]Packs this resource needs. It only starts if every pack is in the server's requiredPacks, so all players are guaranteed to have them.
optional_packsstring[]No["EP05"]Packs your resource can use when present. Check them at runtime with GetRequiredPacks.
neighborly_versionstringNo">=1.0.0"The minimum Neighborly server version your resource needs.
providestringNo"bank"Lets this resource satisfy dependencies on another name – useful for drop-in replacements.
escrow_ignorestring[]No["config.lua", "locales/*.lua"]Files that stay readable and editable when the resource is escrowed. See Asset escrow.

A complete example

This is the manifest of a mid-sized job resource with configuration, locales, a NUI page and a pack requirement:

resource.tomlTOML
name = "rtx_cafe"
version = "1.2.0"
author = "RTX Development"
description = "Run a café: brew coffee, serve customers, earn tips"
repository = "https://rtx.tebex.io"
neighborly_version = ">=1.0.0"

shared_scripts = ["config.lua", "locales/*.lua"]
client_scripts = ["client/*.lua"]
server_scripts = ["server/*.lua"]

ui_page = "html/index.html"
files = ["html/index.html", "html/style.css", "html/app.js", "html/img/*.webp"]

dependencies = ["neighborly", "rtx_bank>=2.0.0"]
game_packs = ["GP01"]
optional_packs = ["EP05"]

escrow_ignore = ["config.lua", "locales/*.lua"]

Coming from FiveM: fxmanifest.lua

If a resource has no resource.toml, Neighborly reads fxmanifest.lua instead, so FiveM-style manifests work as they are. The keys are the same as above; singular forms like client_script and dependency are added to their lists, and keys Neighborly doesn't use – fx_version, game, lua54 – are kept as metadata and otherwise ignored. When both files exist, resource.toml wins.

fxmanifest.luaLUA
fx_version 'cerulean'
game 'sims4'

author 'RTX Development'
version '1.2.0'
description 'Café job with tips'

shared_script 'config.lua'
client_scripts { 'client/*.lua' }
server_script 'server/main.lua'

ui_page 'html/index.html'
files { 'html/**' }

dependencies { 'neighborly', 'rtx_bank >= 2.0.0' }

Load order

  1. All dependencies are started (recursively).
  2. shared_scripts run, in the order listed.
  3. server_scripts run on the server; on each player's PC client_scripts run.
  4. onResourceStart fires on both sides with your resource name.

Files matched by a glob pattern load in alphabetical order. If one file must run before another, list it explicitly first: ["client/utils.lua", "client/*.lua"] – files are never loaded twice.

Packs

Neighborly servers declare their packs in requiredPacks in server.json, and every player must own all of them to join. That's what makes game_packs safe: if your resource needs EP01 (Get to Work) and the server lists it, every player on that server has it.

If a server owner starts your resource without the pack, it refuses to start with a clear message:

> ensure rtx_cafe
Couldn't start rtx_cafe: it needs pack GP01 (Spa Day). Add "GP01" to requiredPacks in server.json.

Use optional_packs for features that are nice to have – for example rain-only drinks when Seasons (EP05) is on the server – and check with GetRequiredPacks.

Reading the manifest from code

GetResourceMetadata reads any key, including your own custom ones. Custom keys are ignored by Neighborly, so you can store things like a support link:

local version = GetResourceMetadata(GetCurrentResourceName(), 'version', 0)
print(('rtx_cafe %s loaded'):format(version))