|
1 | 1 | <p align="center"> |
2 | | - <h1 align="center"> |
3 | | - txAdmin for FiveM |
4 | | - </h1> |
5 | | - <p align="center"> |
6 | | - <img width="420" height="237" src="docs/banner.png"> |
7 | | - </p> |
8 | | - <h4 align="center"> |
9 | | - Join our Discord Server: <a href="https://discord.gg/AFAAXzq"><img src="https://discordapp.com/api/guilds/577993482761928734/widget.png?style=shield"></img></a> |
10 | | - </h4> |
11 | | - <p align="center"> |
12 | | - <b>txAdmin</b> is _the_ <b>full featured</b> web panel to Manage & Monitor your FiveM/RedM Server remotely, in use by over <strong>29.000</strong> servers worldwide at any given time. |
13 | | - </p> |
14 | | - <p align="center"> |
15 | | - <a href="https://zap-hosting.com/txadmin4" target="_blank" rel="noopener"> |
16 | | - <img src="docs/zaphosting.png" alt="zap-hosting"></img> |
17 | | - </a> |
18 | | - </p> |
| 2 | + <p align="center"> |
| 3 | + <img src="docs/banner.png"> |
| 4 | + </p> |
| 5 | + <p align="center"> |
| 6 | + In 2019 <b>txAdmin</b> was created, with the objective of making FiveM server management accessible to everyone – no matter their skill level! <br/> |
| 7 | + 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! |
| 8 | + </p> |
| 9 | + <p align="center"> |
| 10 | + Join our Discord Server: <a href="https://discord.gg/AFAAXzq"><img src="https://discordapp.com/api/guilds/577993482761928734/widget.png?style=shield"></img></a> |
| 11 | + </p> |
| 12 | + <p align="center"> |
| 13 | + <a href="https://zap-hosting.com/txadmin4" target="_blank" rel="noopener"> |
| 14 | + <img src="docs/zaphosting.png" alt="zap-hosting"></img> |
| 15 | + </a> |
| 16 | + </p> |
19 | 17 | </p> |
20 | 18 |
|
21 | | -<br/> |
22 | | - |
23 | | - |
24 | 19 | ## Main Features |
25 | | -- Recipe-based Server Deployer: create a server in under 60 seconds! ([more info](docs/recipe.md)) |
| 20 | +- Recipe-based Server Deployer: create a server in under 60 seconds! ([docs/recipe.md](docs/recipe.md)) |
26 | 21 | - Start/Stop/Restart your server instance or resources |
27 | 22 | - Full-featured in-game admin menu: |
28 | | - - Player Mode: NoClip, God, SuperJump |
29 | | - - Teleport: waypoint, coords and back |
30 | | - - Vehicle: Spawn, Fix, Delete, Boost |
31 | | - - Heal: yourself, everyone |
32 | | - - Send Announcements |
33 | | - - Reset World Area |
34 | | - - Show player IDs |
35 | | - - Player search/sort by distance, ID, name |
36 | | - - Player interactions: Go To, Bring, Spectate, Freeze |
37 | | - - Player troll: make drunk, set fire, wild attack |
38 | | - - Player ban/warn/dm |
| 23 | + - Player Mode: NoClip, God, SuperJump |
| 24 | + - Teleport: waypoint, coords and back |
| 25 | + - Vehicle: Spawn, Fix, Delete, Boost |
| 26 | + - Heal: yourself, everyone |
| 27 | + - Send Announcements |
| 28 | + - Reset World Area |
| 29 | + - Show player IDs |
| 30 | + - Player search/sort by distance, ID, name |
| 31 | + - Player interactions: Go To, Bring, Spectate, Freeze |
| 32 | + - Player troll: make drunk, set fire, wild attack |
| 33 | + - Player ban/warn/dm |
39 | 34 | - Access control: |
40 | | - - Login via Password or CitizenFX |
41 | | - - Admin permission system ([more info](docs/permissions.md)) |
42 | | - - Action logging |
43 | | - - Brute-force protection |
| 35 | + - Login via Cfx.re or password |
| 36 | + - Admin permission system ([docs/permissions.md](docs/permissions.md)) |
| 37 | + - Action logging |
44 | 38 | - Discord Integration: |
45 | | - - Server configurable, persistent, auto-updated status embed |
46 | | - - Command to whitelist players |
47 | | - - Command to display player infos |
| 39 | + - Server configurable, persistent, auto-updated status embed |
| 40 | + - Command to whitelist players |
| 41 | + - Command to display player infos |
48 | 42 | - Monitoring: |
49 | | - - Auto Restart FXServer on crash or hang |
50 | | - - Server’s CPU/RAM consumption |
51 | | - - Live Console (with log file, command history and search) |
52 | | - - Server threads performance chart with player count |
53 | | - - Server Activity Log (connections/disconnections, kills, chat, explosions and [custom commands](docs/custom_serverlog.md)) |
| 43 | + - Auto Restart FXServer on crash or hang |
| 44 | + - Server’s CPU/RAM consumption |
| 45 | + - Live Console (with log file, command history and search) |
| 46 | + - Server threads performance chart with player count |
| 47 | + - Server Activity Log (connections/disconnections, kills, chat, explosions and [custom commands](docs/custom-server-log.md)) |
54 | 48 | - Player Manager: |
55 | | - - [Warning system](https://www.youtube.com/watch?v=DeE0-5vtZ4E) |
56 | | - - Ban (temporary or permanently) system |
57 | | - - Whitelist system (Discord member, Discord Role, Approved License, Admin-only) |
58 | | - - Take notes about players |
59 | | - - Keep track of player's play and session time |
60 | | - - Self-contained player database with backup tool (no MySQL required!) |
61 | | - - Clean/Optimize the database by removing old players, or bans/warns/whitelists |
| 49 | + - [Warning system](https://www.youtube.com/watch?v=DeE0-5vtZ4E) & Ban system |
| 50 | + - Whitelist system (Discord member, Discord Role, Approved License, Admin-only) |
| 51 | + - Take notes about players |
| 52 | + - Keep track of player's play and session time |
| 53 | + - Self-contained player database (no MySQL required!) |
| 54 | + - Clean/Optimize the database by removing old players, or bans/warns/whitelists |
62 | 55 | - Real-time playerlist |
63 | | -- Scheduled restarts with warning announcements and custom events ([more info](docs/events.md)) |
64 | | -- Translation Support ([more info](docs/translation.md)) |
| 56 | +- Scheduled restarts with warning announcements and custom events ([docs/events.md](docs/events.md)) |
| 57 | +- Translated into over 30 languages ([docs/translation.md](docs/translation.md)) |
65 | 58 | - FiveM's Server CFG editor & validator |
66 | 59 | - Responsive web interface with Dark Mode 😎 |
| 60 | +- And much more... |
67 | 61 |
|
68 | | -Also, check our [Feature Graveyard](docs/feature_graveyard.md) for the features that are no longer among us (RIP). |
| 62 | +Also, check our [Feature Graveyard](docs/feature-graveyard.md) for the features that are no longer among us (😔 RIP). |
69 | 63 |
|
70 | | -## Running (Windows/Linux) |
71 | | -**txAdmin is included in all FXServer builds** above 2524, so to run it for the first time simply do the following: |
72 | | -- Update FXServer to the latest artifact/build (2524 or superior) |
73 | | -- If Windows, run FXServer.exe | If Linux, run `screen ./run.sh` |
74 | | -- Open one of the URLs shown and configure txAdmin |
| 64 | +## Running txAdmin |
| 65 | +- Since early 2020, **txAdmin is a component of FXServer, so there is no need to downloading or installing anything**. |
| 66 | +- To start txAdmin, simply run FXServer **without** any `+exec server.cfg` launch argument, and FXServer will automatically start txAdmin. |
| 67 | +- 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. |
75 | 68 |
|
76 | | -txAdmin requires to be launched from *inside* FXServer in monitor mode, to do that, just execute the `run.sh` or `FXServer.exe` without **any** `+exec` arguments. |
77 | | - |
78 | | -### ConVars |
79 | | -- **serverProfile:** The name of the server profile to start. Profiles are saved/loaded from the current directory inside the `txData` folder. The default is `default`. |
80 | | -- **txAdminPort:** The TCP port to use as HTTP Server. The default is `40120`. |
81 | | -- **txAdminInterface:** The interface to use as HTTP Server. The default is `0.0.0.0`. |
82 | | -- **txDataPath:** The path of the data folder. The default on Windows is `<citizen_root>/../txData` and on Linux `<citizen_root>/../../../txData`. |
83 | 69 |
|
84 | | -ConVar usage **example** for different port and profile: |
85 | | -```bash |
86 | | -# Windows |
87 | | -./FXServer.exe +set serverProfile dev_server +set txAdminPort 40121 |
| 70 | +## Configuration & Integrations |
| 71 | +- 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](docs/env-config.md). |
| 72 | +- You can listen to server events broadcasted by txAdmin to allow for custom behavior in your resources, please see [docs/events.md](docs/events.md). |
88 | 73 |
|
89 | | -# Linux |
90 | | -./run.sh +set serverProfile dev_server +set txAdminPort 40121 |
91 | | -``` |
92 | 74 |
|
93 | | -### Contributing & Development |
| 75 | +## Contributing & Development |
94 | 76 | - All PRs should be based on the develop branch, including translation PRs. |
95 | 77 | - 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. |
96 | | -- If you want to run it from build & source, please do read [this](docs/development.md). |
| 78 | +- If you want to build it or run from source, please check [docs/development.md](docs/development.md). |
97 | 79 |
|
98 | 80 |
|
99 | 81 | ## License, Credits and Thanks |
|
0 commit comments