Affichage des résultats 1 à 23 sur 23

Discussion: Modèle de readme pour les mods publiés sur La Couronne

  1. #1
    Date d'inscription
    avril 2011
    Localisation
    Égaré dans un vortex entre Féérune et le Royaume de Diamant Éternel
    Messages 
    5 157

    Lecture Modèle de readme pour les mods publiés sur La Couronne

    Vous trouverez en pièce jointe un modèle de fichier readme destiné aux mods développés et/ou publiés sur la Couronne de Cuivre. Je me suis inspiré des readme des forums anglo-saxons tout en m'efforçant de conserver les codes couleurs utilisés par le forum de La Couronne de Cuivre (sans oublier sa bannière, merci Mornagest ), même si ce n'est pas toujours évident.


    Dans chaque section, j'ai repris, chaque fois que possible, des éléments de traductions déjà publiées (par les d'Oghms ou par bibi) afin de conserver un semblant d'homogénéité dans les termes employés.

    Il vous suffira de conserver les éléments dont vous avez besoin (liste des jeux compatibles, procédures d'installation selon la plateforme, liste des outils utilisés...) et, pour le reste, de remplacer MYMOD et Auteur par les noms du mod et de son auteur, de modifier les liens et de remplir les textes adéquats. Pour certaines sections, j'ai été le plus exhaustif possible : il vous suffit de choisir les paragraphes (et quelquefois le format d'affichage) qui vous intéressent et de supprimer les autres.

    Le modèle est proposé en deux versions : français et anglais.

    Il n'est pas figé et je suis prêt à le modifier selon vos suggestions.


    J'ai transféré le projet sur GitHub, ce qui désencombrera le fofo. Vous y trouverez la dernière version 5.0.0

    Github ! Téléchargement de la dernière version

    Français normal | Français skin BG2 | Anglais normal | Anglais skin BG2
    Dernière modification par Freddy_Gwendo ; 05/08/2020 à 11h03. Motif: Mise à jour de la dernière version
    CARPE DIEM...
    Co-modérateur de La Forge et de La Chambre des Scribes
    Moddeur qui s'arrache les cheveux...

  2. #2
    Date d'inscription
    avril 2011
    Localisation
    Égaré dans un vortex entre Féérune et le Royaume de Diamant Éternel
    Messages 
    5 157

    Version 1.1

    Seconde version (v1.1) : un drapeau permet de passer du readme français à l'anglais, et lycée de Versailles.
    Dernière modification par Freddy_Gwendo ; 16/10/2018 à 07h24. Motif: Ajout du titre
    CARPE DIEM...
    Co-modérateur de La Forge et de La Chambre des Scribes
    Moddeur qui s'arrache les cheveux...

  3. #3
    Date d'inscription
    avril 2011
    Localisation
    Égaré dans un vortex entre Féérune et le Royaume de Diamant Éternel
    Messages 
    5 157
    J'ai repéré quelques typos et l'oubli d'une traduction dans la version anglaise. J'attends quelques retours éventuels avant de mettre à jour l'archive.
    CARPE DIEM...
    Co-modérateur de La Forge et de La Chambre des Scribes
    Moddeur qui s'arrache les cheveux...

  4. #4
    Date d'inscription
    juillet 2003
    Localisation
    Plaisir
    Messages 
    6 958
    Je n'ai pas étudié le contenu en termes de texte mais la mise en page.

    J'ai relevé une erreur de syntaxe :
    Code:
    		<ul>
    			<li>modification</li> <!-- erroné, doit âtre après le bloc <ul>...</ul> -->
    				<ul>
    					<li style="margin-left: -70px"></li>
    					<li style="margin-left: -70px"></li>
    				</ul>
    			</li> <!-- fermeture du li à placer ici pour que le bloc <ul>...</ul> soit effectivement d'un niveau inférieur -->
    			<li>Updated installer <acronym title="Weimer Dialogue Utility">WeiDU</acronym> to v246.</li>
    		</ul>
    Par ailleurs voici une proposition pour retirer le besoin d'ajouter un retrait de -70px dans les éléments de liste de deuxième niveau :
    Code:
    	#maindiv ul {
    		line-height: 170%;
    		margin-left: 4%;
    		width: 87%;
    	}
    	#maindiv ul li {
    	}
    	#maindiv ul li ul {
    		margin: 0px;
    		width: 95%;
    	}
    	#maindiv ul li ul li {
    	}
    C'est un peu compliqué parce que la mise en page utilise à la fois des pourcentages (largeur utile de 90 % un peu partout) et des pixels. Du coup j'ai réduit la largeur en % et fixé les marges en % également. En créant une règle pour la liste incluse dans une autre et en fixant la marge à 0 (elle a une valeur par défaut supérieure) et en augmentant la largeur dans ce cas, on obtient à peu-près le même effet que le retrait de -70px, avec une assez bonne exploitation de la largeur au deuxième niveau.
    J'ai testé avec des largeurs de fenêtre entre environ 1024 et 1920 pixels, avec Firefox et IE.

    Voici un exemple vf avec des textes longs dans l'historique pour vérifier la façon dont la troncature s'effectue, avec la v1.1 comme point de départ.
    Fichiers attachés Fichiers attachés
    Peu disponible
    Guide d'installation (et FAQ) de Baldur's Gate, Baldur's Gate II, Baldur's Gate Trilogy (BGT), BG1Tutu, Widescreen, BGEE
    Pensez à utiliser à la fonction Recherche pour trouver une réponse à votre question !

  5. #5
    Date d'inscription
    avril 2011
    Localisation
    Égaré dans un vortex entre Féérune et le Royaume de Diamant Éternel
    Messages 
    5 157
    Merci pour le retour.

    Le premier point faisait partie des typos que je mentionnais. Je l'ai déjà corrigé.

    Quant au second, je comptais me plonger dans la doc HTML pour mieux comprendre l'utilisation des pourcentages dans le formatage des blocs, mais, pris par le temps pour sortir BuTcHeRy, j'ai paré au plus pressé. Ton code est beaucoup plus élégant, et surtout il pourra être aisément modifié selon les usages, notamment pour le prochain readme d'1PP qui utilise plusieurs niveaux de listes. Je l'intègrerai donc dans la future version.

    Elle comprendra aussi deux readme.md pour les dépôts GitHub. C'est plus compliqué à écrire parce Markdown ne reconnait pas tous codes HTML et plusieurs formatages sont impossibles à réaliser. Mais au final, je pense avoir produit un canevas utilisable.
    CARPE DIEM...
    Co-modérateur de La Forge et de La Chambre des Scribes
    Moddeur qui s'arrache les cheveux...

  6. #6
    Date d'inscription
    avril 2011
    Localisation
    Égaré dans un vortex entre Féérune et le Royaume de Diamant Éternel
    Messages 
    5 157
    Mise à jour : version 2.0.0

    • Correction de liens erronés, de typos, et ajout de Blender dans les outils
    • Ajout de la proposition d'Isaya pour gérer les listes à plusieurs niveaux. Je l'ai modifiée pour ajouter un niveau supplémentaire de liste.
    • Ajout de la procédure de lecture des fichiers ini qui sera utilisée par les prochains outils d'installation automatique
    • Ajout des fichiers .md pour les dépôts github
    • Ajout de plusieurs drapeaux étrangers


    J'ai ouvert un dépôt GitHub pour mieux gérer les modifs. Le lien se trouve dans le premier message.
    Dernière modification par Freddy_Gwendo ; 25/09/2019 à 11h32.
    CARPE DIEM...
    Co-modérateur de La Forge et de La Chambre des Scribes
    Moddeur qui s'arrache les cheveux...

  7. #7
    Date d'inscription
    avril 2011
    Localisation
    Égaré dans un vortex entre Féérune et le Royaume de Diamant Éternel
    Messages 
    5 157
    Mise à jour : version 3.0.0

    • Ajout de balises spoilers dans les fichiers html et md
    • Ajout d'un petit bonus dans la section Présentation du fichier html
    • Corrections mineures diverses
    Dernière modification par Freddy_Gwendo ; 06/02/2019 à 06h23.
    CARPE DIEM...
    Co-modérateur de La Forge et de La Chambre des Scribes
    Moddeur qui s'arrache les cheveux...

  8. #8
    Date d'inscription
    avril 2011
    Localisation
    Égaré dans un vortex entre Féérune et le Royaume de Diamant Éternel
    Messages 
    5 157

    Mise à jour : version 4.0.0

    De nouvelles améliorations, notamment dues à une pratique plus intensive de markdown.


    Modifications générales (fichiers .html et .md) :

    • Correction de typos.
    • Ajouts de lignes de séparations manquantes.
    • Section Installation :
      • Réécriture de la procédure.
      • Modification du nom des fichiers ini.
      • Ajout du traitement des chaînes de caractères dans les fichiers ini.
    • Section Composants :
      • Suppression de la référence au BiG World Setup, obsolète et plus maintenu.
      • Traduction en anglais du tableau.
      • Ajout d'une présentation alternative si le mod comprend au moins une dizaine de composants.
    • Section Crédits et remerciements :
      • Mise à jour des liens GitHub pour WeiDU et NearInfinity.



    readme-lcc.html

    • Reformatage (notamment introduction du code Dos).



    readme.md

    • Modifications générales :
      • Ajout de badges en en-tête.
      • Centrage du nom du mod en en-tête.
      • Utilisation des codes de formatage markdown.
      • Alignement à droite du retour en haut de page.
      • Ajout de liens vers deux listes de codes de smileys et d'emoji utilisables par markdown.
      • Ajout du "truc" pour souligner un texte.
    • Section Compatibilité :
      • Ajout des lignes manquantes en anglais.


    Enjoy.
    Dernière modification par Freddy_Gwendo ; 17/11/2019 à 12h40.
    CARPE DIEM...
    Co-modérateur de La Forge et de La Chambre des Scribes
    Moddeur qui s'arrache les cheveux...

  9. #9
    Date d'inscription
    avril 2011
    Localisation
    Égaré dans un vortex entre Féérune et le Royaume de Diamant Éternel
    Messages 
    5 157
    Je dispose d'une nouvelle version sous le coude, mais avant de la publier, j'aimerais que des utilisateurs de mac et de linux vérifient la véracité de la procédure d'installation proposée et, le cas échéant, m'indiquent quelles améliorations y apporter.

    Merci d’avance.
    CARPE DIEM...
    Co-modérateur de La Forge et de La Chambre des Scribes
    Moddeur qui s'arrache les cheveux...

  10. #10
    Avatar de Mornagest
    Mornagest est déconnecté Chantre du mauvais goût
    Date d'inscription
    octobre 2003
    Localisation
    Juste derrière vous, prêt à hurler BOUH !
    Messages 
    16 793
    Pour la procédure d'installation sur GNU/Linux, j'ajouterais qu'il faut également copier tolower dans /usr/bin, sans quoi l'exécutable n'est pas appelable (puisqu'absent).

    Également, pour installer un mod, il faut écrire weinstall sans majuscule. Aucun exécutable Linux ne comporte de majuscule.

    Merci pour tes modèles !
    Administrateur général, également en charge des sections The Witcher, Torment, Icewind Dale et Morrowind. Je modère dans cette couleur.

    Rejoignez Melandis, la Cité du Chaos
    La biographie de Mornagest ainsi que ses quêtes et sa couleur RP #6C84FF ; la biographie de Henk et sa couleur RP #3BBB34

    "Ne vous imaginez pas être différente de ce qu'il eût pu sembler à autrui que vous fussiez ou eussiez pu être en restant identique à ce que vous fûtes sans jamais paraître autre que vous n'étiez avant d'être devenue ce que vous êtes."
    (Lewis Caroll)

  11. #11
    Date d'inscription
    avril 2011
    Localisation
    Égaré dans un vortex entre Féérune et le Royaume de Diamant Éternel
    Messages 
    5 157
    Il me semblait que tolower était inclus dans l'archive WeiDU pour linux, mais je peux me tromper. Il faut que je vérifie.
    Quant à la majuscule, c'est ballot, la seule chose que je connais de linux, c'est le lower case.

    Pour info, je me suis inspiré de ces modèles pour créer les nouveaux pour les mods SHS.
    Dernière modification par Freddy_Gwendo ; 17/12/2019 à 21h11.
    CARPE DIEM...
    Co-modérateur de La Forge et de La Chambre des Scribes
    Moddeur qui s'arrache les cheveux...

  12. #12
    Avatar de Mornagest
    Mornagest est déconnecté Chantre du mauvais goût
    Date d'inscription
    octobre 2003
    Localisation
    Juste derrière vous, prêt à hurler BOUH !
    Messages 
    16 793
    Oui, oui, tolower est bien inclus dans l'archive, mais tu dois également le copier dans /usr/bin comme weinstall et weidu sans quoi l'appel de la commande tolower pour tout passer en minuscules ne fonctionnera pas (puisque l'exécutable ne sera pas présent).

    Je ne sais pas si je suis très clair, désolé...
    Administrateur général, également en charge des sections The Witcher, Torment, Icewind Dale et Morrowind. Je modère dans cette couleur.

    Rejoignez Melandis, la Cité du Chaos
    La biographie de Mornagest ainsi que ses quêtes et sa couleur RP #6C84FF ; la biographie de Henk et sa couleur RP #3BBB34

    "Ne vous imaginez pas être différente de ce qu'il eût pu sembler à autrui que vous fussiez ou eussiez pu être en restant identique à ce que vous fûtes sans jamais paraître autre que vous n'étiez avant d'être devenue ce que vous êtes."
    (Lewis Caroll)

  13. #13
    Date d'inscription
    avril 2011
    Localisation
    Égaré dans un vortex entre Féérune et le Royaume de Diamant Éternel
    Messages 
    5 157
    Je crois que j'ai pigé.
    Suis un peu claqué ce soir, mais je soumettrai une nouvelle formulation demain et tu me confirmeras si c'est plus clair.

    Encore merci.
    CARPE DIEM...
    Co-modérateur de La Forge et de La Chambre des Scribes
    Moddeur qui s'arrache les cheveux...

  14. #14
    Date d'inscription
    avril 2011
    Localisation
    Égaré dans un vortex entre Féérune et le Royaume de Diamant Éternel
    Messages 
    5 157
    Alors, voici les instructions corrigées pour linux :

    MYMOD pour Linux est diffusé sous forme d'archive compressée (tarball) sans l'installateur WeiDU.
    Extrayez le contenu du mod dans le répertoire du jeu que vous voulez moder.
    Téléchargez la version la plus récente de WeiDU pour Linux sur WeiDU.org et copiez weidu, weinstall et tolower dans /usr/bin. Ouvrez ensuite un terminal et allez cd dans le répertoire d'installation de votre jeu, lancez « tolower » et répondez « Y » aux deux questions. Vous pouvez éviter d'exécuter la seconde option (Linux.ini) si vous l'avez déjà lancée une fois dans le même dossier. Pour gagner du temps, l'archive est déjà passée en minuscules, aussi il n'est pas non plus nécessaire d'exécuter la première option (passer les noms de fichiers en minuscules) si vous n'avez extrait que ce mod depuis la dernière fois que vous avez passé les noms de fichiers en minuscules. Si vous avez un doute, il vaut mieux exécuter tolower et accepter les deux options.

    Lancez "weinstall setup-mymod" depuis le dossier de votre jeu pour installer le mod. Puis, lancez "wine bgmain.exe"et commencez à jouer.
    Ça roule comme ça ?
    CARPE DIEM...
    Co-modérateur de La Forge et de La Chambre des Scribes
    Moddeur qui s'arrache les cheveux...

  15. #15
    Date d'inscription
    août 2008
    Localisation
    Bretagne
    Messages 
    1 518
    Pour la copie des binaires je conseille de remplacer :
    copiez weidu, weinstall et tolower dans /usr/bin
    par :
    copiez weidu, weinstall et tolower dans /usr/local/bin
    L’avantage c’est que ça évite de les mélanger aux binaires fournis par le système, et rend *beaucoup* moins dangereux une éventuelle fausse manipulation.
    L’inconvénient c’est que ce répertoire peut ne pas exister sur la machine du lecteur du guide, qui devra alors le créer.

    La convention veut généralement que /usr/bin soit le territoire des binaires gérés par le système de paquets de la distribution, et /usr/local/bin celui des binaires gérés par l’administrateur de la machine.

  16. #16
    Date d'inscription
    avril 2011
    Localisation
    Égaré dans un vortex entre Féérune et le Royaume de Diamant Éternel
    Messages 
    5 157
    Merci. Pour vérification, tu trouveras les liens pour les afficher ici. Lorsque le formatage et le texte seront finalisés, je rapatrierai les liens ici.
    CARPE DIEM...
    Co-modérateur de La Forge et de La Chambre des Scribes
    Moddeur qui s'arrache les cheveux...

  17. #17
    Date d'inscription
    juillet 2003
    Localisation
    Plaisir
    Messages 
    6 958
    Même si je reconnais que c'est plus propre, il y a tout de même un inconvénient à différer de l'emplacement habituellement recommandé dans les autres readme ou les tutoriels. Les gens pourraient se demander pourquoi.

    En tout cas, si tu stipules de copier dans /usr/local/bin, qui n'est généralement pas dans le PATH (d'autant moins si on le crée à cette occasion), cela va poser un problème pour lancer tolower et weinstall. Pour le premier, tu pourrais demander de lancer "/usr/local/bin/tolower". Pour le second, l'ajout du chemin ne suffira pas si weinstall appelle ensuite weidu, ce qui est probable vu leurs tailles respectives. Donc au final, le plus sûr serait d'ajouter, au moins avant de lancer weinstall, de taper la commande
    Code:
    export PATH=$PATH:/usr/local/bin
    Peu disponible
    Guide d'installation (et FAQ) de Baldur's Gate, Baldur's Gate II, Baldur's Gate Trilogy (BGT), BG1Tutu, Widescreen, BGEE
    Pensez à utiliser à la fonction Recherche pour trouver une réponse à votre question !

  18. #18
    Date d'inscription
    avril 2011
    Localisation
    Égaré dans un vortex entre Féérune et le Royaume de Diamant Éternel
    Messages 
    5 157
    wouah... c'est en train de devenir une véritable usine à gaz ce truc. Bon, je proposerai les deux versions demain. Et les utilisateurs de linux trancheront.
    CARPE DIEM...
    Co-modérateur de La Forge et de La Chambre des Scribes
    Moddeur qui s'arrache les cheveux...

  19. #19
    Date d'inscription
    avril 2011
    Localisation
    Égaré dans un vortex entre Féérune et le Royaume de Diamant Éternel
    Messages 
    5 157

    Mise à jour : version 5.0.0

    Elle était dans les cartons depuis un moment, et j'ai profité de la sortie de la nouvelle skin du forum pour l’officialiser.


    Modifications générales (fichiers .html et .md) :

    • Correction des derniers typos (enfin, je l'espère).
    • Externalisation des paramètres de style dans les fichiers style_lcc.css* et style_lcc_bg2.css.
    • Externalisation du code javascript dans le fichier script_astuce.js.
    • Skin BG2 : ajout d'une infobulle personnalisée en remplacement de la balise `acronym`.
    • Tous les fichiers images sont désormais en minuscules.
    • Section Compatibilité : Ajout de la mention du patch pour les utilisateurs de ToB et des liens pour télécharger les mods de conversions (BGT et EET).
    • Section Installation : Remplacement de l'outil modmerge par DLC Merger et ré-écriture de la procédure d'installation linux (merci à Fossy et à vv221 !).
    • Section Crédits et remerciements : Ajout de la Creative Commons License.


    Fichiers readme-lcc.html

    • Ajout d'une version dotée de la nouvelle skin BG2 de LCC ( n'oubliez-pas de supprimer le suffixe "bg2" aux fichiers .html, ainsi que dans les liens qu'ils contiennent pour passer de la version française à la version anglaise, et lycée de Versailles).
    • Ajout des captures d'écran superposées.
    • Reformatage de nombreuses sections.


    Fichiers readme.md

    • Suppression des balises `acronym` non visibles dans les fichiers .md.


    Et j'ai ajouté des liens qui permettent de visualiser les fichiers html dans le premier message.

    Enjoy.
    CARPE DIEM...
    Co-modérateur de La Forge et de La Chambre des Scribes
    Moddeur qui s'arrache les cheveux...

  20. #20
    Date d'inscription
    mars 2010
    Localisation
    Paris
    Messages 
    1 154
    Bon...

    Je viens de télécharger le modèle.

    On édite comment le modèle?

    J'ai l'impression d'avoir raté une marche et d'avoir dévalé un escalier en mode Carl Lewis.

    Ca fait mal.

    Putain de BG, tout est compliqué pour faire mod, même le partage. PTDR

    Ahh ca fait du bien de rire un coup.


    Cocrane

  21. #21
    Date d'inscription
    avril 2011
    Localisation
    Égaré dans un vortex entre Féérune et le Royaume de Diamant Éternel
    Messages 
    5 157
    Modèles créés et édités avec Notepad++. Je pense que n'importe quel éditeur de texte doit fonctionner.

    Édit : l'avantage de Notepad++, c'est qu'il dispose de Highlighters intégrés pour HTLM et MD.
    Dernière modification par Freddy_Gwendo ; 03/06/2020 à 06h46.
    CARPE DIEM...
    Co-modérateur de La Forge et de La Chambre des Scribes
    Moddeur qui s'arrache les cheveux...

  22. #22
    Date d'inscription
    mars 2010
    Localisation
    Paris
    Messages 
    1 154
    J'avais oublié que le HTML était du texte à la base.

    Je vois plusieurs fichiers, vu que mon mod est uniquement en Français, j'ai juste readme-lcc-fr.html à mettre à jour?

    Cocrane

  23. #23
    Date d'inscription
    avril 2011
    Localisation
    Égaré dans un vortex entre Féérune et le Royaume de Diamant Éternel
    Messages 
    5 157
    Yes, sir.
    Tu peux choisir quelle version tu souhaites utiliser : le style classique de LCC ou le nouveau de BG2.
    CARPE DIEM...
    Co-modérateur de La Forge et de La Chambre des Scribes
    Moddeur qui s'arrache les cheveux...

Discussions similaires

  1. [HELP] Demande de relecteurs de readme de mods
    Par Freddy_Gwendo dans le forum La Chambre des Scribes
    Réponses: 14
    Dernier message: 06/12/2018, 16h43
  2. [MODS] Problème de chargement de la Couronne
    Par Fabi1b dans le forum Le Bazar de l'Aventurier
    Réponses: 9
    Dernier message: 01/05/2007, 09h26
  3. [MODS] Korgan meurt à la Couronne de Cuivre
    Par Sith dans le forum Le Bazar de l'Aventurier
    Réponses: 2
    Dernier message: 09/10/2005, 07h46
  4. [BP] ReadMe en français pour l'install
    Par Mérillym Martial dans le forum Méga-mods : Big Picture, The Darkest Day, Shadow Over Soubar, Tortured Souls, Check The Bodies,
    Réponses: 46
    Dernier message: 14/04/2005, 15h07

Règles de messages

  • Vous ne pouvez pas créer de nouvelles discussions
  • Vous ne pouvez pas envoyer des réponses
  • Vous ne pouvez pas envoyer des pièces jointes
  • Vous ne pouvez pas modifier vos messages
  •  

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251