Setup#
Do I need ESX, QBCore or any other framework?
No. AstroShield works on a standalone server. It adapts when it finds ESX, QBCore, Qbox or ox_core. See Frameworks.
Can I rename the AstroShield folder?
No. The folder must be called AstroShield. The permission lines in server.cfg and the shared script entry that AstroShield adds to your other resources both use that name.
Does AstroShield change my scripts?
It adds one line, shared_script '@AstroShield/shared-obfuscated.lua', to the manifest of each resource. It never edits your script files. Run astrouninstall to remove the line again. See Shared guard.
Does it work with txAdmin?
Yes. txAdmin admins can be excluded from detections with the txAdmin Whitelist setting. See Permissions and whitelisting.
Do I have to restart when I change settings?
No. Changes you save in the dashboard reach the running server immediately. Only updates of the resource itself need restart AstroShield.
What if AstroShield cannot reach the backend?
It keeps using the last configuration it received, remembers bans on your server and queues ban records to send later. The dashboard shows the server as offline in the meantime. The configuration is not stored on disk, so a server that restarts while the backend is unreachable runs without your configuration until it connects again.
License and IP#
Can I use one license for two servers?
No. One license protects one server. A second server needs its own license. See Plans and pricing.
I moved to a new host. What now?
Your license is locked to your old IP. Request an IP reset, then restart AstroShield on the new server.
What happens when my license expires?
The backend refuses the connection, so your configuration is not delivered and the detections you set up in the dashboard stop. Nothing is deleted. Renew, then restart AstroShield. See Expiry and renewal.
Can I get a refund?
All sales are final and refunds are not issued. See the Terms and Conditions.
Where is my license key?
In the file resources/AstroShield/.key. It is created when you download the resource and you never type it in. Keep it private. See License key.
Moderation#
A player was banned by mistake. How do I unban them?
Open Bans in the dashboard and click Remove, or run astroshield unban <id> in the server console. The ban ID is shown on the ban screen. See Bans.
How can I try a detection without banning anyone?
Turn on Dev Mode in Configuration, General. Detections are logged to the server console with their data and nobody is punished. See Dev Mode.
How do I make my admins immune?
Switch on txAdmin Whitelist and make them txAdmin admins, or give them the ACE astroshield.bypass. See Exempt admins from detections.
How can I see why somebody was banned?
Open the ban in the Bans page. It shows the detection, the reason, the identifiers and a video clip when there is one. See Bans.
A detection fires on something my script does on purpose.
Announce the action with an allowance. If the problem is a flood of events, ignore the event. See the troubleshooting steps.
Privacy#
Does AstroShield record my players?
The game keeps a short rolling recording of the game view (about the last 40 seconds) that is only uploaded when a ban needs evidence or when staff ask for a replay. Screen View is live and only starts when staff request it. See Security and privacy.
What data does AstroShield store about players?
Identifiers such as Discord, FiveM, Xbox, Steam, license, hardware ID and IP address, used for enforcement and fraud detection. See Security and privacy.
Still stuck?#
Read Troubleshooting or ask for support.