altv-esbuild

You can click for better quality

Special thanks ❤️ to innxz and uncle_ara for financially supporting me and this library.

A plugin that greatly simplifies server/client JS and TS development (as well as production) on the alt:V platform.
(extended and improved version of the previous esbuild dev plugin).

Features

Write your scripts in JS/TS with enabled 5-million-polygon cars and mlo without client crashes
Hot reload without server restart or client reconnect (using alt:V resource restart)
Full client and server support
Restart console command for client and server ("res" by default)
Improved top-level exception output during development
Direct support for alt:V enums, even in JS code (documentation)

Docs

Docs web page: https://xxshady.github.io/altv-esbuild.

How to use?

Example resource can be found here.

Install from npm

npm i altv-esbuild

Add to your build code of the server and client

Example of the build server code:

import esbuild from "esbuild"
import { altvEsbuild } from "altv-esbuild"

// your own variable
const DEV_MODE = true

esbuild.build({
  entryPoints: ["src/main.js"],
  outfile: "dist/bundle.js",
  bundle: true,
  watch: DEV_MODE, // this build option is outdated, see example directory in the repo
  target: "esnext",
  format: "esm",
  
  plugins: [
    altvEsbuild({
      mode: "server", // use "server" for server code, and "client" for client code

      // see docs for more info about these options:
      dev: {
        enabled: DEV_MODE,

        // if `DEV_MODE` is false it will also be automatically set to false too
        enhancedRestartCommand: true, 
      },
      altvEnums: true,
    }),
  ],
  
  external: [
    // none of the following is required, the plugin handles all alt:V modules automatically
    // "alt-server",
    // "alt-client",
    // "alt-shared",
    // "natives"
  ]
})

Connection queue is not supported between hot reloads (or just resource restarts).
Player disconnect is also not supported between hot reloads. Only player connect is emulated for now in dev environment.