Skip to content

Commit 836b173

Browse files
Copilotdarknoon29
andcommitted
docs: fill README.md with module documentation
Agent-Logs-Url: https://github.com/OGSteam/mod-cdr/sessions/88409d70-0708-4300-9bc4-84a4e67c1243 Co-authored-by: darknoon29 <13015521+darknoon29@users.noreply.github.com>
1 parent edbac76 commit 836b173

1 file changed

Lines changed: 60 additions & 1 deletion

File tree

‎README.md‎

Lines changed: 60 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,60 @@
1-
# mod-cdr
1+
## Module OGSpy Champs de Ruines (CDR)
2+
3+
Ce module permet de trier et visualiser par taille les champs de ruines (CDR) repérés sur le jeu via l'extension Xtense.
4+
5+
### Pré Requis ###
6+
7+
* Nécessite OGSpy >= 3.3.6 — [Dépôt OGSpy](https://github.com/ogsteam/ogspy)
8+
* Modules OGspy requis : Xtense
9+
10+
### Fonctionnalités ###
11+
12+
* Affichage de la liste des champs de ruines détectés (métal, cristal, total, coordonnées, nombre de recycleurs nécessaires, date)
13+
* Filtrage par galaxie
14+
* Tri configurable (par coordonnées, total, métal, cristal ou date, croissant ou décroissant)
15+
* Coloration des champs de ruines selon leur taille (configurable par l'utilisateur)
16+
* Seuil de taille minimum paramétrable pour l'affichage
17+
* Rétention des données configurable (en jours)
18+
19+
### Installation ###
20+
21+
Le module s'installe via le gestionnaire de modules d'OGSpy. Le fichier `install.php` crée automatiquement les tables nécessaires en base de données.
22+
23+
### Configuration ###
24+
25+
Chaque utilisateur peut personnaliser dans les options du module :
26+
27+
* Le seuil minimal de taille d'un CDR pour l'affichage
28+
* Les seuils et couleurs de mise en évidence (petit, moyen, grand CDR)
29+
* L'ordre de tri par défaut
30+
* La galaxie affichée par défaut
31+
* La durée de rétention des données (en jours)
32+
33+
### Pour nous contacter ###
34+
35+
* [Forum OGSteam](https://forum.ogsteam.eu) : Vous y trouverez notre équipe de support ainsi que l'invitation vers notre salon Discord
36+
* Discord : https://discord.gg/Azcb67b
37+
38+
### Licence ###
39+
40+
GPL-2.0-only — voir [GNU General Public License](http://opensource.org/licenses/gpl-license.php)
41+
42+
### Historique des Versions ###
43+
44+
Version 1.9.4
45+
- Mise à jour de compatibilité OGSpy 3.3.9
46+
47+
Version 1.9.0
48+
- Ajout de la gestion de la rétention des données (durée configurable en jours)
49+
50+
Version 1.70
51+
- Ajout du support multilingue (français / anglais)
52+
- Ajout du tri de tableau côté client (tablesort)
53+
54+
Version 1.62
55+
- Ajout du script de mise à jour (`update.php`)
56+
- Amélioration du script d'installation
57+
58+
Version 1.60
59+
- Intégration avec Xtense v2 (callbacks)
60+
- Suppression préventive des doublons lors de la mise à jour des données

0 commit comments

Comments
 (0)