Dokumentacja techniczna

Pliki projektu

Format studio.json, studio.lock, adapter.json i scene.json.

Pliki, które studio trzyma w projekcie obok kodu serwera. Tabele są z kodu studia, który je czyta i zapisuje, więc opisy pól są po angielsku. Pole ze znakiem ? może nie wystąpić.

studio.json

W głównym folderze projektu. Po nim studio poznaje projekt: nazwa, framework, wersja serwera i gry, port.

Pole Typ Opis
studio 1 Format version of this file.
name string Project name shown in the studio.
framework Framework none, qbox, esx, ox (ox_core) or qbcore; set when the project is made and never changed.
language? string Language of the project’s in-game texts (two-letter code); Claude writes in it and the studio warns about others. Default: the studio’s.
fxserver { build: string; url: string } Pinned FXServer artifact. The download URL contains a commit hash, so it is stored too.
fxserverPrevious? { build: string; url: string } The build before the last update, for going back in one click.
gameBuild number GTA V game build the server enforces (sv_enforceGameBuild), e.g. 3258.
onesync boolean OneSync on the local server.
port? number Local server port. Missing in projects from before it was configurable: 30120.
testCharacters? boolean Each studio player gets the ready character “Gracz N” instead of the framework’s character select and spawn screens. Missing: off; test characters require explicit opt-in.
lastCharacters? Record<string, string> The character each studio player last logged in on, by its framework id (“Graj” logs in on it again).

studio.lock

W głównym folderze projektu. Dokładne wersje resource’ów frameworka, paczek z GitHuba i z importu, oraz adapterów skopiowanych do projektu. Aktualizacja zostawia poprzednią wersję do powrotu jednym kliknięciem.

resources: resource po nazwie.

Pole Typ Opis
repo string GitHub repository (owner/name), or where the resource came from.
version string Release tag or commit installed.
url string The archive it was installed from.
sha256 string Checksum of that archive.
path string Folder of the resource in the project.
previous? object The version before the last update, kept in .studio/backups.
previous.version string
previous.url string
previous.sha256 string
previous.backup string
imported? boolean A resource of a server imported into the studio (importServer.ts): part of the project’s base.

adapters: adapter po id, { version, previous?, own? }; own znaczy, że to własny adapter projektu z adapters/<id>/. recipe: przepis txAdmina, z którego powstał projekt.

adapter.json

W folderze adaptera: adapters/<id>/ w projekcie (własny adapter) albo kopia w resources/[scene]/studio_scene/adapters/<id>/, z którą projekt działa bez studia.

Pole Typ Opis
id string Adapter id, the same as its folder name.
label? string Name shown in the studio (Co umie projekt).
resource? string The resource it works with: the adapter is active only when server.cfg starts this resource.
unless? string Not active while this other resource is started (e.g. the qb-core adapter while qbx_core runs).
contract? number Capability contract version it was written for (default 1).
priority? number Order when several adapters give the same capability: the lower number goes first (default 100); a choice in Co umie projekt wins over it.
server? string[] Capabilities its server.lua gives.
client? string[] Capabilities its client.lua gives.
imports? ManifestImport[] Lines a new resource can put in its fxmanifest.lua to use this resource (e.g. a shared_script with its library).
tattooShop? { file: string; after: string; template: string } A tattoo shop this resource reads from a Lua file: the studio writes file (from template, with {{list}} and {{resource}} filled in) into the resource and loads it in fxmanifest.lua right after the after script.
snippets? Record<string, { label: string; template: string; anim?: string }> Code to paste that uses this resource, per studio tool (ROADMAP-3, 2.5): the tool shows it as one more tab only when the resource is in the project. attachment: {{name}}, {{model}}, {{bone}}, {{x}} {{y}} {{z}}, {{rx}} {{ry}} {{rz}}, {{anim}} (the anim line with {{dict}} and {{clip}}, empty without an animation).
testConvars? Record<string, string> Convars for this resource on the studio’s own server while test characters are on (ROADMAP-3, phase 3), set before server.cfg: e.g. a character select switched off so the studio loads “Gracz N” itself.
patches? AdapterPatch[] Gracz 2 has Gracz 1’s Rockstar license, and frameworks drop a second player with a license already on the server. These exact one-line edits (in resource, the adapter’s own by default) skip that check only while the convar studio_player2 is on, which the studio sets while it runs Gracz 2. Applied before Gracz 2 starts.

scene.json

W resources/[scene]/studio_scene/. Obiekty sceny (propy, NPC, pojazdy, blipy, markery, strefy, drzwi) i włączone albo wyłączone IPL. Resource studio_scene czyta go w grze, także na serwerze bez studia.

Pole Typ Opis
version 1 Format version of this file.
objects SceneObject[] The scene’s objects, described below.
ipls? string[] IPL turned on in this scene (map parts, interiors) and IPL turned off.
iplsOff? string[]

objects: lista obiektów.

Pole Typ Opis
id string Unique within the scene; tools and mechanics refer to the object by it.
type 'prop' | 'ped' | 'vehicle' | 'blip' | 'marker' | 'zone' | 'door' prop, ped (NPC) and vehicle are entities in the game. blip, marker, zone and door are points the clients draw or switch: a map icon, a marker on the ground, an area scripts hear about, a door.
model string Model name (prop_barrier_work05, a_m_y_skater_01, adder); for a door the door’s model (or its hash). Empty for blip, marker, zone.
npc? object NPC: what it does where it stands.
npc.scenario? string GTA scenario, e.g. WORLD_HUMAN_SMOKING.
npc.anim? { dict: string; clip: string }
npc.invincible? boolean
npc.relationship? string Relationship group, e.g. COP, GANG_1, CIVMALE.
npc.path? [number, number, number][] Points it walks one after another, again and again (a patrol).
npc.speed? number Walking speed on the path: 1 walk, 2 run.
npc.prop? string Holds a prop: the name of an attachment (Przyczepienia).
npc.guard? number Guards its place within this many metres.
blip? object Map icon: sprite and colour ids from the FiveM docs; the label is name. radius: a circle on the map around it (m); job: only players with this job see it.
blip.sprite number
blip.color? number
blip.scale? number
blip.radius? number
blip.job? string
marker? object A marker drawn with DrawMarker: GTA type 0–43, scale per axis in metres (size: the same on all three, older scenes), colour RGBA, bobbing, turning to the camera, spinning, drawn on entities, a texture from a .ytd and how far it is seen. The object’s rot turns it.
marker.kind number
marker.size? number
marker.scale? [number, number, number]
marker.color? [number, number, number, number]
marker.bob? boolean
marker.faceCamera? boolean
marker.rotate? boolean
marker.onEntities? boolean
marker.texture? { dict: string; name: string }
marker.distance? number
zone? object Sphere scripts get events for (studio_scene:zoneEnter / zoneExit with name). show: drawn in the game by the studio’s bridge (Rysuj w grze); studio_scene ignores it.
zone.radius number
zone.points? [number, number][]
zone.minZ? number
zone.maxZ? number
zone.show? boolean
door? { locked: boolean; pair?: { model: string; pos: [number, number, number] } } A double door is one object: its second leaf (model hash or name, position) is pair.
pos [number, number, number] Position in the world: x, y, z.
rot [number, number, number] Rotation in degrees: pitch, roll, yaw (heading).
frozen? boolean Props stay where they are put unless this is false.
vehicleType? string For vehicles: automobile, bike, boat, heli, plane, submarine, trailer, train.
name? string Name shown in the scene tree.
group? string Folder in the scene tree (komisariat, szpital); no group: top level.
locked? boolean Cannot be selected or moved in the game (a floor you keep grabbing by mistake).
disabled? boolean Kept in scene.json but not put up in the game.
alpha? number Transparency as in GTA: 0 invisible … 255 solid (default).
collision? boolean false: players and cars go through it (default true).

Pytanie, na które tu nie ma odpowiedzi? Zadaj je na Discordzie.

Webexe Studio

Kliknij, żeby zobaczyć w 100%.