MODs : création et lecture expliquées [MAJ 30/07/2005]

Ce forum regroupe quelques documents de référence que j'ai rédigé
Répondre
Avatar de l’utilisateur
FTP
Messages : 1028
Inscription : 06 mars 2004 14h41
Contact :

MODs : création et lecture expliquées [MAJ 30/07/2005]

Message par FTP »

Dernière modification par FTP le 30 juil. 2005 14h53, modifié 1 fois.
L'urgent est fait, l'impossible est en cours, pour les miracles prévoir 24h !
Avatar de l’utilisateur
FTP
Messages : 1028
Inscription : 06 mars 2004 14h41
Contact :

Message par FTP »

Qu'est ce qu'un MOD phpBB ?

L'un des gros avantages des logiciels développés à partir de scripts php sous licence GPL comme phpBB est qu'il est légal et facile de modifier leur code pour les améliorer et/ou y ajouter de nouvelles fonctionnalités. En effet, ils sont à la fois basés sur du code facilement accessible (non compilé) et fourni sous licence GPL, donc libre.

Du coup, dès la première apparition de phpBB les administrateurs de forums n'ont pas tardé à écrire et mettre en ligne des procédures visant à améliorer la version originale fournie par le groupe phpBB. Ces procédures d'abord appelées "Hack", ont ensuite été appelées "MOD" (pour MODification) afin d'éviter tout risque de confusion avec le monde des "Hackers".

:arrow: Définition : un MOD phpBB est donc une procédure précise visant à MODifier le code d'un forum phpBB pour permettre de corriger une anomalie, d'améliorer son fonctionnement, ou d'ajouter une nouvelle fonctionnalité.
Dernière modification par FTP le 15 mai 2005 10h38, modifié 1 fois.
L'urgent est fait, l'impossible est en cours, pour les miracles prévoir 24h !
Avatar de l’utilisateur
FTP
Messages : 1028
Inscription : 06 mars 2004 14h41
Contact :

Message par FTP »

Qu'est ce que le modèle de MOD phpBB ?

Le phénomène des MODs prenant de l'ampleur, il a fait prendre conscience au groupe phpBB qu'il allait lui falloir édicter des règles pour harmoniser et sécuriser la présentation de ces procédures, les rendre plus lisibles et plus facile à installer.
Et c'était d'autant plus important qu'au delà de faire gagner du temps à tout le monde, ça permettrait aussi de fiabiliser l'installation de ces MODs en faisant en sorte que seules des instructions claires, documentées et comprises par tous puissent être utilisées.
Ainsi est né le 1er modèle de MOD officiel ("MOD template" en anglais).

:arrow: Définition : le modèle de MOD phpBB est composé d'une structure de MOD type et d'un ensemble de règles visant à encadrer les auteurs de MODs pour qu'ils respectent une forme simple, lisible et comprise par tous dans la rédaction de leurs procédures.

Voici la structure type d'un MOD...

Code : Tout sélectionner

##############################################################
## MOD Title:          nom_du_MOD
## MOD Author:         pseudo_phpBB < email > (nom_réel) site_web
## MOD Description:    brêve_descrition_du_MOD (3/4 lignes max)
## MOD Version:        x.x.x
##
## Installation Level: Easy ou Intermediate ou Advanced
## Installation Time:  x minutes
## Files To Edit:
##      fichier_1 
##      fichier_1 
##      etc.
## Included Files:
##      fichier_1 ou N/A
##      fichier_1 
##      etc.
## License: https://opensource.org/licenses/gpl-license.php GNU Public License v2
##############################################################
## For security purposes, please check: https://www.phpbb.com/mods/
## for the latest version of this MOD. Although MODs are checked
## before being allowed in the MODs Database there is no guarantee
## that there are no security problems within the MOD. No support
## will be given for MODs not found within the MODs Database which
## can be found at https://www.phpbb.com/mods/
##############################################################
## Author Notes:
##
##############################################################
## MOD History:
##
##   YYYY-MM-DD - Version x.x.x
##      - notes de version
##
##############################################################
## Before Adding This MOD To Your Forum, You Should Back Up All Files Related To This MOD
##############################################################
#
#-----[ ACTION ]---------------------------------------------- 
#

#
#-----[ ACTION ]---------------------------------------------- 
#

#
#-----[ ACTION ]---------------------------------------------- 
#

#
#-----[ SAVE/CLOSE ALL FILES ]-------------------------------- 
#
# EoM
Source : Le modèle de MOD officiel phpBB.com
Dernière modification par FTP le 30 juil. 2005 11h20, modifié 3 fois.
L'urgent est fait, l'impossible est en cours, pour les miracles prévoir 24h !
Avatar de l’utilisateur
FTP
Messages : 1028
Inscription : 06 mars 2004 14h41
Contact :

Message par FTP »

Comment lire/écrire l'en-tête d'un MOD phpBB ?

Que vous vouliez lire un MOD pour l'installer ou comprendre les rubriques pour être capable d'en écrire un, voici une explication du contenu de l'en-tête d'un MOD phpBB, section par section.

Cette en-tête se décompose en 5 partie :

La "carte d'identité" du MOD...

Code : Tout sélectionner

##############################################################
## MOD Title:          nom_du_MOD
## MOD Author:         pseudo_phpBB < email > (nom_réel) site_web
## MOD Description:    brêve_descrition_du_MOD (3/4 lignes max)
## MOD Version:        x.x.x
##
## Installation Level: Easy ou Intermediate ou Advanced
## Installation Time:  x minutes
## Files To Edit:
##      fichier_1 
##      fichier_1 
##      etc.
## Included Files:
##      fichier_1 ou N/A
##      fichier_1 
##      etc.
## License: https://opensource.org/licenses/gpl-license.php GNU Public License v2
##############################################################
  • MOD Title : il s'agit du nom du MOD
  • MOD Author : cette rubrique comporte 4 parties :
    - pseudo_phpBB : il s'agit de votre pseudo sur les forums phpBB.com (obligatoire),
    - email : il s'agit de votre email entre < > ou de < N/A > si vous ne voulez pas le communiquer,
    - nom_réel : il s'agit de vos prénom et nom ou de "N/A" si vous ne voulez pas les communiquer,
    - site_web : il s'agit de l'url de votre site web/forum ou de "N/A" si vous ne voulez pas la communiquer ou n'en avez pas.
    Remarque 1 : vous devez laisser des espaces entre les guillemets et votre email, comme ceci < francois@pignon.com >. Par ailleurs, il est interdit de mettre des espaces autour du "@" ou de le remplacer par tous autres caractères comme "AT".
    Remarque 2 : seul votre email, nom réel et site web sont optionnels (mais doivent être remplacés par "N/A" (= Non Available = Non Communiqué en français) si vous ne voulez pas les communiquer). Votre pseudo phpBB est obligatoire pour pouvoir être contacté à tout moment !
    Remarque 3 : vous pouvez mentionner plusieurs autheurs du MOD. Pour celà il suffit de placer plusieurs lignes "MOD Author:" en mettant en premier le créateur du MOD ou celui qui le développe principalement.
    Source : Comment mentionner les multiples auteurs d'un MOD
  • MOD Description : cette rubrique sert à placer une brève explication de ce que fait le MOD. Pour une installation dans le cadre d'EasyMOD, seules les 4 premières lignes seront affichées ! Si vous voulez placer des explications plus longues mettez les dans les "Author Notes".
  • MOD Version : c'est le numéro de version du MOD. Attention, un système de numérotation des MODs dérivé de celui de Linux a été défini par le groupe phpBB. Vous devez le respecter :
    - le 1er chiffre indique les versions majeurs du MOD. On doit en changer quand il y a rupture de compatibilité avec les versions précédentes ou après une réécriture complète du MOD. Un 0 indique que le MOD est en cours de développement.
    - le 2nd chiffre indique l'ajout d'une nouvelle fonctionnalité ou une correction de sécurité majeure mais les versions en cours de développement doivent utiliser un numéro impair et les versions stables un numéro pair !
    - le 3ème chiffre indique de simples corrections de bugs ; aucune nouvelle fonctionalités
    - enfin, il est aussi possible d'utiliser une lettre après le dernier chiffre pour indiquer une ré-édition de la même version s'il y avait un problème dans la première édition (oublie d'un fichier, pb de présentation, erreur dans une instruction, etc.).
    Votre première version finale stable doit être numérotée 1.0.0 .
    Source : Le système de numérotation des MODs officiel phpBB.com
  • Installation Level : cette rubrique indique le niveau de difficulté d'installation du MOD selon vous. Vous pouvez utiliser "Easy" ou "Intermediate" ou "Advanced".
  • Installation Time : cette rubrique indique le temps moyen d'installation du MOD selon vous (en minutes)
  • Files To Edit : cette rubrique donne la liste des fichiers à modifier.
  • Included Files : cette rubrique donne la liste des fichiers livrés avec le MOD et nécessaires à son installation. Mettre N/A s'il n'y en a pas.
  • License : cette rubrique permet d'indiquer sous quelle licence est distribué le MOD. Par défaut, le template mentionne la licence GPL V2, celle qu'utilise phpBB et qui est aussi celle que tout MOD qui touche au code de phpBB et qui est soumis à l'équipe des MODs pour être ajouté à la base des MODs phpBB.com doit utiliser !
    Source : La licence des MODs
    Plus d'info : Copyright & licence d'utilisation expliqués
La décharge de responsabilité...

Code : Tout sélectionner

##############################################################
## For security purposes, please check: https://www.phpbb.com/mods/
## for the latest version of this MOD. Although MODs are checked
## before being allowed in the MODs Database there is no guarantee
## that there are no security problems within the MOD. No support
## will be given for MODs not found within the MODs Database which
## can be found at https://www.phpbb.com/mods/
##############################################################
Cette décharge de responsabilité concernant la fiabilité du MOD est imposé par le groupe phpBB pour qu'un MOD puisse être soumis et intégré à la base des MODs de phpBB.com. Il prévient que malgré le fait que les MODs soient testés, il n'est pas garanti qu'ils soient totalement exempts de faille de sécurité. Par ailleurs, il indique aussi qu'aucun support ne sera apporté sur phpBB.com pour des MODs qui n'ont pas été téléchargés dans la base des MODs de phpBB.com.

Les notes d'auteur...

Code : Tout sélectionner

############################################################## 
## Author Notes: 
## 
##############################################################
La section des "Notes d'auteur" vous donne la possibilité de placer ici les informations que celui qui va installer le MOD aura besoin de connaître.
Elle est faite spécialement y placer des explications applicables aux instructions et à l'utilisation du MOD, mais pas les actions d'installation proprement dites qui sont à mettre plus bas.
Remarque : Ne mettez pas vos notes sur la même ligne que "Notes de l'auteur". Utilisez les lignes en dessous.

L'historique du MOD...

Code : Tout sélectionner

############################################################## 
## MOD History: 
## 
##   YYYY-MM-DD - Version x.x.x 
##      - notes de version
## 
##############################################################
La section de l'Historique du MOD est faite pour des notes propres à chaque version du MOD.
A chaque nouvelle version du MOD, cette section doit être complétée en respectant bien la manière de présenter l'historique.

Enfin, un rappel de bon sens...

Code : Tout sélectionner

############################################################## 
## Before Adding This MOD To Your Forum, You Should Back Up All Files Related To This MOD 
##############################################################
Faite TOUJOURS une sauvegarde avant de modifier quoi que ce soit, et donc d'installer un MOD !!!

Voilà.
Maintenant que vous savez tout sur l'en-tête des MODs, voici un exemple pour finir de clarifier les choses. Juste une précision : celui-ci est entièrement écrit en anglais, mais vous pourriez parfaitement renseigner chaque rubrique en français. Simplement, dans ce cas vous ne pourriez plus soumettre votre MOD au groupe phpBB car pour une diffusion internationale les instructions doivent être en anglais.

Code : Tout sélectionner

############################################################## 
## MOD Title:          Abnormal posts widening fix
## MOD Author:         -=ET=- < N/A > (N/A) https://www.golfexpert.net/phpbb
## MOD Description:    This MOD fix the abnormal posts widening
##                     when a large image is included in a message
## MOD Version:        1.0.3
##
## Installation Level: Easy
## Installation Time:  1 Minutes (1mn by EasyMOD)
## Files To Edit:
##      templates/subSilver/viewtopic_body.tpl
## Included Files:     N/A
## License: https://opensource.org/licenses/gpl-license.php GNU Public License v2
##############################################################
## For security purposes, please check: https://www.phpbb.com/mods/
## for the latest version of this MOD. Although MODs are checked
## before being allowed in the MODs Database there is no guarantee
## that there are no security problems within the MOD. No support
## will be given for MODs not found within the MODs Database which
## can be found at https://www.phpbb.com/mods/
##############################################################
## Author Notes:
##
## 1. EasyMOD
## -----------
## This MOD is compatible with EasyMOD of Nuttzy and can be
## installed by it but is not yet certified EMC (EasyMOD Compliant)!
## https://area51.phpbb.com/phpBB22/viewforum.php?sid=&f=15
##
## 2. Official last version link
## -----------
## Meanwhile the phpBB group validation and as the MOD is not yet
## in the phpBB MOD database, check this official link for updates...
## https://www.golfexpert.net/phpBB
## 
############################################################## 
## MOD History: 
## 
##   2004-02-16 - Version 1.0.3
##      - Fix buttons not always fully aligned on the right
##
##   2004-02-12 - Version 1.0.2
##      - Fix rewrite because the "nowrap" instruction for post
##        buttons not always applied
##
##   2003-07-29 - Version 1.0.1
##      - Fix rewrite to be compatible with the
##        "Bottom-Aligned-Signature" MOD of John B. Abela
##        https://www.phpbb.com/phpBB/viewtopic.php?t=11225
##      - How-to rewrite to be EasyMOD compatible
##
##   2003-07-10 - Version 1.0.0
##      - Initial final release
##
############################################################## 
## Before Adding This MOD To Your Forum, You Should Back Up All Files Related To This MOD 
##############################################################
Dernière modification par FTP le 30 juil. 2005 14h56, modifié 13 fois.
L'urgent est fait, l'impossible est en cours, pour les miracles prévoir 24h !
Avatar de l’utilisateur
FTP
Messages : 1028
Inscription : 06 mars 2004 14h41
Contact :

Message par FTP »

Comment lire/écrire les actions d'un MOD phpBB ?

Pour décrire toutes les opérations à réaliser pour installer un MOD phpBB il y a 14 types d'actions possibles. Leur enchaînement constitue, étape par étape, la procédure d'installation du MOD.
Les voici résumées...
  • [ SQL ] = Exécuter une ou plusieurs requêtes SQL
  • [ COPY ] = Copier un ou plusieurs fichiers
  • [ OPEN ] = Ouvrir un fichier
  • [ DIY INSTRUCTIONS ] = Exécuter les instructions spécifiées manuellement
  • [ FIND ] = Chercher une ou plusieurs lignes dans un fichier
  • [ REPLACE WITH ] = Remplacer la ou les lignes trouvées par une ou plusieurs nouvelles lignes de code
  • [ AFTER, ADD ] = Ajouter après la ou les lignes trouvées (sur la ligne en dessous) une ou plusieurs nouvelles lignes de code
  • [ BEFORE, ADD ] = Ajouter avant la ou les lignes trouvées (sur la ligne au dessus) une ou plusieurs nouvelles lignes de code
  • [ IN-LINE FIND ] = Dans la ou les lignes trouvées, chercher un morceau de code
  • [ IN-LINE REPLACE WITH ] = Remplacer le morceau code trouvé par un nouveau morceau code
  • [ IN-LINE AFTER, ADD ] = Ajouter immédiatement après le morceau de code trouvé (à droite), un nouveau morceau code
  • [ IN-LINE BEFORE, ADD ] = Ajouter immédiatement avant le morceau de code trouvé (à gauche), un nouveau morceau code
  • [ IN-LINE INCREMENT ] = Incrémenter un nombre
  • [ SAVE/CLOSE ALL FILES ] = Sauvegarder et fermer tous les fichiers ouverts
Si vous pensez que ces 12 actions ne sont pas suffisantes, demandez de l'aide pour trouver une solution car sauf cas extrême (rarissime), vous n'avez pas le droit de vous en créer et d'utiliser d'autres actions que ces 12 là !

Et maintenant les voilà tel quelles doivent être présentées, avec quelques exemples...

Code : Tout sélectionner

# 
#-----[ SQL ]-------------------------------------------------
# 
CREATE TABLE `phpbb_config` ( 
  `config_name` varchar(255) NOT NULL default '', 
  `config_value` varchar(255) NOT NULL default '', 
  PRIMARY KEY  (`config_name`) 
) ENGINE=MyISAM; 
INSERT INTO phpbb_config (config_name, config_value) VALUES ('sig_allow_smilies', '1');
ALTER TABLE phpbb_users ADD user_allowsignature TINYINT not null DEFAULT '1';
 
Par ces instructions, la personne qui installera le MOD devra exécuter un ou des requêtes SQL. Plusieurs requêtes peuvent être regroupées au sein de la même action SQL. Chaque requête peut utiliser plusieurs lignes mais 2 requêtes ne peuvent être sur la même ligne. Enfin, chaque requête doit se terminer par un ";".
=> Si une action SQL doit être présente dans le MOD, elle doit être placée en première position (après l'en-tête et avant un COPY et les autres actions).

Code : Tout sélectionner

# 
#-----[ COPY ]------------------------------------------------
# 
copy root/admin/sig_reset.php to admin/sig_reset.php
copy root/language/lang_english/lang_sig_control.php to language/lang_english/lang_sig_control.php
 
Par ces instructions vous pouvez télécharger/copier un ou des fichiers sur le serveur. Vous pouvez regrouper toutes les instructions de copie au sein de la même action COPY.
Attention, si vous devez copier un fichier par langue, ou un par thème, vous devez toujours ne mettre qu'une seule instruction demandant de copier le fichier pour l'anglais et/ou pour subSilver. Les autres copies pour les autres langues et/ou thèmes sont toujours sous entendu : c'est l'anglais, sous entendu + les autres langues installées, et/ou subSilver, sous entendu + les autres thèmes installés.
=> Si une action COPY doit être présente dans le MOD, elle doit être placée après SQL et avant le reste des actions.

Code : Tout sélectionner

#
#-----[ DIY INSTRUCTIONS ]------------------------------------
#
Passer en CHMOD 777 exemple1.php and exemple2.php 
Ouvrir votre navigateur, exécutez db_install.php et suivez les instructions.
 
Cette action permet de spécifier des instructions non réalisables par les 13 autres actions. Ces instructions devront être exécutées à la main car EasyMOD ne sera pas capable de les traiter ; il se contentera de les afficher.

Code : Tout sélectionner

# 
#-----[ OPEN ]------------------------------------------------
# 
includes/constants.php 
 
Dans l'exemple ci-dessus, on ouvre le fichier "constants.php" qui est situé dans le répertoire "includes" (depuis la racine de phpBB).
Ne commencez pas le chemin par un "/" et n'incluez pas le répertoire de phpBB non plus !!!
Attention, si vous devez faire ouvrir un fichier par langue, ou un par thème, vous devez toujours ne mettre qu'une seule instruction demandant d'ouvrir le fichier anglais et/ou de subSilver. Pour ce qui est des langues, les modifications pour les autres langues sont à mettre dans des mini MODs à part, et pour ce qui est des thèmes cela indique qu'il faut modifier subSilver, sous entendu + les autres thèmes installés.
=> L'action OPEN sera toujours la première de votre MOD après SQL et COPY.

Code : Tout sélectionner

# 
#-----[ FIND ]------------------------------------------------
# 
{L_NEW_POSTS}
 
Ici, on va chercher la chaîne "{L_NEW_POSTS}" dans le code du fichier que l'on vient d'ouvrir en vue d'identifier la ligne correspondante.
:!: Attention ! Cette recherche (comme dans cet exemple d'ailleurs) peut parfaitement se faire sur une partie d'une ou de plusieurs lignes, le tout étant que le morceau de code à chercher permette d'identifier avec certitude la ou les bonnes lignes (qu'il soit unique dans tout le fichier).
FIND est une manière simple pour la personne qui va installer le MOD de savoir exactement sur quelles lignes quelque chose qui va suivre va avoir lieu.

Code : Tout sélectionner

# 
#-----[ REPLACE WITH ]----------------------------------------
#
<td><table width="100%" border="0" cellspacing="0" cellpadding="0"><tr>
 
Ici on va remplacer TOUTE la ou les ligne(s) trouvée(s) par le FIND par la ligne "<td><table width="100%" border="0" cellspacing="0" cellpadding="0"><tr>".
:!: REPLACE WITH replace entièrement la ou les ligne(s) trouvée(s) par la ou les lignes indiquées ; pas seulement le morceau de code qui était recherché dans le FIND !

Code : Tout sélectionner

# 
#-----[ AFTER, ADD ]------------------------------------------
# 
<img src="templates/subSilver/images/lang_french/image.gif" alt="{L_VOTRE_VARIABLE}"/>
 
Ici on va après la ou les ligne(s) trouvée(s) par le FIND (en dessous), ajouter la nouvelle ligne de code.
AFTER, ADD permet de demander à la personne qui installe le MOD d'ajouter une ou des lignes de code après celle(s) qu'il vient de trouver (sur la ligne en dessous).

Code : Tout sélectionner

# 
#-----[ BEFORE, ADD ]-----------------------------------------
# 
<img src="templates/subSilver/images/lang_french/image.gif" alt="{L_VOTRE_VARIABLE}"/>
 
Ici on va avant la ou les ligne(s) trouvée(s) par le FIND (au dessus), ajouter le nouveau code indiqué.
BEFORE, ADD permet de demander à la personne qui installe le MOD d'ajouter une ou des lignes de code avant celle(s) qu'il vient de trouver (sur la ligne au dessus).

Code : Tout sélectionner

# 
#-----[ IN-LINE FIND ]----------------------------------------
# 
user_from = '" . str_replace("\'", "''", $location) . "',
 
Par cette action (IN-LINE FIND) vous pouvez trouver un morceau de code dans une ou des lignes de code

Code : Tout sélectionner

# 
#-----[ IN-LINE REPLACE WITH ]--------------------------------
# 
user_from_flag = '$user_flag',
 
IN-LINE REPLACE WITH permet de remplacer le code trouvé (et uniquement ce code, pas la ligne entière) par celui ci mentionné dans cette action.

Code : Tout sélectionner

# 
#-----[ IN-LINE AFTER, ADD ]----------------------------------
# 
user_from_flag = '$user_flag',
 
IN-LINE AFTER, ADD permet d'ajouter du code directement après celui trouvé dans la ligne (immédiatement à droite du dernier caractère recherché dans IN-LINE FIND)

Code : Tout sélectionner

# 
#-----[ IN-LINE BEFORE, ADD ]---------------------------------
# 
user_from_flag = '$user_flag',
 
IN-LINE BEFORE, ADD permet d'ajouter du code directement avant celui trouvé dans la ligne (immédiatement à gauche du dernier caractère recherché dans IN-LINE FIND)

Code : Tout sélectionner

#
#-----[ IN-LINE INCREMENT ]-----------------------------------
# 
%:1 +1
 
Cette action permet d'ajouter ou de retrancher un nombre à un autre placé dans le code d'un fichier.

Enfin, à la toute fin de votre MOD, ajoutez :

Code : Tout sélectionner

# 
#-----[ SAVE/CLOSE ALL FILES ]--------------------------------
# 
# EoM
Il s'agit d'un simple rappel de sauvegarder/fermer tous les fichiers que vous avez modifié.

(ah vi, au passage EoM veut dire simplement End of MOD pour ceux qui se poseraient la question :mrgreen: )

Source : Les actions du modèle de MOD officiel phpBB.com
Dernière modification par FTP le 11 févr. 2006 13h50, modifié 4 fois.
L'urgent est fait, l'impossible est en cours, pour les miracles prévoir 24h !
Avatar de l’utilisateur
FTP
Messages : 1028
Inscription : 06 mars 2004 14h41
Contact :

Message par FTP »

Quelques compléments d'information

Voici quelques autres informations qui pourront vous être utile... :wink:
  • Comment utiliser les apostrophes/guillemets dans vos libellés ?
    Si vous définissez une chaîne de langue comme ceci "Bonjour !", PHP va l'analyser et essayer de remplacer les variables qu'il pourra trouver dedans. La plupart du temps ce genre d'analyse est inutile et va à l'encontre des standards de programmation de phpBB. Alors qu'une chaîne définit comme ceci 'Bonjour !' n'entraîne pas d'analyse et d'essai de substitution de variable de la part de PHP.
    Donc à chaque fois que c'est possible (qu'il n'y a pas de variable dans votre chaîne de langue), préférez les apostrophes aux guillemets ; et pour inclure une apostrophe dans une chaîne délimités pas des apostrophes, placer un "\" devant. Exemple...

    Code : Tout sélectionner

    $lang['xxx'] = 'N\'utilisez pas de guillemets';
  • Fichier du MOD
    Un MOD s'écrit toujours dans un simple fichier texte portant l'extension ".txt" (ou ".mod" mais je déconseille cette extension car elle est déjà utilisée par un format de fichier de son).
    Par ailleurs, si vous tenez à ce que votre MOD soit compatible EasyMOD, lisez ce post et respectez scrupuleusement ses consignes.
  • Langue des MODs
    Dans l'absolue, la procédure d'installation d'un MOD pourrait être écrite dans n'importe quelle langue.
    Simplement :
    - Si vous écrivez le contenu des rubriques en français vous ne pourrez plus soumettre votre MOD au groupe phpBB car pour une diffusion internationale les instructions doivent être en anglais
    - Et si vous traduisait aussi le nom des rubriques et/ou des actions en français, alors non seulement le MOD ne pourra plus être soumis au groupe phpBB mais en plus il vous faudra utiliser iEM pour qu'il soit installable par EasyMOD.

    Personnellement je vous déconseille fortement de traduire le nom des rubriques et des actions :roll:
    Le contenu peu importe. Vous pouvez le mettre en français.
  • Modèle de MOD
    Voici un modèle de MOD directement utilisable et compatible EasyMOD.
  • MOD validator
    Le groupe phpBB a mis en place un outil très pratique pour aider les auteurs de MODs à vérifier que leurs créations respectent la plupart des règles imposées. Il s'agit du "MOD validator".

    Pour l'utiliser c'est très simple. Allez sur la page du MOD validator, faite un copier/coller de votre MOD entier dans la fenêtre du MOD validator, et cliquez sur le bouton "Submit".
    Vous obtiendrez alors dans la rubrique Overall soit un passed vert synonyme de succès, soit un failed rouge avec un certain nombre d'explications pour vous aider à corriger les erreurs.

    Attention, le contenu du MOD peut être en français mais pas le nom des rubriques et actions ! En effet il faut respecter le modèle officiel pour que le MOD validator accepte le MOD.
  • Pour en savoir plus
    Si vous voulez en savoir plus, direction les documents de référence sur le sujet sur le site officiel de phpBB.com.
L'urgent est fait, l'impossible est en cours, pour les miracles prévoir 24h !
Répondre