The Configuration page is where you shape the anticheat for your server. It needs the Configuration permission.
How changes are applied#
- Nothing changes until you click Save Changes in the bar that appears at the bottom when you have unsaved changes. Cancel reverts them.
- Saved changes are pushed to your running server straight away. You do not need to restart the server or the resource.
- If another admin saves while you have unsaved changes, you get a notice, Configuration updated by another admin, and a Reload button. Your edits are kept until you decide.
- Use the search box to find a detection by name.
The page has five tabs: General, Player & Vehicle, Weapons & World, Network & Moderation and Bans.
General#
These settings apply to the whole server, not to a single detection.
| Setting | What it does |
|---|---|
| Ban Message | The headline players see when they are banned. |
| Ban Subtitle | The smaller text under it, for example how to appeal. |
| Auto-Update | Installs new versions of the resource automatically. See Updating. |
| Dev Mode | Logs detections to the server console instead of punishing. See Dev Mode. |
| Enable Discord Button | Shows a Discord button on the ban screen. |
| Discord URL and Discord Button Text | Where the button points and what it says. Use your own invite. |
| txAdmin Whitelist | Excludes txAdmin admins from all detections. See Permissions and whitelisting. |
| Webhooks | Discord webhook URLs for Bans, Connect and Disconnect logs. |
Webhooks#
Paste a Discord webhook URL into each field you want. A ban webhook message contains the player, the detection and reason, the ban ID, the identifiers, a link to the evidence and the player's last server events. Connect and disconnect webhooks log joins and leaves.
Webhook URLs are secrets. They are stored in your configuration but are never sent to your players' clients.
Detections#
The three middle tabs hold the detections, grouped like this:
| Tab | Groups |
|---|---|
| Player & Vehicle | Player, Ped, Movement, Vehicle |
| Weapons & World | Weapon, Entity, Object, Explosion |
| Network & Moderation | Network, Moderation, Executors, Others |
Each detection has a switch to turn it on or off. Click it to open Configure and change its options, such as limits, lists of blacklisted models, or whitelists, then click Save Changes. Lists take one entry per line.
You may see these badges:
| Badge | Meaning |
|---|---|
| Experimental | Newer detection that can produce false positives. Try it in Dev Mode first. |
| Advanced | Tuning for experts, for example the event protection lists. |
| DEV | Dev Mode is on, so nothing is punished. |
Every detection is explained in the detection reference.
What happens when a detection fires#
Detections that punish ban the player. A few detections never punish, like the vehicle weapons cleaner, and the event protection only protects. For the full flow, see Punishments.
Dev Mode#
Dev Mode lets you see what AstroShield would do without doing it. Use it on a new server, after enabling an experimental detection or when you suspect false positives.
While it is on:
- Detections and custom rule punishments are only written to the server console, with their raw data.
- Nobody is kicked, banned, isolated or recorded, and no ban record or webhook is sent.
- Each console line says what would have happened, for example
would be banned, with the reason, the detection data, the player's state and their recent server events. - A detection that keeps firing is printed at most every 3 seconds per player, with a count of the repeats in between.
- The console banner shows a DEV MODE notice and the dashboard shows the DEV badge.
Turning Dev Mode off prints Dev mode is off: detections punish players again.
Dev Mode switches off punishments for everyone, including real cheaters. Do not leave it on.
Fix Config#
Sometimes your saved configuration lacks detections or options that a newer resource version has. Fix Config compares your configuration with the current detection list and fills the gaps in the form. It reports what it found, for example 3 missing detections and 2 missing fields.
- Missing detections are added switched on.
- Missing options are added with an empty value:
0,offor an empty list. - It changes the form only. Review the values, then click Save Changes.
If your configuration is already complete it says Server config is already complete, nothing to fix.
Bans tab#
Import, export and remove all bans. See Bans.
Shared configs#
You can start from a configuration that another server owner published, and publish your own. See Shared Configs.