Données XML de dépôt

Données XML de dépôt

Pour OvGME, un dépôt est simplement un fichier XML qui décrit quels mods sont disponibles, quelque données utiles à leur propos, et le lieu où ils peuvent être téléchargés. C'est pour ainsi dire, une sorte de mini base de donnée. La seule chose étant que dans notre case, les données XML sont fournies par un serveur web.

Structure XML de dépôt

OvGME va rechercher une structure particulière dans les données XML fournies pour recueillir les informations à propos des mods. Cette structure est suffisamment simple pour pouvoir être écrite à la main à l'aide d'un éditeur de texte.

Cependant, OvGME fournit également des outils pour générer automatiquement et tester les fichiers XML de dépôt (voir plus bas).

Voici un exemple de contenu typique d'un fichier XML de dépôt:

<mod_list>

   <mod name="Dummy Mod A" version="1.1" url="www.toto.net/Mod%20A.zip">
   Dummy Mod A Description
Version 1.1

   </mod>

   <mod name="Dummy Mod B" version="1.2" url="www.bubu.org/Mod%20B.zip">
   Dummy Mod B Description
Version 1.2.2

   </mod>

</mod_list>

Si vous n'aviez jamais vu de source XML avant, vous pouvez voir qu'il y'a plusieurs similitudes avec l'HTML étant donné que les deux partagent beaucoup de règles de syntaxe. Le propos de cette aide n'est pas d'expliquer toutes les subtilités de l'XML, mais nous allons parler un peu d'aspect techniques basiques pour mieux comprendre la structure globale.

Dans l'exemple ci-dessus, nous pouvons voir plusieurs entités, colorés pour êtres plus distinctes:

Les entités <mauves> sont nommés des "neouds".
Les entités vertes= sont appelés "attributs".
Les entités "bleues" sont des chaînes, sont les valeurs des attributs.
Les parties noirs sont les données internes des neouds.

Structure des neouds

Dans notre cas nous avons trois noeuds, mod_list est le neoud racine, et les deux mod sont les neouds enfants de ce neoud racine. C'est la structure de base qu'OvGME cherche pour un dépôt: Une racine avec plusieurs enfants, où chaque enfant est un Descripteur de Mod. Des données XML de dépôt peuvent avoir autant de neouds descripteur de mod que vous le souhaitez, il n'y a pas de limitation.

Attributs des descripteurs de mods

Chaque descripteur de mod doit avoir trois attributs nommés respectivement "name", "version" et "url". Ici, le nom est important, OvGME va chercher ces attributs particuliers et leurs valeurs.

Note: l'ordre des attributs n'a pas d'importance, vous pouvez spécifier l'attribut url en premier et name à la fin, cela n'a pas d'impacte.

name : décrit le nom du mod. Ce nom est, pour ainsi dire, ce qui identifie le Mod dans tous les cas, même en interne par les algorithmes d'OvGME pour comparer avec les mods localement installés.
version : décrit la version du mod. Cette valeur sera utilisée, par exemple, pour comparer avec les mods localement installés ( pour plus de détails, voir le chapitre Versioning des mods)
url : est l'URL de téléchargement du fichier. C'est l'adresse à laquelle OvGME enverra une requête pour télécharger le fichier zip du Mod-Archive.

Description du descripteur de mod

Au sein du neoud de descripteur de mod, vous pouvez optionnellement insérer la description du mod, c'est la partie noir dans l'exemple ci-dessus. Il n'y a pas de restriction de taille ou de format, mais, comme en HTML, le format XML ne "reconnait" pas les retours chariot au sein des données. Mais, on ne peut pas utiliser la balise "<br>" comme en HTML. Donc, pour indiquer les retours chariot dans la description, vous devez les encoder avec la séquence spéciale: "
".

Note: Cette séquence signifie littéralement "Met un code ASCII Retour Chariot (13) ; Met un code ASCII Nouvelle Ligne (10) ;" qui est nommé séquence CRLF (Carriage Return Line Feed).

Utilisation du générateur de source XML

Pour aider à la création de de fichier XML de dépôts, OvGME fournit un outil pour créer des sources XML automatiquement par l'analyse du contenu du dossier de stock de mods (ou un dossier personnalisé spécifié). Cet outil prend tous les Mod-Archives valides, verifie la présence d'un VERSION.txt, d'une description, et met tout ensemble dans un code source XML de dépôt.
Pour ouvrir le générateur de source XML, allez dans le menu "Mods", sélectionnez "Repositories" puis "Make XML source..."

Custom mods folder
Si cette option est cochée, doit être un dossier existant contenant des fichiers Mod-Archive valides devant être utilisé pour générer la liste XML des mods..
Si cette option n'est pas cochée, le dossier de mods de la configuration acuelle est utilisée.

Download link nase URL Spécifie la base d'URL utilisée pour générer les liens de téléchargement des Mods. Par exemple, si vous entrez la base d'URL "http://www.example.com/public", les liens de téléchargement seront tel que "http://www.example.com/public/My%20Super%20Mod.zip".

Note:Techniquement, vous n'êtes pas restreints à une localisation/URL pour les liens de téléchargement, vous pouvez utiliser n'importe quelle URL valide pour les liens, et chaque Mod peut avoir son propre lien de téléchargement spécifique. Cependant, le générateur de source XML ne peut générer que des liens de téléchargement générique. Si les liens de téléchargement des Mods sont effectivement dispersés à plusieurs endroits, vous devez éditer le code source XML vous-même en remplaçant les URL des Mods désirés.

Une fois que vous avez spécifié les données requises, vous pouvez générer le code source XML, simplement en cliquant sur le bouton "Generate XML source". Vous pouvez ensuite éditer le contenu du tampon généré pour ajuster à votre convenance.

Finalement, une fois la source XML généré et modifié à votre convenance, vous pouvez sauvegarder le tampon en cliquant sur le bouton "Save as XML...".

Utilisation du parser test de source XML

Pour aider à vérifier si un fichier de dépôt XML sera correctement analysé, OvGME fournit un outil pour tester un fichier XML en tant que source XML de dépôt. Pour ouvrire le parser test de source XML, allez dans le menu "Mods", sélectionnez "Repositories" puis "Test XML source...". Un

To open the XML source test parser, go to the "Mods" menu, select "Repositories", then "Test XML source...". Une nouvelle boîte de dialogue vous invite automatiquement à choisir un fichier XML à tester.

Si l'analyse réussit, vous verrez un message d'analyse de réussite et le résultat de l'analyse dans la zone de texte de sortie. Sinon, une erreur d'analyse est affichée.