txAdmin 开源项目教程
1. 项目目录结构及介绍
在 txAdmin
项目中,你将找到以下主要的目录结构:
- filesRepository:存储服务器部署相关的文件和资源。
- src:包含项目的主要源代码,分为前端(客户端)和后端(服务端)部分。
- docs:项目文档的所在位置,包括各种说明和指南。
- txData:这是默认的数据存储路径,用于保存服务器配置和日志等数据。
此外,还有一些关键的单个文件,如 README.md
(项目简介)、MIT_LICENSE
(项目许可)以及一些脚本文件。
2. 项目启动文件介绍
-
FXServer.exe(Windows)或 run.sh(Linux):这是 FiveM 服务器的基础执行文件,
txAdmin
在此之上运行。要启动txAdmin
,你需要先启动 FXServer 并以监控模式运行。-
对于 Windows 用户:
/path/to/FXServer.exe
-
对于 Linux 用户:
screen -dmS fxserver ./run.sh
启动后,从显示的 URL 中配置
txAdmin
。 -
3. 项目配置文件介绍
配置 txAdmin
主要是通过设置 ConVars(控制变量)来完成的。以下是几个重要的配置选项:
- serverProfile:定义你要启动的服务器配置文件名,默认是
default
。这些配置存储在txData
目录内。 - txAdminPort:HTTP 服务监听的端口,默认是
40120
。 - txAdminInterface:HTTP 服务使用的网络接口,默认是
0.0.0.0
(监听所有可用接口)。 - txDataPath:指定数据目录的位置,默认情况下,Windows 上为
<citizen_root>/txData
,Linux 上为<citizen_root>/txData
。 - txAdminVerbose:若设为
true
,将在控制台显示更详细的错误和事件信息,默认为false
。
例如,如果你想要在不同的端口和配置下启动服务器,可以这样设置 ConVars:
# Windows
/FXServer.exe +set serverProfile dev_server +set txAdminPort 40121
# Linux
/run.sh +set serverProfile dev_server +set txAdminPort 40121
以上是 txAdmin
的基本介绍和配置步骤,更多详细信息可以参考项目文档和官方仓库内的其他资料。如果有任何疑问,建议查阅项目官方 Discord 社区获取支持。