clean up your mess

# 🧹 Clean Up Your Mess

**Removed a mod? Its leftovers are still on your server.**
Config files, world data and even whole dimensions stay on the server after a mod is uninstalled. Clean Up Your Mess finds them, lets you review them, and moves them safely out of the way. It never deletes anything by itself.

---

## ✨ Features

- **🔍 Automatic detection.** It compares your `config/` folder and your world with the mods that are actually loaded, then flags everything that no longer belongs to any of them:
  - config files and folders
  - mod data folders in the world
  - `world/data/*.dat` files
  - whole dimensions (`world/dimensions/<mod>`)
- **📋 List first, act later.** Nothing moves until you have reviewed the list and confirmed.
- **📦 Quarantine, not deletion.** Leftovers go to a dated quarantine folder. Changed your mind? One command puts everything back, and nothing is ever overwritten.
- **🛡️ Protect list.** If a file belongs to an installed mod whose file name doesn't match its ID, protect it with one click and it will never be suggested again.
- **🧠 Knows common exceptions.** Files such as Armourer's Workshop's `skin-database`, JourneyMap's `JMPlayerSettings`, ModernFix's `mfix_*`, YACL, Cardinal Components, WTHIT, ETF/EMF, REI and Xaero's are recognised automatically when their mod is installed.
- **📝 Full reports.** Every scan, quarantine and restore writes a detailed `.log` report, plus a `history.log` with one line per operation (date, who, result).
- **🚀 Startup scan.** It checks automatically when the server starts and warns you in the console if leftovers are found.
- **⚡ No lag.** All file work runs off the main server thread.
- **🔒 Safe by design.**
  - Vanilla world files are never touched.
  - Anything ambiguous is kept.
  - It can only move items located inside `config/` and the world folder.
  - A list stays valid for 15 minutes and can only be applied once.
- **🌍 English & French.** Chat messages and reports are available in both languages.

---

## 🧭 Commands

| Command | Description |
|---|---|
| `/cleanup` | Show the help |
| `/cleanup list` | Scan and list leftovers, write a report (moves nothing) |
| `/cleanup apply` | Quarantine what the last list showed (valid for 15 min) |
| `/cleanup protect <name>` | Never suggest this item again |
| `/cleanup batches` | Show quarantine batches |
| `/cleanup restore [batch]` | Restore a batch (latest by default) |
| `/cleanup reload` | Reload the config |

**Permission:** `cleanupyourmess.admin` (LuckPerms). Without LuckPerms, it requires OP level 4. The server console can always use it.

---

## 🔄 How to use it

1. Run `/cleanup list`. You get the list in chat and a full report in `cleanupyourmess/reports/`.
2. **Read the list.** If an item belongs to an installed mod, click **[protect]** next to it.
3. Run `/cleanup apply`. Everything listed is moved to `cleanupyourmess/quarantine/<date>/`.
4. Play normally for a while. If something breaks, `/cleanup restore` puts everything back.
5. Once you're sure, delete the batch folder from your file manager to free the space.

---

## 📁 Files

| Path | Content |
|---|---|
| `cleanupyourmess/reports/<date>_scan.log` | Scan report |
| `cleanupyourmess/reports/<date>_quarantine.log` | Quarantine report |
| `cleanupyourmess/reports/<date>_restore.log` | Restore report |
| `cleanupyourmess/reports/history.log` | One line per operation |
| `cleanupyourmess/quarantine/<batch>/` | Quarantined items (+ `lot.txt`) |
| `config/cleanupyourmess.json` | Configuration |

---

## ⚙️ Configuration (`config/cleanupyourmess.json`)

| Option | Default | Description |
|---|---|---|
| `language` | `"en"` | `"en"` or `"fr"`, for chat messages and reports |
| `scanOnStartup` | `true` | Scan when the server starts |
| `scanConfig` | `true` | Scan the `config/` folder |
| `scanWorld` | `true` | Scan the world folder and `world/data` |
| `scanDimensions` | `true` | Scan `world/dimensions/` |
| `quarantineFolder` | `"cleanupyourmess/quarantine"` | Quarantine location |
| `reportFolder` | `"cleanupyourmess/reports"` | Report location |
| `listValidityMinutes` | `15` | How long a list stays valid for `apply` |
| `protectedItems` | *(list)* | Items that are never suggested |

---

## ⚠️ Please note

- **Always read the list before applying.** Some mods name their files differently from their ID. The mod plays it safe, but you know your server best.
- **Back up your server** before any cleanup. It's good practice.
- Blocks and items from removed mods are not handled. Minecraft already removes them by itself when chunks load.
- Some leftovers may contain player data, such as a removed backpack mod's inventories. Keep their batch if you might reinstall that mod.

---

## 📦 Requirements

• Minecraft **1.21.1**
  - **Fabric Loader** 0.16 or newer
  - **Fabric API**
  - **Server-side only.** Players don't need to install it.
  - LuckPerms: optional

# 🧹 Clean Up Your Mess

**Tu as retiré un mod ? Ses restes sont toujours sur ton serveur.**
Fichiers de config, données du monde, parfois des dimensions entières : tout reste sur le serveur après la désinstallation d'un mod. Clean Up Your Mess les trouve, te laisse vérifier, puis les met à l'écart en toute sécurité. Il ne supprime jamais rien de lui-même.

---

## ✨ Fonctionnalités

- **🔍 Détection automatique.** Il compare ton dossier `config/` et ton monde avec les mods réellement chargés, puis repère tout ce qui n'appartient plus à aucun d'eux :
  - fichiers et dossiers de config
  - dossiers de données de mods dans le monde
  - fichiers `world/data/*.dat`
  - dimensions entières (`world/dimensions/<mod>`)
- **📋 D'abord la liste, ensuite l'action.** Rien ne bouge tant que tu n'as pas relu la liste et confirmé.
- **📦 Quarantaine, pas suppression.** Les restes vont dans un dossier de quarantaine daté. Tu changes d'avis ? Une commande remet tout en place, sans jamais rien écraser.
- **🛡️ Liste de protection.** Si un fichier appartient à un mod installé dont le nom de fichier ne correspond pas à son identifiant, tu le protèges en un clic et il ne sera plus jamais proposé.
- **🧠 Connaît les exceptions courantes.** Des fichiers comme le `skin-database` d'Armourer's Workshop, le `JMPlayerSettings` de JourneyMap, les `mfix_*` de ModernFix, ou ceux de YACL, Cardinal Components, WTHIT, ETF/EMF, REI et Xaero sont reconnus automatiquement quand leur mod est installé.
- **📝 Comptes rendus complets.** Chaque analyse, quarantaine et restauration écrit un rapport `.log` détaillé, plus un `history.log` avec une ligne par opération (date, auteur, résultat).
- **🚀 Analyse au démarrage.** La vérification est automatique au lancement du serveur, avec une alerte dans la console s'il trouve des restes.
- **⚡ Aucun lag.** Tout le travail sur les fichiers se fait en dehors du thread principal du serveur.
- **🔒 Sûr par conception.**
  - Les fichiers vanilla du monde ne sont jamais touchés.
  - Au moindre doute, l'élément est gardé.
  - Il ne peut déplacer que des éléments situés dans `config/` et dans le dossier du monde.
  - Une liste reste valable 15 minutes et ne peut être appliquée qu'une seule fois.
- **🌍 Anglais et français.** Les messages et les rapports sont disponibles dans les deux langues.

---

## 🧭 Commandes

| Commande | Description |
|---|---|
| `/cleanup` | Affiche l'aide |
| `/cleanup list` | Analyse et liste les restes, écrit un rapport (ne déplace rien) |
| `/cleanup apply` | Met en quarantaine ce que la dernière liste a montré (valable 15 min) |
| `/cleanup protect <nom>` | Ne plus jamais proposer cet élément |
| `/cleanup batches` | Voir les lots en quarantaine |
| `/cleanup restore [lot]` | Restaurer un lot (le plus récent par défaut) |
| `/cleanup reload` | Recharger la config |

**Permission :** `cleanupyourmess.admin` (LuckPerms). Sans LuckPerms, il faut être OP de niveau 4. La console du serveur peut toujours l'utiliser.

---

## 🔄 Comment l'utiliser

1. Tape `/cleanup list`. Tu obtiens la liste dans le chat et un rapport complet dans `cleanupyourmess/reports/`.
2. **Relis la liste.** Si un élément appartient à un mod installé, clique sur **[protéger]** à côté.
3. Tape `/cleanup apply`. Tout ce qui est listé part dans `cleanupyourmess/quarantine/<date>/`.
4. Joue normalement quelque temps. Si quelque chose ne va plus, `/cleanup restore` remet tout en place.
5. Une fois sûr de toi, supprime le dossier du lot depuis ton gestionnaire de fichiers pour libérer la place.

---

## 📁 Fichiers

| Emplacement | Contenu |
|---|---|
| `cleanupyourmess/reports/<date>_scan.log` | Rapport d'analyse |
| `cleanupyourmess/reports/<date>_quarantine.log` | Rapport de mise en quarantaine |
| `cleanupyourmess/reports/<date>_restore.log` | Rapport de restauration |
| `cleanupyourmess/reports/history.log` | Une ligne par opération |
| `cleanupyourmess/quarantine/<lot>/` | Éléments en quarantaine (+ `lot.txt`) |
| `config/cleanupyourmess.json` | Configuration |

---

## ⚙️ Configuration (`config/cleanupyourmess.json`)

| Option | Par défaut | Description |
|---|---|---|
| `language` | `"en"` | `"en"` ou `"fr"`, pour les messages et les rapports |
| `scanOnStartup` | `true` | Analyse au démarrage du serveur |
| `scanConfig` | `true` | Analyse le dossier `config/` |
| `scanWorld` | `true` | Analyse le dossier du monde et `world/data` |
| `scanDimensions` | `true` | Analyse `world/dimensions/` |
| `quarantineFolder` | `"cleanupyourmess/quarantine"` | Emplacement de la quarantaine |
| `reportFolder` | `"cleanupyourmess/reports"` | Emplacement des rapports |
| `listValidityMinutes` | `15` | Durée de validité d'une liste pour `apply` |
| `protectedItems` | *(liste)* | Éléments jamais proposés |

---

## ⚠️ À savoir

- **Relis toujours la liste avant d'appliquer.** Certains mods nomment leurs fichiers autrement que leur identifiant. Le mod reste prudent, mais c'est toi qui connais le mieux ton serveur.
- **Fais une sauvegarde** avant tout nettoyage, c'est une bonne habitude.
- Les blocs et objets des mods retirés ne sont pas gérés. Minecraft les supprime déjà tout seul au chargement des chunks.
- Certains restes peuvent contenir des données de joueurs, comme le contenu des sacs d'un mod de sacs à dos retiré. Garde leur lot si tu risques de réinstaller ce mod.

---

## 📦 Prérequis

- Minecraft **1.21.1**
- **Fabric Loader** 0.16 ou plus récent
- **Fabric API**
- **Côté serveur uniquement.** Les joueurs n'ont rien à installer.
- LuckPerms : optionnel