One folder. One line.
Download your build from Billing, put the sculk folder in your server's resources directory, add two lines to server.cfg, then pair the server with your account. Players install nothing.
Requirements
- A FiveM server (FXServer) with OneSync turned on. Sculk needs it.
sculk doctormarks a server without OneSync as critical, and warns onlegacy. - A current FXServer artifact. Sculk reads the artifact and game build and shows them in
sculk doctor; use the recommended artifact from the Cfx.re download page. - A Sculk plan. Pairing needs one.
- Access to the server console (txAdmin's live console works) and to your Sculk dashboard.
Sculk has no framework or library dependency. It does not need ESX, QBCore, Qbox, ox_lib or anything else to run.
1. Download and unpack
Sign in, open Billing in the dashboard and choose Download latest build. The download notice shows the file name and its SHA-256. Copy the SHA-256 then, because the notice disappears after a few seconds, and compare it with the zip before you unpack it.
Each build is made for your organisation. It is watermarked, so do not share it or post it publicly. It also checks in with Sculk to stay valid: see how the protected build works.
Unzip it so the folder is named exactly sculk:
resources/
sculk/
fxmanifest.lua
config.lua
sculk.pak
...
Keep the folder name sculk. The compatibility packs and the commands below all use that name.
2. Edit server.cfg
set onesync on
# Allow your admins to run Sculk commands in game. The console always can.
add_ace group.admin sculk.admin allow
ensure sculk
Start order does not matter for frameworks. Sculk watches which resources are running and turns its compatibility packs on and off when they start or stop, so ensure sculk works before or after your framework. Keeping it after the framework in the file is tidy and the usual habit.
Optional: set sculk_log_level info prints routine lines to the console. The default is warn, so a healthy server prints almost nothing while you play.
3. Start the server and check it
Start (or restart) the server, then run this in the server console:
sculk doctor
It is read-only. It prints the resource version, OneSync state, artifact and game build, whether config.lua loaded (with the exact line of any mistake), the mode, a check of the convars that matter for security with a fix line for each, other anticheat resources it found running, and which compatibility packs are active. Fix anything marked critical or warn, then run it again.
In game, the same command needs the sculk.admin permission from step 2. To read recent events at any time, run sculk log (the newest 50, with times).
4. Pair the server
Until you pair it, Sculk makes no network calls at all. Pairing is what links the server to your account and gets the server its first lease. A downloaded build only starts its engine once it holds a valid lease, so pair before you judge whether it is working.
- Run
sculk_pairin the server console. It prints a code such asXXXX-XXXXand the address to enter it at. - In the dashboard, open Pair server, enter the code and a name for the server, and confirm. Pairing asks for your authenticator code.
- Within a few seconds the server gets its lease and the engine starts, with no restart. The server shows as online after its first heartbeat, and
sculk doctorshows the lease.
The code works once and expires after 10 minutes. If it runs out, run sculk_pair again. The console repeats the reminder every 5 minutes while a code is waiting.
5. Start in learning mode
A new install is in learning mode. For the first days Sculk records what normal play looks like on your server, logs everything and does nothing to a player beyond cancelling an event. Leave it there.
| Mode | What happens |
|---|---|
| learning | Everything is logged and baselines are recorded. Nothing above "cancel" ever happens to a player. Start here. |
| report | Shows what each detection would have done. Still no kicks or bans. |
| enforcing | Detections act. For 72 hours after a detection is enabled, its kicks and bans become staff warnings (probation). |
Review the learning report in the dashboard, check the detections that fire on your own scripts (garages, teleports, missions and similar), then move to report, and later to enforcing. The mode is the mode line in config.lua.
Framework notes
Sculk turns on the pack for the framework it finds running. You do not edit anything in the framework.
ESX. With es_extended running, Sculk enables its ESX pack: it reads the character and money events, so legitimate payouts and item changes are not flagged. esx_multicharacter is recognised, so switching characters is not treated as a teleport.
QBCore. With qb-core running, Sculk enables its QBCore pack: player load and unload, money and metadata changes, and revive and heal. qb-multicharacter is recognised too.
Qbox. With qbx_core running, only the Qbox pack is on, even if qb-core names are also present, so money is never counted twice.
Other resources. There is a pack for ox_core, and packs for some other inventories and admin tools (txAdmin, EasyAdmin, vMenu) that switch on the same way. ox_inventory is not adapted: sculk doctor says so. sculk doctor lists every pack as active or off and names the resource that turned it on. The full list and what each pack does is in the resource's compat documentation.
If a framework is running and its pack shows as off in sculk doctor, see Troubleshooting below.
Updating
- Download the new build from Billing.
- Stop the server, or run
stop sculkfirst. - Replace the
sculkfolder with the new one. Keep your ownconfig.lua(andlists.luaif you use owner lists): copy them back over the new files. Do not paste the new build'sconfig.luaover yours. - Start the server (or
ensure sculk) and runsculk doctor. It reports any line in yourconfig.luathat the new version does not accept, and refuses the whole file rather than half applying it.
You stay paired. The server's keys and clock floor are kept in the server's own key-value store, not in the build, so replacing the folder does not unpair it.
How the build stays valid
The build contains all the code that will ever run. Sculk fetches only a key and a short lease from its cloud, never code. A lease lasts 7 days and renews every time the server checks in, so a Sculk outage or a network problem of up to 7 days changes nothing, even across restarts. If the lease ends (no subscription, a revoked server, or no contact for over 7 days), the engine does not start and sculk doctor says why. Details are in the build security page.
Troubleshooting
Nothing printed after sculk doctor, or "Unknown command". The resource did not start. Read the start-up errors in the console, check the folder is named sculk and sits directly under resources, and that ensure sculk is in server.cfg.
onesync_off or onesync_legacy in the doctor report. Add set onesync on to server.cfg and restart.
A line from config.lua is refused. Sculk prints the exact line and does not enforce anything until it is fixed. Fix the line, run restart sculk, then sculk doctor.
The pairing code is rejected or expired. Codes work once and last 10 minutes. Run sculk_pair again and enter the new code. Pairing needs an active plan and your authenticator code.
The server is paired but shows offline. Check the heartbeat time in the dashboard, then run sculk log for the newest events. The server only makes outbound HTTPS requests to Sculk; allow them in your host's firewall.
It says the server is no longer paired. An owner unpaired it, or the server was removed. Run sculk_pair again.
The lease ran out, or a clock error appears. Fix the server's clock. A clock wound back more than 5 minutes is refused on purpose. Once the clock is right, restart the resource so it contacts Sculk again.
A framework pack shows as off. The pack turns on while the framework resource is started. Check that the framework resource is started (ensure it, or restart it), then run sculk doctor again.
You still need help. Send the whole output of sculk doctor to support, and never your pairing code, server licence key or rcon_password. See Contact.
Before changing a preset
Inspect the evidence, affected players and maximum action. Review your garage, teleport and mission resources for legitimate bursts. Heuristic checks cannot ban on their own.