Documentation

Setup

Install and configure the dyno.

#Dependencies

Install oxmysql and zyke_lib, and configure the framework and inventory providers in zyke_lib. See Dependencies.

#Resource & Item

Place the resource in your server's resources folder as zyke_dyno.

Add the printed sheet as an item named dyno_sheet to your inventory. For ox_inventory, in data/items.lua:

lua
["dyno_sheet"] = {
    label = "Dyno Sheet",
    weight = 10,
    stack = false,
    close = true,
},

Copy the icon from extras/items/images/256/ into the inventory's image directory, or the outlined version from extras/items/images/256/artwork/ if your inventory uses that style. Keep the item non-stackable/unique, since each sheet keeps its run in its metadata. Your inventory has to support item metadata.

Without the item, a run still shows its result on the screen. Set printout.enabled = false to hide the print key.

#Configuration

Edit shared/config.lua. Review the units, the jobs that may run the dynos, the printout, and the laptop app. Use the Config reference for current defaults. To tune the numbers your cars read, see Formula & Calibration.

For a Discord message after every run, put the webhook in your server.cfg, so the URL never sits in a file:

cfg
set zyke_dyno_webhook "https://discord.com/api/webhooks/..."

Custom run restrictions belong in client/can_checks.lua and server/can_checks.lua. Enforce trusted restrictions on the server. Reactions to finished runs, such as job pay, belong in server/hooks.lua. See Can-Check Hooks.

#Start Order

Start your configured providers and their dependencies before Dyno, and Dyno before any resource that uses its exports:

cfg
ensure oxmysql
ensure zyke_lib
ensure zyke_dyno

The zyke_dyno_dynos, zyke_dyno_runs, and zyke_dyno_saved tables are created on first start, so there is no SQL to import. With zyke_laptop, the Dyno app registers as either resource starts, in any order.

#Place Dynos

No dynos stand by default. Run /dynos in game to take out the placing tool, aim at the floor, and place a dyno with the left mouse button. It is saved in the database and stands again after a restart. See Placing Dynos.

A dyno needs 2.6 metres of room across and 7.2 metres along, ramps included. Dynos that always stand can also go in shared/dynos.lua; see Dynos.

#Verify Gameplay

Drive onto a dyno from behind and stop with the front wheels on the front rollers, where the strip turns green. Press E, floor the throttle, and hold it to the limiter. Lift, and the result shows on the screen once the rollers have run down. See Running the Dyno.