KlyrGuard - Documentation Officielle

Bienvenue, Administrateur_

Cette documentation est votre centre de commande pour KlyrGuard. Elle est conçue pour une mise en service rapide et une configuration intuitive. L'intégrité de votre serveur est notre seule mission.

Présentation

KlyrGuard est un système anti-cheat de nouvelle génération pour la plateforme FiveM. Il opère avec une philosophie double :

Protection Proactive : Détecter et bloquer les menaces avant qu'elles n'impactent l'expérience de vos joueurs.
Performance Optimale : Assurer une charge quasi nulle (~0.01ms) sur le CPU de votre serveur pour ne jamais sacrifier la fluidité du jeu.

Notre système combine des analyses côté client et des vérifications côté serveur pour créer une forteresse numérique autour de votre communauté.

Fonctionnalités Clés

🛡️ Détection Côté Client : Analyse active de la mémoire, détection d'injections, de menus de triche et de modifications non autorisées du jeu.
🌐 Vérifications Côté Serveur : Détection d'événements suspects (triggers), de godmode, de spawn d'entités et d'autres exploits courants.
💥 Anti-Explosions & Anti-Spam : Protection contre les triggers malveillants visant à faire planter les joueurs ou le serveur.
💻 Panel de Gestion (Prochainement) : Une interface web pour visualiser les logs, gérer les bans et configurer les détections en temps réel.
🔌 Installation "Plug-and-Play" : Conçu pour être opérationnel en moins de 5 minutes.
⚙️ Configuration Poussée : Un fichier config.lua complet pour fine-tuner chaque aspect de la protection.

Installation

STATUS: PROCESSUS SIMPLE

Téléchargez la dernière version de KlyrGuard.
Décompressez l'archive klyrguard.zip.
Glissez-déposez le dossier klyrguard dans le répertoire resources de votre serveur FiveM.
Ouvrez votre fichier server.cfg et ajoutez la ligne suivante. L'ordre est important : KlyrGuard doit être démarré avant vos autres scripts pour une efficacité maximale.
```
ensure klyrguard
```
Configurez votre clé de licence dans le fichier config.lua.
(Re)démarrez votre serveur. KlyrGuard est maintenant actif.

Configuration (config.lua)

Le fichier config.lua est le cerveau de KlyrGuard. Toutes les options y sont commentées pour vous guider.

Exemple de structure du config.lua :

Config = {}

-- [[ CLÉ DE LICENCE ]] --
-- Votre clé personnelle obtenue après l'achat
Config.LicenseKey = "KLYR-XXXXXXXXXXXXXXXX" 

-- [[ LOGS & ALERTES ]] --
-- URL du Webhook Discord pour recevoir les alertes
Config.DiscordWebhook = "https://discord.com/api/webhooks/..."

-- [[ PARAMÈTRES DE BAN ]] --
-- Activer le ban automatique
Config.AutoBan = true 
Config.BanMessage = "Vous avez été banni par KlyrGuard. Raison : Triche avérée."

-- [[ LISTE BLANCHE (WHITELIST) ]] --
-- Les joueurs avec ces identifiants ne seront pas affectés
Config.Whitelist = {
    'license:monadminlicense' 
}

-- [[ MODULES DE DÉTECTION ]] --
Config.Modules = {
    AntiBlacklistedWeapons = true, -- Bloque les armes non autorisées
    AntiSpectate = true,           -- Empêche le mode spectateur non autorisé
    AntiTazeExploit = true,        -- Bloque l'exploit de tazer en boucle
}

Option	Type	Description
`Config.LicenseKey`	`string`	Obligatoire. Votre clé de licence unique.
`Config.DiscordWebhook`	`string`	URL du Webhook Discord pour les notifications en temps réel.
`Config.AutoBan`	`boolean`	`true` pour bannir automatiquement, `false` pour n'envoyer qu'une alerte.
`Config.Whitelist`	`table`	Liste des identifiants (license, steam, discord) à ignorer.
`Config.Modules`	`table`	Permet d'activer (`true`) ou de désactiver (`false`) chaque module.

Commandes Administrateur

Ces commandes sont accessibles en jeu par les administrateurs (nécessite d'être connecté via le système de permissions de FiveM).

/klyr_status - Affiche l'état actuel de KlyrGuard et le nombre de détections.
/klyr_check [ID joueur] - Lance une vérification manuelle approfondie sur un joueur.
/klyr_logs [ID joueur] - Affiche les derniers avertissements pour un joueur.

API & Exports (Pour les Développeurs)

KlyrGuard expose des fonctions pour permettre à vos autres scripts d'interagir avec l'anti-cheat.

Exemple : Vérifier un joueur avant une transaction.

-- Dans un autre script (côté serveur)
local isPlayerFlagged = exports.klyrguard:IsPlayerFlagged(source)

if not isPlayerFlagged then
    -- Le joueur est clean, on peut continuer
    player.addMoney(1000)
else
    -- Le joueur a un historique suspect, on refuse
    print("Transaction refusée, KlyrGuard a levé un drapeau.")
end

Export	Côté	Description
`IsPlayerFlagged(source)`	Serveur	Retourne `true` si le joueur a déjà déclenché des détections.
`IsPlayerWhitelisted(source)`	Serveur	Retourne `true` si le joueur est dans la whitelist.

Dépannage & FAQ

Problème : Mon serveur affiche une erreur `Authentication failed`.

Solution : Vérifiez que votre Config.LicenseKey est correcte et qu'elle correspond à l'IP de votre serveur. Assurez-vous que votre pare-feu ne bloque pas la connexion à nos serveurs d'authentification.

Problème : Un joueur a été banni par erreur (faux positif).

Solution : Les faux positifs sont extrêmement rares mais possibles. Contactez notre support sur Discord avec le log de détection et l'identifiant du joueur pour analyse, puis retirez son ban manuellement.

Question : KlyrGuard protège-t-il contre les attaques DDoS ?

Réponse : Non. KlyrGuard est un anti-cheat (protection en jeu). La protection DDoS doit être assurée par votre hébergeur.

Support & Communauté

CANAL DE COMMUNICATION PRINCIPAL: DISCORD

Pour toute question, rapport de bug ou suggestion, notre communauté et notre équipe de support sont disponibles exclusivement sur Discord.

[LIEN VERS VOTRE SERVEUR DISCORD]