FiveM 是 Grand Theft Auto V 的修改版，使您能够在由 Cfx.re 提供支持的定制专用服务器上玩多人游戏。

当您开发 FiveM 服务器时，您可以创建资源。这些资源可以用多种语言编写：Lua、C# 和 JavaScript。在本文中，我们将了解如何使用 TypeScript 构建资源

类型 ：

为了输入代码，我们将使用 FiveM 背后的公司 CFX.re 提供的两个软件包

• @citizenfx/客户
• @citizenfx/服务器

这些包为客户端或服务器端代码中可用的每个本机方法提供了类型。

tsconfig.json

{
  "compilerOptions": {
    "target": "ES2020",
    "module": "ESNext",
    "moduleResolution": "Bundler",
    // Location
    "outDir": "./dist",
    // Other
    "types": ["@citizenfx/client", "@types/node"],
    "lib": ["ES2020"],
    "strict": true,
    "esModuleInterop": true,
    "allowSyntheticDefaultImports": true,
    "skipLibCheck": true
  },
  "include": ["src/**/*.ts"],
  "exclude": ["**/node_modules", "**/.test.ts"]
}

捆 ：

编译 .ts 文件后，您必须创建一个将由 FiveM 服务器加载和运行的包。事实上，FiveM 只允许 require 原生 Node.js 包，如路径、fs、...

为此，我们使用名为 rollup 的工具，它是一个基于插件系统的 JavaScript 模块捆绑器。我也探索过其他工具，如 vite、rspack，但太复杂了。另一种提供良好性能的工具是turbopack，它是下一次捆绑之后的工具，但目前仍位于下一个内部。

rollup.config.mjs

import typescript from "@rollup/plugin-typescript";
import commonjs from "@rollup/plugin-commonjs";
import resolve from "@rollup/plugin-node-resolve";

export default {
  input: "src/index.ts",
  output: {
    dir: "dist",
    format: "cjs",
    sourcemap: false,
  },
  plugins: [resolve(), typescript(), commonjs()],
};

package.json :

{
  ...
  "devDependencies": {
    "@citizenfx/client": "2.0.9282-1",
    "@rollup/plugin-commonjs": "^26.0.1",
    "@rollup/plugin-node-resolve": "^15.2.3",
    "@rollup/plugin-typescript": "^11.1.6",
    "@types/node": "^20.14.12",
    "rollup": "^4.20.0",
    "tslib": "^2.6.3",
    "typescript": "^5.5.4"
  },
  ...
}

示例

init.ts

import { join } from "path"

export const init = () => {
    console.log("inited", join(".", "init.js"));
}

index.ts

import { init } from "./init"

on("onResourceStart", async (resName: string) => {
  if (resName === GetCurrentResourceName()) {
    init();
  }
});

运行 rollup -c 后，您将只有一个文件：

'use strict';

var path = require('path');

const init = () => {
    console.log("inited", path.join(".", "init.js"));
};

on("onResourceStart", async (resName) => {
    if (resName === GetCurrentResourceName()) {
        init();
    }
});