Logs Docs

kairo-logs v1.1.0 dépendance : kairo-core Voir le produit

Présentation

Kairo Logs enregistre ce qui se passe sur ton serveur : mouvements d'argent, objets, connexions, morts, commandes d'administration. Chaque entrée contient l'identité du joueur (nom, licence, ID).

Les journaux partent vers Discord (un salon par catégorie si tu veux), dans un fichier, ou les deux. Les modules Kairo y envoient automatiquement leurs événements ; tu peux aussi y écrire depuis tes propres ressources.

Installation

  1. Télécharge l'archive depuis « Mes achats » et décompresse-la.
  2. Place le dossier kairo-logs dans resources/[kairo]/ de ton serveur.
  3. Vérifie que kairo-core est démarré avant kairo-logs dans ton server.cfg.
  4. Ajoute la ligne ensure kairo-logs, puis redémarre le serveur. Les tables sont créées automatiquement au premier lancement.
server.cfg
# server.cfgensure kairo-coreensure kairo-logs

Configuration

Une catégorie sans webhook n'écrit que dans le fichier. Les couleurs sont au format décimal attendu par Discord.

config.lua
-- config.luaConfig.File = true          -- logs/kairo-YYYY-MM-DD.logConfig.Categories = {    money   = { webhook = 'https://discord.com/api/webhooks/…', color = 3066993 },    items   = { webhook = 'https://discord.com/api/webhooks/…', color = 15844367 },    admin   = { webhook = 'https://discord.com/api/webhooks/…', color = 15158332 },    connect = { webhook = false }, -- fichier seulement}

API

Les exports s'appellent avec exports['kairo-logs']:Nom(...). Les fonctions serveur ne sont jamais accessibles depuis le client.

Send

serveur
exports['kairo-logs']:Send(category, data)

Écrit une entrée dans une catégorie. Si data contient player, l'identité du joueur est ajoutée automatiquement.

ParamètreTypeDescription
categorystringNom de la catégorie
datatableChamps à enregistrer

Retour rien

exemple.lua
exports['kairo-logs']:Send('money', {    player = source,    amount = 500,    reason = 'paycheck',})

RegisterCategory

serveur
exports['kairo-logs']:RegisterCategory(name, webhook, color)

Crée une catégorie depuis une autre ressource, sans toucher à la configuration.

ParamètreTypeDescription
namestringNom de la catégorie
webhookstring|falseURL du webhook ou false
colornumber?Couleur Discord

Retour rien

exemple.lua
exports['kairo-logs']:RegisterCategory('casino', webhookUrl, 10181046)

FAQ

Discord limite-t-il le nombre de messages ?

Oui. Kairo Logs regroupe les entrées et respecte les limites de Discord : en cas de pic, les messages sont mis en file plutôt que perdus.

Combien de temps les fichiers sont-ils gardés ?

Un fichier par jour, conservé selon Config.KeepDays (30 jours par défaut).