Browse docs

Installation

Prepare dependencies, framework installation, database setup and administrator permissions for Job Creator.

Requirements

Use matching current versions of sky_base, sky_jobs_base and sky_jobcreator, oxmysql, and one supported framework: ESX, QBCore or Qbox. Keep the resource name sky_jobcreator unchanged.

Banking, inventory and targeting are separate integrations. A society bank must support account provisioning before you create finance-enabled jobs. Document items need an inventory that supports individual metadata; check the Jobs Base item definitions.

Back up the database, framework files, Sky resources and saved configurator data before first installation or an update.

Framework hooks and start order

The included install.md and Config.AutoInstallFramework control installation of recognised framework hooks. With automatic installation enabled, put the worker permission near the top of server.cfg, before the framework:

server.cfg
add_unsafe_worker_permission sky_jobcreator

ensure oxmysql
ensure es_extended
# QBCore: replace es_extended with qb-core.
# Qbox: replace es_extended with qbx_core.

ensure sky_base
ensure sky_jobs_base
ensure sky_jobcreator

Keep the framework's other dependencies in their normal order. On QBCore/Qbox, start Job Creator before character selection/login.

Perform a full server restart after adding the worker permission. If the installer reports changed framework files, a further full restart loads those files. Installation status describes files on disk; it does not prove that a running framework has loaded them. The installer does not restart your framework or server automatically.

Original framework files are backed up beside the resource in .sky_jobscreator-installer-backups/. Review failed or unrecognised integrations before continuing. FiveM documents this permission in its sandbox reference.

For a renamed framework, follow the included install.md instructions for its original-name resource alias. Do not rename resource references by guesswork.

Database

sky_jobcreator/config/config.lua defaults Config.AutoExecuteQuery to true. Automatic migrations create or update the Creator-owned tables. If you disable automatic queries, apply the matching included import.sql manually before use.

Keep existing jobs, grades, memberships and configurator data. Reimporting SQL or deleting tables is not a repair for a single incomplete job.

Administrator access

The default Creator command groups are god, superadmin and admin under:

sky_jobcreator/config/config.lua
Config.CommandPermissions = {
    jobcreator = { "god", "superadmin", "admin" }
}

Editing also requires sky_jobs_base.jobconfig. If you add a custom group, authorise it in both Creator's command policy and Jobs Base's CommandPermissions.jobconfig. Command permissions are plaintext startup settings, not employee rank permissions.

Follow the shared permissions bootstrap for your administrator identity.

First test

  1. Confirm the installer and database reports have no unresolved error.
  2. Open /jobcreator and create a small test job.
  3. Inspect its grades and society-account setup before enabling employee tools.
  4. Place one workplace interaction and test it with an authorised character.
  5. If setup is incomplete, repair the reported integration and retry the existing job's activation. Do not create the same account or job repeatedly.

Continue with Job configuration.

Updating an earlier development installation

If the previous resource folder was sky_jobscreator, replace it with sky_jobcreator during your next planned server shutdown and update the startup entry and worker permission. Keep only one Creator resource in auto-started groups. Update Sky Base and Jobs Base together. Existing saved jobs, configuration history, audit settings and Hub ownership keep their internal storage identities; no database rename or resubmission is required. Explicit legacy sky_jobscreator.jobcreator grants remain accepted alongside sky_jobcreator.jobcreator.