Documentation

Getting started

Eclipse Scripts sells digital FiveM resources delivered through Cfx.re Keymaster. After purchase, assets appear on the Keymaster account tied to the FiveM / Cfx.re login you used at checkout.

• 1

  Create or use your Cfx.re account

  You need a FiveM / Cfx.re login for Keymaster delivery. This is separate from Discord, even if you also connect Discord for roles.
• 2

  Login on this store

  Use Login with FiveM in the header before adding scripts to your basket. Game stores require an authorized basket.
• 3

  Buy and install

  Complete checkout with Tebex, then follow Keymaster and installation below.

Purchase flow

Payments are processed by Tebex (merchant of record). Eclipse Scripts sells the digital resources; Tebex handles checkout and billing.

• FiveM login - required for Keymaster delivery. Purchase with the Cfx.re account that owns your server license key.
• Discord - after purchase, open #claim-role and use Verify Purchase with your Tebex transaction ID (tbx-...) to get the customer role.

Accessing Keymaster

Escrow and licensed products are delivered via Keymaster - not as direct zip downloads from this storefront.

Installing a resource

1. 1

   Download from Keymaster

   Get the asset zip for your purchase.
2. 2

   Extract into resources

   Place the folder in your server resources directory. Keep the folder name exactly as shipped (it must match fxmanifest.lua).
3. 3

   Start dependencies first

   Framework and shared libs (for example ox_lib, es_extended, qb-core, or qbx_core) must start before the Eclipse Scripts resource.
4. 4

   Ensure in server.cfg

   Add an ensure line, then restart the server or start the resource.

# Shared / framework (examples - use what your server runs)
ensure ox_lib
ensure es_extended
# ensure qb-core
# ensure qbx_core

# Eclipse Scripts resource
ensure eclipse_resource

server-data/
  resources/
    [local]/
      eclipse_resource/
        fxmanifest.lua
        ...
    [standalone]/
      ox_lib/
    [framework]/
      es_extended/

Configuration

Most products ship with a readable config file (often config.lua or shared/config.lua). Escrow encrypts core logic - config and locale files usually stay editable.

• Read the product page for dependencies and framework notes.
• Edit config before going live (locales, jobs, items, webhooks).
• Restart the resource (or server) after editing config files.
• Keep a backup of your config before updating from Keymaster.

Illenium Appearance Redesign

Redesign of illenium-appearance: modern clothing / barber / tattoo / surgeon UI with branding, an optional clothing-thumbnail system (off by default), and a static ped preview camera.

Requirements

• ox_lib and oxmysql (required)
• Framework: QBCore, ESX, or ox_core (auto-detected)
• Optional: clothing thumbnails - set Config.ClothingImages.Enabled = true (off by default). When enabled, choose local, autoshot, or fivemanage as the provider
• Optional (only if using autoshot): Eclipse edited uz_AutoShot - do not use the stock upstream release; download from GitHub
• Optional: screenshot-basic or screencapture (clothing capture), FiveManage API token (CDN hosting)

Install order

Place Appearance as illenium-appearance (or adjust the ensure name). Run SQL from sql/ once on a fresh install. Order in server.cfg matters:

ensure ox_lib
ensure oxmysql
ensure illenium-appearance

# Optional locale
setr illenium-appearance:locale "en"

# --- Clothing images (optional; Enabled is false by default) ---
# ensure screenshot-basic   # or screencapture - capture tool for local/CDN shots
# ensure uz_AutoShot        # only if Enabled=true and Provider="autoshot"
# Eclipse fork: github.com/theeclipsescripts/uz_AutoShot

# FiveManage CDN token - server.cfg only (never config.lua / live console)
# setr eclipse_fivemanage_token "YOUR_API_TOKEN"

Database

Import from sql/ if you are not migrating from stock illenium: playerskins.sql, player_outfits.sql, player_outfit_codes.sql, management_outfits.sql.

Branding & UI

Config.UI = {
    BrandName = "Eclipse",
    BrandSubtitle = "Appearance",
    ShowLogo = true,
    LogoPath = "branding/logo.png", -- relative to this resource
    LogoUrl = "",                   -- absolute URL overrides LogoPath
}

Swap branding/logo.png or set LogoUrl - no NUI rebuild required. Restart / ensure the resource after changes.

Clothing images

Clothing thumbnails are off by default. Set Config.ClothingImages.Enabled = true only if you want preview images in the menu. Then set Config.ClothingImages.Provider to local, autoshot, or fivemanage. For CDN production use, keep the token only in server.cfg:

Config.ClothingImages = {
    Enabled = false,           -- off by default; set true to show clothing thumbs
    Provider = "fivemanage", -- "local" | "autoshot" | "fivemanage"
    LocalBasePath = "clothing_images",
    AutoShot = { Resource = "uz_AutoShot", IncludeTexture = false, Format = "png" },
    FiveManage = { FallbackToAutoShot = false },
    -- Token is NOT here - use setr eclipse_fivemanage_token in server.cfg
}

• local - files under clothing_images/
• autoshot - streams from Eclipse uz_AutoShot (optional - only when Enabled = true; resource must be running)
• fivemanage - CDN URLs in clothing_images/manifest.json

Key commands

Troubleshooting

Discord & customer access

After you buy from the Tebex store, verify your purchase in our Discord server to unlock the @Customer role and customer-only channels.

• 1

  Purchase a script

  Complete checkout on this store with your FiveM / Cfx.re account (required for Keymaster delivery).
• 2

  Join the Eclipse Scripts Discord

  Open our Discord server with the Discord account you want the role on.
• 3

  Click Verify Purchase

  In the #claim-role channel, press Verify Purchase and paste your Tebex transaction ID when prompted (format: tbx-...).
• 4

  Role applied automatically

  The bot validates the ID and grants @Customer - changelog pings, verified support, and customer-only channels.

Escrow resources

Escrow-protected scripts are encrypted through the Cfx.re asset escrow system. You receive a licensed copy on Keymaster tied to your account.

• Do not redistribute, resell, or share escrow files.
• Your server must use a valid Cfx.re key authorized for the asset.
• Config / locale files are usually editable; encrypted source is not.

Troubleshooting