MCPcopy Index your code
hub / github.com/citizenfx/txAdmin

github.com/citizenfx/txAdmin @v8.1.1

Chat with this repo
repository ↗ · DeepWiki ↗ · release v8.1.1 ↗ · + Follow
2,585 symbols 8,320 edges 537 files 294 documented · 11%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README
    <img src="https://github.com/citizenfx/txAdmin/raw/v8.1.1/docs/banner.png">






    In 2019 <b>txAdmin</b> was created, with the objective of making FiveM server management accessible to everyone – no matter their skill level!


    Today, <b>txAdmin</b> is <i>the</i> <b>full featured</b> web panel & in-game menu to Manage & Monitor your FiveM/RedM Server, in use by over <strong>29.000</strong> servers worldwide at any given time!






    Join our Discord Server: &nbsp; <a href="https://discord.gg/AFAAXzq"><img src="https://discordapp.com/api/guilds/577993482761928734/widget.png?style=shield"></img></a>






    <a href="https://zap-hosting.com/txadmin4" target="_blank" rel="noopener">
        <img src="https://github.com/citizenfx/txAdmin/raw/v8.1.1/docs/zaphosting.png" alt="zap-hosting"></img>
    </a>

Main Features

  • Recipe-based Server Deployer: create a server in under 60 seconds! (docs/recipe.md)
  • Start/Stop/Restart your server instance or resources
  • Full-featured in-game admin menu:
    • Player Mode: NoClip, God, SuperJump
    • Teleport: waypoint, coords and back
    • Vehicle: Spawn, Fix, Delete, Boost
    • Heal: yourself, everyone
    • Send Announcements
    • Reset World Area
    • Show player IDs
    • Player search/sort by distance, ID, name
    • Player interactions: Go To, Bring, Spectate, Freeze
    • Player troll: make drunk, set fire, wild attack
    • Player ban/warn/dm
  • Access control:
  • Discord Integration:
    • Server configurable, persistent, auto-updated status embed
    • Command to whitelist players
    • Command to display player infos
  • Monitoring:
    • Auto Restart FXServer on crash or hang
    • Server’s CPU/RAM consumption
    • Live Console (with log file, command history and search)
    • Server threads performance chart with player count
    • Server Activity Log (connections/disconnections, kills, chat, explosions and custom commands)
  • Player Manager:
    • Warning system & Ban system
    • Whitelist system (Discord member, Discord Role, Approved License, Admin-only)
    • Take notes about players
    • Keep track of player's play and session time
    • Self-contained player database (no MySQL required!)
    • Clean/Optimize the database by removing old players, or bans/warns/whitelists
  • Real-time playerlist
  • Scheduled restarts with warning announcements and custom events (docs/events.md)
  • Translated into over 30 languages (docs/translation.md)
  • FiveM's Server CFG editor & validator
  • Responsive web interface with Dark Mode 😎
  • And much more...

Also, check our Feature Graveyard for the features that are no longer among us (😔 RIP).

Running txAdmin

  • Since early 2020, txAdmin is a component of FXServer, so there is no need to downloading or installing anything.
  • To start txAdmin, simply run FXServer without any +exec server.cfg launch argument, and FXServer will automatically start txAdmin.
  • On first boot, a txData directory will be created to store txAdmin files, and you will need to open the URL provided in the console to configure your account and server.

Configuration & Integrations

  • Most configuration can be done inside the txAdmin settings page, but some configs (such as TCP interface & port) are only available through Environment Variables, please see docs/env-config.md.
  • You can listen to server events broadcasted by txAdmin to allow for custom behavior in your resources, please see docs/events.md.

Contributing & Development

  • All PRs should be based on the develop branch, including translation PRs.
  • Before putting effort for any significant PR, make sure to join our discord and talk to us, since the change you want to do might not have been done for a reason or there might be some required context.
  • If you want to build it or run from source, please check docs/development.md.

License, Credits and Thanks

Extension points exported contracts — how you extend this code

Window (Interface)
(no doc)
panel/src/global.d.ts
GenericTxModuleInstance (Interface)
(no doc)
core/global.d.ts
BaseConfigItem (Interface)
(no doc)
core/modules/ConfigStore/schema/utils.ts
TxBaseLogTypes (Interface)
(no doc)
core/lib/console.ts
ProvidedContext (Interface)
(no doc)
core/testing/globalSetup.ts
Theme (Interface)
(no doc)
nui/src/index.tsx
TextareaProps (Interface)
(no doc)
panel/src/components/ui/textarea.tsx
GenericTxModule (Interface)
(no doc)
core/global.d.ts

Core symbols most depended-on inside this repo

push
called by 350
core/modules/FxMonitor/index.ts
cn
called by 199
panel/src/lib/utils.ts
filter
called by 131
core/modules/Database/dao/cleanup.ts
consoleFactory
called by 127
core/lib/console.ts
Pos
called by 126
web/public/js/codeEditor/codemirror.js
get
called by 94
core/modules/WebServer/middlewares/sessionMws.ts
add
called by 86
core/lib/fxserver/fxsConfigHelper.ts
getLine
called by 61
web/public/js/codeEditor/codemirror.js

Shape

Function 1,993
Method 389
Class 120
Interface 61
Enum 22

Languages

TypeScript100%

Modules by API surface

web/public/js/codeEditor/codemirror.js460 symbols
web/public/js/coreui.bundle.min.js93 symbols
web/public/js/socket.io.min.js47 symbols
core/deployer/recipeEngine.js34 symbols
core/modules/Metrics/statsUtils.ts31 symbols
core/modules/FxMonitor/utils.ts29 symbols
core/lib/player/playerClasses.ts26 symbols
core/modules/AdminStore/index.js25 symbols
web/public/js/codeEditor/search.js24 symbols
core/lib/fxserver/fxsConfigHelper.ts23 symbols
core/lib/console.ts19 symbols
core/modules/FxRunner/index.ts18 symbols

Datastores touched

(mysql)Database · 1 repos
txAdminDatabase · 1 repos

For agents

$ claude mcp add txAdmin \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact