Installation

Install the Multiplayer Electrician Job, or update an older version to 3.0.

Updating from 2.x? Skip to Updating from 2.x. Do not delete your old folder.

---

Prerequisites

Requirement	Description
tw-lib	Free Tworst library, version 1.0.0 or newer
oxmysql	Database
FiveM Server	A recent server build (OneSync on, as txAdmin sets by default)

---

Step 1: Download

From Cfx.re Portal

1. Go to portal.cfx.re → Granted Assets

2. Download tw-electrician and tw-lib

tw-lib is free and comes with every Tworst job. You can also download it from GitHub Releases. Download the tw-lib-x.x.x.zip file there, not "Code → Download ZIP" (that folder is named tw-lib-main and the jobs will not find it).

---

Step 2: Extract Files

Put these three folders into your resources directory:

resources/
├── tw-lib/                     ← Tworst library (REQUIRED)
├── tw-electrician/             ← The job
│   ├── defaults/
│   │   ├── config.lua          # Settings, regions, rewards, tutorial
│   │   ├── coordinate.lua      # Work spots of every region
│   │   └── locales/            # Texts (7 languages)
│   ├── hooks/                  # Your own functions (survive updates)
│   ├── client/  server/  shared/  html/
│   └── fxmanifest.lua
└── tw_electrician_stream/      ← Map, props, vehicles (REQUIRED)

The folder names must stay exactly tw-lib, tw-electrician and tw_electrician_stream.

---

Step 3: Database

Nothing to import. On first start the job creates tw_electrician (player levels, daily missions, history) and tw-lib creates its own tables (tw_lib_settings, tw_lib_players, tw_lib_ledger, tw_lib_ledger_daily, tw_lib_job_history).

---

Step 4: server.cfg

ensure oxmysql
ensure qb-core              # your framework, if any
# ... your inventory, keys, fuel, clothing, target scripts

ensure tw-lib               # before every Tworst job
ensure tw_electrician_stream
ensure tw-electrician

Start order matters: tw-lib must start before tw-electrician. If the job starts first, tw-lib restarts it once by itself and prints a warning. Fix the order anyway.

---

Step 5: Start & Check

Start the server and look at the console:

[tw-lib] server loaded
[tw-lib] 1.0.0 | framework=qb | inventory=qb-inventory | keys=qs-vehiclekeys | fuel=LegacyFuel | clothing=qb-clothing
[tw-lib] up to date: tw-lib 1.0.0, tw-electrician 3.0.0

• The second line shows what tw-lib detected. If something is wrong there, see Troubleshooting.

• The last line appears a few seconds later. If a new version exists it says update available instead.

Then in game: go to the electrician NPC, open a lobby and start.

---

Admin Menu Permission

/twlib opens the Tworst admin menu for players with the tw-lib.admin ace. QBCore / QBox admins (god, admin) and ESX admins (admin, superadmin) are allowed automatically. For anyone else, add to server.cfg:

add_ace group.admin tw-lib.admin allow

You can also list players by identifier in tw-lib/config.lua, and set the menu language there. See tw-lib → Admin Menu for what each page of the menu does.

---

Updating from 2.x

1. Stop the server (or the resource).

2. Download the new tw-electrician and tw-lib.

3. Copy the new tw-electrician over your old folder. Do not delete the old folder first: tw-lib reads your old config/config.lua, config/coordinate.lua and locales/ once and keeps every value you had changed (money, XP, language, texts, coordinates).

4. Keep your tw_electrician_stream folder as it is.

5. Add ensure tw-lib before ensure tw-electrician in server.cfg.

6. Start the server. The console lists what was imported. Your players' levels and history in tw_electrician are kept.

From 3.0 on, updates are simple: copy the new folder over the old one. Your settings are stored in the database (tw_lib_settings), so nothing you changed is lost.

Options that are functions (Config.startJobFunction, Config.endJobFunction, Config.sendNotification, Config.CustomDrawText) are not imported. Move your code into hooks/my-hooks.lua (see Configuration → Hooks).

---

Troubleshooting

Could not find dependency tw-lib for resource tw-electrician

tw-lib is not installed or not started. Install it (Step 1) and ensure tw-lib before the job.

tw-electrician needs tw-lib X or newer

Your tw-lib is older than the job needs. Download the latest from GitHub or the Cfx.re portal and replace the tw-lib folder.

Wrong framework / inventory / keys / fuel / clothing detected

Look at the [tw-lib] 1.0.0 | framework=... line. If a script you use is not there, check that it is started, and that its folder name is the original one. To force a choice: twlib set tw-lib bridge.inventory ox_inventory in the server console (same for framework, keys, fuel, clothing), then restart tw-lib.

Props or trucks missing

tw_electrician_stream is missing or not started.

The prompt does not show with Config.DrawTextUI = "ox_lib"

That option uses ox_lib's TextUI. Make sure ox_lib is started in server.cfg before the job.

---

Need Help?

Open a ticket on our Discord with the [tw-lib] ... status line from your console and any red error lines.