fivem-squex

FiveM resource scaffolding CLI tool. Create a fully structured FiveM resource in one command.

Quick Start

npx fivem-squex my-script

Install Globally

npm install -g fivem-squex

Then use it anywhere:

fivem-squex my-garage

What It Creates

my-script/
├── README.md
├── fxmanifest.lua
├── client/
│   └── client.lua
├── server/
│   └── server.lua
├── shared/
│   └── config.lua
├── html/
│   ├── index.html
│   ├── style.css
│   └── script.js
└── locales/
    ├── tr.lua
    └── en.lua

| File | Purpose | |------|---------| | fxmanifest.lua | Resource manifest and configuration | | client/client.lua | Client-side scripts | | server/server.lua | Server-side scripts | | shared/config.lua | Shared configuration | | html/ | NUI interface (HTML/CSS/JS) | | locales/ | Language files (TR, EN) |

Usage

With a name argument:

fivem-squex police_job

Interactive mode (no argument):

fivem-squex
# prompts for resource name

Naming Rules

• Lowercase only
• Hyphens and underscores allowed
• Must start with a letter or number
• Examples: my-garage, police_job, hud2

License

MIT