agentleFS
germanfndezgermanfndez/fiveai-skills/skills/oxlib/SKILL.md

oxlib

Skill19 starsChanged 2 months agoMITView on GitHub

Trigger: ox_lib, lib.notify, lib.alertDialog, lib.inputDialog, lib.callback, lib.addCommand, lib.zones, menus, progress bars, keybinds, client-server callbacks. Use ox_lib UI, callbacks, commands and zones.

The file

We split this skill into the rules it gives an agent

4 rules. About 0 are common, 1 is distinctive, and 3 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 3

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Add shared_scripts { '@ox_lib/init.lua' } to fxmanifest.lua and ensure ox_lib starts before the resource.

    line 20
  2. Very specific:

    Prefer lib.callback / lib.callback.await over paired events or framework-specific callbacks for data across the network.

    line 21
  3. Very specific:

    Add the manifest line and start order (read rules/init.md).

    line 44
  4. Distinctive:

    Put request handling on the server callback.

    line 46

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

ox_lib

Shared FiveM library: UI (notify, dialogs, menus, progress), client/server callbacks, commands and zones via the global lib.

Activation Contract

Load this skill when the user needs notifications, alert or input dialogs, menus, progress bars, TextUI, a client-server request/response, a typed server command, zones ("player enters/leaves area"), keybinds, or any resource that depends on ox_lib.

Hard Rules

  • Add shared_scripts { '@ox_lib/init.lua' } to fxmanifest.lua and ensure ox_lib starts before the resource; without it lib is nil.
  • Prefer lib.callback / lib.callback.await over paired events or framework-specific callbacks for data across the network.
  • lib.callback.register(name, function(source, ...)) on the server receives source first; validate arguments there.
  • Callback names must be unique (resourcename:action).
  • UI functions (lib.notify, lib.alertDialog, lib.inputDialog, lib.progress, lib.context, lib.menu, lib.showTextUI) render on the CLIENT; from the server trigger the client to call them.
  • Icons are Font Awesome 6, default style solid; brand icons use {'fab', 'name'}.
  • lib.addCommand is SERVER-side; use restricted for permissions and typed params (number, playerId, string, longString).
  • Zones: onEnter, onExit and inside do not work on the server; create zones on the client. Keep the returned zone to call zone:remove().
  • Modules load on first use or via ox_libs { ... } / lib.require.

Decision Gates

NeedCall
Toast messagelib.notify({ title, description, type })
Confirm / OK dialoglib.alertDialog({ header, content, centered, cancel })
Form inputlib.inputDialog(title, rows)
Client asks serverlib.callback.await(name, false, ...) + server lib.callback.register
Server asks clientlib.callback.await(name, source, ...) + client lib.callback.register
Chat command with argslib.addCommand(name, { help, params, restricted }, cb)
Area triggerlib.zones.poly / lib.zones.box / lib.zones.sphere

Execution Steps

  1. Add the manifest line and start order (read rules/init.md).
  2. Pick the call from Decision Gates; read the matching rules file for the option table.
  3. Put request handling on the server callback; put UI on the client.
  4. Name callbacks and commands with the resource prefix.
  5. Store zone handles for removal.

Output Contract

Return runnable Lua using the global lib, with the manifest line when the resource is new and the client/server side explicit.

References

  • rules/init.md — fxmanifest, shared_script, ox_libs, lib.require.
  • rules/callback.md — lib.callback, await, register on both sides.
  • rules/interface.md — notify, alertDialog, inputDialog, other UI modules, icons.
  • rules/addCommand.md — server commands with help, params, restricted.
  • rules/zones.md — poly, box, sphere zones, methods and utilities.

Upstream docs: https://overextended.dev/ox_lib

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.