Rencikas / fivem-typescript-boilerplate

FiveM TypeScript Resource Boilerplate

This is a simple boilerplate for getting started with TypeScript game-scripts, in FiveM.

This repository is a basic boilerplate for getting started with TypeScript resources in FiveM. This boilerplate only comes with development dependencies needed for FiveM-centered TypeScript transpilation, the rest is up to you.

Note: This boilerplate is targeting TypeScript in context of game-scripts, if you wish to use TypeScript in NUI, take a look at our other boilerplate

Foreword

Although there already is a well established TypeScript boilerplate, made by d0p3t for the FiveM ecosystem, he has unfortunately passed away, leaving it unmaintained. This boilerplate is simply a more up to date alternative.

Requirements

• Node > v14

Getting Started

First clone the repository or use the template option and place it within your resources folder

Install Dependencies

Navigate into the newly cloned folder and execute the following command, to install dependencies.

npm i

Development

Hot Building

While developing your resource, this boilerplate offers a watchscript that will automatically hot rebuild on any change within the client or server directories.

npm run watch

This script still requires you restart the resource for the changes to be reflected in-game

Entry Points

Client - ./client/client.ts

Server - ./server/server.ts

Production Build

Once you have completed the development phase of your resource, you must create an optimized & minimized production build, using the build script.

npm run build

Automatic Builds (Optional)

This is not recommended as the embedded version of yarn is ocassionally prone to performance and environment problems. We highly recomend, you manually run the build script

If desired, the fxmanifest.lua can be setup to allow for FXServer to automatically build on resource start. This utilizes the embedded yarn & webpack default resources.

To enable this, add the following to your fxmanifest.lua

dependency {
    'yarn',
    'webpack'
}

webpack_config 'webpack.config.js'

Additional Notes

Need further support? Join our Discord!