sunrise-anticheat

Installation

Deploy the protection bundle to your client layout, staging practices, and rollout checklist.

The protection bundle ships as a ZIP containing the files your client runtime expects (including a system folder pattern — follow the structure from the release notes for your version). This page covers practical installation; exact file names can vary by release.

Before you begin

  • Match the release version to the server and configuration you are testing.
  • Use a staging or internal build first; avoid changing production without a rollback plan.
  • Back up the previous bundle if you are hot-swapping in a live environment.

Layout

  1. Download the archive from the project Releases / Downloads area.
  2. Extract the archive into the client system (or vendor-defined) directory as documented for that build — typically alongside your patched client, not inside a random temp folder.
  3. Ensure the process running the game has read (and if applicable write) permissions to those paths.
  4. If your pipeline signs binaries or repacks assets, re-run your integrity / packaging step after extraction so anti-tamper and distribution rules stay consistent.

Environment

  • Prefer the OS and architecture your release was built for; mixed or emulated environments may be unsupported.
  • Some options (overlay, traffic display, etc.) depend on configuration delivered from the public API — install alone does not enable features that are off in the dashboard.

Upgrades

  1. Note the currently running version and configuration snapshot.
  2. Deploy the new bundle to staging; run through smoke tests (login, zone load, protection triggers).
  3. Promote to production during a maintenance window if you expect downtime or first-run migrations.

Troubleshooting

SymptomThings to check
Client does not load protection modulePaths, permissions, correct architecture, antivirus quarantine.
Version mismatch errorsSame release across fleet; cache cleared if you reuse installs.
Missing premium behaviorPremium active for the project; Free vs Premium and Configuration.

Continue with Configuration to tune behavior after files are in place.

On this page