FiveM TypeScript Boilerplate

A template for creating FiveM resources with TypeScript.

Getting started

Note

Install Bun and Git if you don't already have them.

Use any of the options below to initialise your resource.

Using bun create

bun create overextended/fivem-ts <name>

Using GitHub CLI

gh repo create <name> --template=overextended/fivem-ts

Alternative methods

• Create a new repository from the template
• Download the template directly

Setup

Initialise your project to set the project name and optionally scaffold a new web app.

bun install
bun run init

Customise package.json with the author, repository, and any other relevant information. This information is added to the fxmanifest when building the project.

Scripts

bun tsd

Build all resource files in production mode using tsdown.

bun dev

Run tsdown in watch mode, to actively rebuild resource files as they are modified.

bun lint

Run Oxlint to analyse your project for potential errors, bugs, and code quality issues.

bun format

Run Oxfmt to automatically reformat your project and ensure consistent code styling.

bun webdev

Runs the Vite dev server for live web development.

bun webbuild

Builds your web project in production mode.

bun run build

Runs the bun tsd and bun webbuild scripts to create a complete production-ready build of your project.

Layout

/locales/

Contains translation files used with the ox_lib locales module.

/public/

Static assets served directly without processing or bundling.

/resource/

Main project source code.

• client – client modules
• common – shared modules
• server – server modules

/scripts/

Scripts used during project development.

/types/

Type definitions used across the project.