Starting a project

Three ways to start

A new AI Script Generator project starts on one page with numbered sections. A section unlocks once the one before it is done, and the rail on the right sums up your choices.

123

1. 11. Generate a script: from a description
2. 22. Import from GitHub: bring an existing resource
3. 33. Or start empty and add files yourself

• Generate a script: describe what you need and the assistant writes it. This is the usual way.
• Import from GitHub: bring an existing resource in and keep working on it. See Importing a repository.
• Or start empty and add files yourself: asks only for a name and an optional description. Nothing is generated; you add or upload files and use the chat when you want.

Choosing the framework

The framework decides which functions the AI Script Generator writes against, for example how it reads a player's money or job. Pick the one your server runs.

• ESX

  ESX Legacy servers: jobs, inventory, economy.

• QBCore

  QBCore servers.

• Qbox

  Qbox servers, the QBCore fork.

• ox_lib

  Standalone scripts built on the Overextended library.

• vRP

  vRP 2 and Dunko servers, with Tunnel and Proxy.

• Standalone

  No framework, only FiveM natives.

• Custom

  A custom or mixed setup. Name it in the prompt.

One project targets one framework. For another framework, start a second project, or convert a finished resource with the Framework Converter.

Templates and your own idea

Templates are tested starting points: ATM & Banking, Garage System, Job HUD, Mechanic Job, Speed Cameras, Drug Selling, Vehicle Shop and Admin Menu. Each one fills in a prompt written for your framework, plus fitting settings such as a UI or dependencies. The category chips narrow the list.

123

1. 11. Categories: narrow the list
2. 22. Speed Cameras: fills in a prompt for QBCore
3. 33. Describe it yourself: start from an empty prompt

A template only shows for the frameworks it suits, so the list can be shorter on vRP or Custom. For anything else choose Describe it yourself and write the prompt from scratch.

Writing a good prompt

The prompt is what the AI Script Generator builds from, so be concrete. With a template it is prefilled as Generation prompt; read it and change it before you generate.

12

1. 11. Project name: also the resource name
2. 22. Generation prompt: edit it before you generate

Prompts that work well name:

• The features, one by one: "players plant seeds, water them, harvest and sell to NPC dealers".
• Your resources: which inventory, target, phone and notification scripts the server uses.
• Names from your server: item names, job names, account names, locations.
• The edge cases: what happens when a player leaves, has no money or spams the command.

The project name becomes the name of the resource folder, so keep it short and without spaces, for example speed-cameras.

Code style, UI and dependencies

The Advanced section is optional; sensible defaults are already set. Open Code style, UI and dependencies to change them.

12

1. 11. File structure: modular or one file
2. 22. Build a user interface (menus, dialogs, HUD): then pick the UI library

• Indentation

  Spaces or tabs, 2 or 4 wide.

• Naming

  camelCase, snake_case or PascalCase.

• File structure

  Modular (client, server and shared files) or Single file.

• Strict mode

  Local variables by default, no globals.

• Build a user interface

  Adds a UI with ox_lib, qb-menu or custom HTML, a theme and a layout.

• Dependencies

  ox_lib, ox_target, ox_inventory, qb-target, qb-menu, qb-inventory, yacavoice, pma-voice, mythic_notify, nh-context.

When everything is set, press Create and generate in the rail. Generation starts right away.

1

1. 11. Create and generate: starts the first generation