fivem-cfg：用 TypeScript 编写 FiveM server.cfg 文件

fivem-cfg

你可以使用 TypeScript 来编写 FiveM 的 server.cfg 文件。通过命令行工具或编程方式，即可获得类型检查、自动补全功能，以及自动生成的配置文件。

**命令行方式**

// server.config.ts
import { defineServer } from “fivem-cfg”;

export default defineServer({
hostname: “My RP Server”,
maxClients: 64,
oneSync: “on”,
});

pnpx fivem-cfg –input server.config.ts –output server.cfg

执行该命令后会生成一个内容如下的 server.cfg 文件：

# 由 fivem-cfg 自动生成

set sv_hostname “My RP Server”
set sv_maxClients “64”

**编程方式**

import { defineServer } from “fivem-cfg”;

const cfg = defineServer({
hostname: “My RP Server”,
maxClients: 64,
oneSync: “on”,
enforceGameBuild: 3751,
endpoints: { tcp: [“0.0.0.0:30120”], udp: [“0.0.0.0:30120”] },
});

console.log(cfg.generate()); // 输出 server.cfg 的内容

**安装方式**

pnpm add fivem-cfg

**配置选项**

所有的配置选项及其说明都以 JSDoc 注解的形式记录在 src/schema.ts 文件中。该架构文档涵盖了所有官方记载的服务器指令。对于架构文档中未列出的自定义变量，可以使用 set/sets/setr（参见“Convars”部分）来进行处理：

defineServer({
set: { sv_scriptHookAllowed: “1” },
sets: { tags: “roleplay, english”, locale: “en-US” },
});