Home Guides
Guide · Fortgeschritten · ~20 Min.

FiveM Integration

Verbinde deinen FiveM-Server mit der yarn-Plattform über die yarn_sync Resource — API-Key aus dem Portal, fertig.

Was yarn_sync synchronisiert

  • Whitelist-Status automatisch synchronisieren
  • Spieler-Sync (Charakter, Jobs, Fraktionen)
  • Smart Logs via Discord-kompatibler Webhook-API
  • Bodycam-Uploads und Abruf
  • Mugshot-System
  • Live-Karte mit GPS-Positionen
01

API-Key im Portal abrufen

Öffne im Portal den Bereich FiveM & API. Dort findest du deinen API-Key (beginnt mit tk_live_…). Falls noch keiner vorhanden ist, klicke auf "Neuen Key erstellen".

Der Key wird nur beim Erstellen einmal im Klartext angezeigt. Kopiere ihn direkt in deine config.lua.
02

yarn_sync herunterladen

Lade die yarn_sync Resource direkt aus dem Portal herunter (FiveM & API → Download). Entpacke den Ordner in das resources/-Verzeichnis deines FiveM-Servers.

config.lua / server.cfg / Verzeichnis
server-data/
└── resources/
    └── yarn_sync/          ← hier hin
        ├── fxmanifest.lua
        ├── config.lua
        ├── client/
        └── server/
03

config.lua anpassen

Öffne yarn_sync/config.lua und trage die zentrale API-URL sowie deinen API-Key ein.

config.lua / server.cfg / Verzeichnis
-- config.lua
Config.ApiUrl = "https://api.yarn.netica.dev"
Config.ApiKey = "tk_live_..."  -- aus Portal → FiveM & API

-- Framework: "esx" | "qbcore" | "standalone"
Config.Framework = "esx"

-- Features aktivieren/deaktivieren
Config.Features = {
    whitelistSync = true,
    smartLogs     = true,
    bodycam       = true,
    mugshots      = true,
    gpsMap        = true,
}
04

Resource starten

Trage yarn_sync in deine server.cfg ein und starte den Server neu. Beim ersten Start prüft die Resource die Verbindung zur API automatisch.

config.lua / server.cfg / Verzeichnis
# server.cfg
ensure yarn_sync

Smart Logs Webhook-URL

yarn akzeptiert Discord-kompatible Webhooks. Nutze diese URL direkt in deinem FiveM-Framework oder in txAdmin.

https://api.yarn.netica.dev/webhooks/{TENANT_SLUG}?key=tk_live_...

API-Key aus Portal → FiveM & API. Tenant-Slug findest du in der URL deines Portals.