element_sdk start on your server with no errors. It takes
about ten minutes. The product’s own installation page, in its tab, adds anything specific to it.
Before you start
- The product appears under Granted Assets on the Cfx.re portal, signed in with the account that bought it. A new purchase can take a few minutes to appear.
- Your server’s license key belongs to that same Cfx.re account. Otherwise the product does not start. See Licensing.
- Your server meets the product’s requirements. See Before you buy.
Steps
1
Download the product and element_sdk
On Granted Assets, download the product and
element_sdk. Both are free to download once
the product is on your account. If you already run another Element Labs product, you already
have element_sdk: download it again only if the product’s INSTALL.md asks for a newer version than
yours.2
Extract both into your resources folder
Put each in its own folder, side by side. A product that streams game files, such as models or
menus, comes with a second folder named after it with Each
_assets on the end; it goes beside the
product:fxmanifest.lua must sit directly inside its folder. Archives often extract into a folder of
their own, leaving element_3d_pausemenu/element_3d_pausemenu/fxmanifest.lua. If that happens,
move the inner folder up one level. A resource one level too deep is invisible to the server.The [element] folder only groups Element Labs resources together. The brackets tell FiveM to
look inside it for resources. Any location under resources works.3
Check the SDK version
The product’s
INSTALL.md names the element_sdk versions the release accepts, for example
^0.1.0. The version you have is the version line in element_sdk/fxmanifest.lua.
What the range means is in Versions and releases.4
Add them to server.cfg
After your framework, inventory and database, if you run them, and with the Why this order matters is in Start order.
_assets folder
just before its product:5
Run the integration installer, if the product has one
If the product’s
install folder contains files named windows-install-hooks-… and
linux-install-hooks-…, the product needs a line added to your other resources. Follow
Install an integration. Without them, skip this step.6
Restart the server
A full restart, not
refresh. Configuration and the resources a product works with are read
when it starts.Check that it worked
The console shows
element_sdk and the product starting, with no [ERROR] or [WARN ] line
naming either of them.Next steps
- How configuration works: change what the product does.
- Update a product: keep your edits when a new release comes out.