Paradox AntiCheat

High-performance security for Minecraft Bedrock (Realms & BDS)

---

📦 API Compatibility Matrix

API Module	Required Version	Description / Purpose
@minecraft/server	2.10.0-Beta	Core Script Engine API for world events, entity handling, block management, and main logic loops.
@minecraft/server-net	1.0.0-Beta	Handles external HTTP network communication for remote logging, telemetry, and external server synchronization.
@minecraft/server-admin	1.0.0-Beta	Manages elevated server administrative functions, secret configuration properties, and execution variables.
@minecraft/server-ui	2.2.0-Beta	Renders custom in-game UI menus, dynamic modal dialogs, and action forms directly to players.

---

📖 About Paradox AntiCheat

Paradox AntiCheat is a high-performance anti-cheat system engineered for Minecraft Bedrock Edition. Designed for seamless integration into both Realms and BDS (Dedicated Server) environments, it ensures a balanced and fair gameplay experience for everyone.

Paradox (noun): A statement or situation that contradicts itself, yet reveals a fundamental truth.

The name reflects our philosophy: leveraging advanced, non-obvious detection algorithms to outsmart cheaters in ways that seem counterintuitive on the surface.

Key Highlights

• Modular Design: Tailor individual checks and enforcement rules to match your server's needs.
• Realms & BDS Ready: Native support for both official Minecraft Realms and custom Dedicated Servers.
• Developer Friendly: Simple setup workflow with comprehensive documentation.

For complete integration instructions and API references, check out the Official Documentation.

---

📊 Project Status & Metrics

---

🚀 Quick Start Guide

1. Installation

1. Download the latest release from the Releases page based on your server setup:
   • Realms & Singleplayer: Download the .mcpack file.
   • Bedrock Dedicated Server (BDS): Download the .zip file.
2. Apply the anti-cheat to your server:
   • Realms / Singleplayer: Import the .mcpack file directly and apply it to your world's Behavior Packs.
   • BDS: Extract the .zip file directly into your server's behavior_packs folder and register the folder name in world_behavior_packs.json.
3. Move the pack to the top priority position in your active list.
4. Enable Beta APIs in your World Settings under Experiments.

⚠️ Important: Setting the pack to the highest priority and enabling Beta APIs are strictly required for state detection and event hooks to work.

2. Versioning Format

Paradox follows a Major.Minor.Patch semantic scheme:

Segment	Meaning	Example Scenario
X.0.0	Major Version	Core architecture overhauls or breaking changes
0.X.0	Major Revision	Feature additions, feature updates, or check removals
0.0.X	Minor Revision	Urgent patches, bug fixes, and minor adjustments

---

🛠️ Development Environment Setup

Prerequisites & Dependencies

• Node.js (LTS Version)
• Visual Studio Code
• Git

---

Option A: Linux Setup

1. Run the Automated Setup Script:

   chmod +x ./bin/setup-node-linux.sh
   ./bin/setup-node-linux.sh

   This automatically installs NVM, fetches the latest Node.js LTS, and sets default aliases.

2. Install Node Packages:

   npm install

Option B: Windows Setup

1. Run the Automated PowerShell Script:

   .\bin\setup-node-windows.ps1

   This downloads the Node.js LTS installer and updates your system environment path.

2. Install Node Packages:

   npm install

Option C: Manual Workspace Setup

If you prefer installing tools manually:

1. Install VS Code via installer or package manager:

   sudo apt update && sudo apt install code

2. Clone your repository:

   git clone https://github.com/<your-github-username>/Paradox_AntiCheat.git
   cd Paradox_AntiCheat

3. Install dependencies & launch workspace:

   npm install
   code .

---

🤝 Contributing

We welcome contributions! Follow these step-by-step instructions to get started:

1. Fork the Repository: Visit the Paradox AntiCheat Repository and click Fork.
2. Clone your fork:

   git clone https://github.com/<your-github-username>/Paradox_AntiCheat.git
   cd Paradox_AntiCheat

3. Install dependencies:

   npm install

4. Create a branch and make changes:

   git checkout -b feature/my-new-check

5. Stage & Commit your updates:

   git add .
   git commit -m "feat: add new speed detection module"

6. Push to GitHub & Open Pull Request:

   git push origin feature/my-new-check

   Then navigate to the original repository to initiate a Pull Request.

---

Need help? Join our Discord Server for support and discussion.