Developing OpenSim Addins/fr - Revision history

Acryline at 11:55, 26 February 2015

2015-02-26T11:55:16Z

Acryline at 12:00, 16 February 2015

2015-02-16T12:00:17Z

Acryline: /* Distribuer des modules complémentaires */

2015-02-11T20:51:41Z

‎Distribuer des modules complémentaires

Acryline: /* Distribuer des modules complémentaires */

2015-02-11T20:50:05Z

‎Distribuer des modules complémentaires

Acryline: /* Distribuer des modules complémentaires */

2015-02-11T20:49:12Z

‎Distribuer des modules complémentaires

Acryline: /* Distribuer des modules complémentaires */

2015-02-11T20:47:58Z

‎Distribuer des modules complémentaires

Acryline: /* Empaqueter l'Addin */

2015-02-11T20:36:08Z

‎Empaqueter l'Addin

Acryline: /* Configuration */

2015-02-11T20:33:15Z

‎Configuration

Acryline: /* Configuration */

2015-02-11T20:25:12Z

‎Configuration

Acryline: /* Directive pour les modules complémentaires */

2015-02-11T20:04:05Z

‎Directive pour les modules complémentaires

@@ Line 1: / Line 1: @@
 {{Languages|Developing_OpenSim_Addins}}
-Cette page explique comment développer, créer des paquets et distribuer des modules de région complémentaires poour OpenSimulator. Elle est écrite pour les développeurs qui désirent apporter des fonctionnalités supplémentaires en plus de celles apportées dans la distribution de base d'OpenSim, et qui souhaitent partager ces modules sous forme binaire.Ces instructions concernent les [[New Region Modules|les modules de region]]qui s'exécutent sur des simulateurs. On suppose que vous êtes déjà familiarisé avec les bases du développement de modules de régions.
+Cette page explique comment développer, créer des paquets et distribuer des modules de région complémentaires poour OpenSimulator. Elle est écrite pour les développeurs qui désirent apporter des fonctionnalités supplémentaires en plus de celles apportées dans la distribution de base d'OpenSim, et qui souhaitent partager ces modules sous forme binaire.Ces instructions concernent les [[New Region Modules|les modules de region]] qui s'exécutent sur des simulateurs. On suppose que vous êtes déjà familiarisé avec les bases du développement de modules de régions.
 Si vous cherchez à utiliser et installer des modules complémentaires existants, veuillez vous référer [[Installing 3rd party addins|à cette autre page]].

@@ Line 104: / Line 104: @@
 ==Distribuer des modules complémentaires==
-Pour diffuser vos addins, vous devez créer votre propre référentiel et  l'héberger sur un serveur Web.
+Pour diffuser vos addins, vous devez créer votre propre dépôt et  l'héberger sur un serveur Web.
-Pour créer un référentiel, créez un dossier quelque part et placez-y tous vos packages  (.mpack). Ensuite :
+Pour créer un dépôt, créez un dossier quelque part et placez-y tous vos packages  (.mpack). Ensuite :
    $ ''/path/to/mautil.exe'' rep-build ''/path/to/repo/folder''
-Cela va créer un index additionnel de fichiers avec les droits d'entrée. Tout ce dont vous avez besoin de faire après est de télécharger tout le contenu des ce dossier sur un server Web. Par exemple : http://metaverseink.com/repo/ montre le fichier index.html de ce référentiel qui va afficher tous les addins disponibles.
+Cela va créer un index additionnel de fichiers avec les droits d'entrée. Tout ce dont vous avez besoin de faire après est de télécharger tout le contenu des ce dossier sur un server Web. Par exemple : http://metaverseink.com/repo/ montre le fichier index.html de ce dépôt qui va afficher tous les addins disponibles.
-Finalement, vous avez besoin de donner l'URL de votre référentiel aux utilisateurs, ainsi ils pourront l'ajouter à leur registre et installer les addins depuis votre référentiel. Vous pouvez ajouter votre référentiel [[List of 3rd Party Addin Repositories|ici]].
+Finalement, vous avez besoin de donner l'URL de votre dépôt aux utilisateurs, ainsi ils pourront l'ajouter à leur registre et installer les addins depuis votre dépôt. Vous pouvez ajouter votre dépôt [[List of 3rd Party Addin Repositories|ici]].

← Older revision		Revision as of 20:51, 11 February 2015
Line 110:		Line 110:
	Cela va créer un index additionnel de fichiers avec les droits d'entrée. Tout ce dont vous avez besoin de faire après est de télécharger tout le contenu des ce dossier sur un server Web. Par exemple : http://metaverseink.com/repo/ montre le fichier index.html de ce référentiel qui va afficher tous les addins disponibles.		Cela va créer un index additionnel de fichiers avec les droits d'entrée. Tout ce dont vous avez besoin de faire après est de télécharger tout le contenu des ce dossier sur un server Web. Par exemple : http://metaverseink.com/repo/ montre le fichier index.html de ce référentiel qui va afficher tous les addins disponibles.

−	Finalement, vous avez besoin de donner l'URL de votre référentiel aux utilisateurs, ainsi ils pourront l'ajouter à leur registre et ~~instakker~~ les addins depuis votre référentiel. Vous pouvez ajouter votre référentiel [[List of 3rd Party Addin Repositories\|ici]].	+	Finalement, vous avez besoin de donner l'URL de votre référentiel aux utilisateurs, ainsi ils pourront l'ajouter à leur registre et installer les addins depuis votre référentiel. Vous pouvez ajouter votre référentiel [[List of 3rd Party Addin Repositories\|ici]].

@@ Line 108: / Line 108: @@
 Pour créer un référentiel, créez un dossier quelque part et placez-y tous vos packages  (.mpack). Ensuite :
    $ ''/path/to/mautil.exe'' rep-build ''/path/to/repo/folder''
-Cela va créer un index additionnel de fichiers avec les droits d'entrée. Tout ce dont vous avez besoin de faire après est de tékécharger tout le contenu des ce dossier sur un server Web. Par exemple : http://metaverseink.com/repo/ montre index.html de ce référentiel qui va afficher tous les addins disponibles.
+Cela va créer un index additionnel de fichiers avec les droits d'entrée. Tout ce dont vous avez besoin de faire après est de télécharger tout le contenu des ce dossier sur un server Web. Par exemple : http://metaverseink.com/repo/ montre le fichier index.html de ce référentiel qui va afficher tous les addins disponibles.
 Finalement, vous avez besoin de donner l'URL de votre référentiel aux utilisateurs, ainsi ils pourront l'ajouter à leur registre et instakker les addins depuis votre référentiel. Vous pouvez ajouter votre référentiel [[List of 3rd Party Addin Repositories|ici]].

@@ Line 108: / Line 108: @@
 Pour créer un référentiel, créez un dossier quelque part et placez-y tous vos packages  (.mpack). Ensuite :
    $ ''/path/to/mautil.exe'' rep-build ''/path/to/repo/folder''
-Ceka va créer un index additionnel de fichiers avec les droits d'entrée. Tout ce dont vous avez besoin de faire après est de tékécharger tout le contenu des ce dossier sur un server Web. Par exemple : http://metaverseink.com/repo/ montre index.html de ce référentiel qui va afficher tous les addins disponibles.
+Cela va créer un index additionnel de fichiers avec les droits d'entrée. Tout ce dont vous avez besoin de faire après est de tékécharger tout le contenu des ce dossier sur un server Web. Par exemple : http://metaverseink.com/repo/ montre index.html de ce référentiel qui va afficher tous les addins disponibles.
 Finalement, vous avez besoin de donner l'URL de votre référentiel aux utilisateurs, ainsi ils pourront l'ajouter à leur registre et instakker les addins depuis votre référentiel. Vous pouvez ajouter votre référentiel [[List of 3rd Party Addin Repositories|ici]].

← Older revision		Revision as of 20:47, 11 February 2015
Line 104:		Line 104:

	==Distribuer des modules complémentaires==		==Distribuer des modules complémentaires==
		+	Pour diffuser vos addins, vous devez créer votre propre référentiel et l'héberger sur un serveur Web.
		+
		+	Pour créer un référentiel, créez un dossier quelque part et placez-y tous vos packages (.mpack). Ensuite :
		+	$ ''/path/to/mautil.exe'' rep-build ''/path/to/repo/folder''
		+	Ceka va créer un index additionnel de fichiers avec les droits d'entrée. Tout ce dont vous avez besoin de faire après est de tékécharger tout le contenu des ce dossier sur un server Web. Par exemple : http://metaverseink.com/repo/ montre index.html de ce référentiel qui va afficher tous les addins disponibles.
		+
		+	Finalement, vous avez besoin de donner l'URL de votre référentiel aux utilisateurs, ainsi ils pourront l'ajouter à leur registre et instakker les addins depuis votre référentiel. Vous pouvez ajouter votre référentiel [[List of 3rd Party Addin Repositories\|ici]].

@@ Line 95: / Line 95: @@
 Selon ces directives, tous les fichiers nécessaires se retrouvent dans un dossier bin deux niveaux au-dessus.
-Pour empaqueer les fichiers, nous utilisons  [https://monoaddins.codeplex.com/wikipage?title=Creating%20and%20Managing%20Add-in%20Packages mautil] outil de ligne de commande qui se trouve dans le dossier bin d'OpenSim.
+Pour empaqueter les fichiers, nous utilisons  [https://monoaddins.codeplex.com/wikipage?title=Creating%20and%20Managing%20Add-in%20Packages mautil] outil de ligne de commande qui se trouve dans le dossier bin d'OpenSim.
    $ ''/path/to/mautil.exe'' pack bin/Diva.AddinExample.dll
-This creates a file called '''Diva.AddinExample_''osversion''.1.mpack'''. This is the addin package that will be distributed and installed at the user's sites.
+Cela crée un fichier appelé '''Diva.AddinExample_''osversion''.1.mpack'''. C'est le package de l'addin qui sera distribué et installé dans les sites utilisateur.
-Note that .mpack files are compressed (zip) archives. You can open them and verify their contents using tools for inspecting zip files.
+Notez que les fichiers .mpack files sont des archives compressées (zip). Vous pouvez les ouvrir et vérifuer leur contenu avec des outils pour inspecter les fichiers zip.
 ==Distribuer des modules complémentaires==

← Older revision		Revision as of 20:33, 11 February 2015
Line 82:		Line 82:

	Cette méthode utiliser '''OpenSim.Framework.Util.MergeConfigurationFile''', qui va lire la varibale ConfigDirectory dans la configuration OpenSim et contrôler si la configuration du module est déjà là. Si c'est le cas, alors elle est simplement fusionnée avec les configurations d'OpenSim. Sinon, le fichier de configuration associé au package est copié vers un fichier de configuration non fusionné et averti les opérateurs qu'ils devront l'éditer selon leur besoins.		Cette méthode utiliser '''OpenSim.Framework.Util.MergeConfigurationFile''', qui va lire la varibale ConfigDirectory dans la configuration OpenSim et contrôler si la configuration du module est déjà là. Si c'est le cas, alors elle est simplement fusionnée avec les configurations d'OpenSim. Sinon, le fichier de configuration associé au package est copié vers un fichier de configuration non fusionné et averti les opérateurs qu'ils devront l'éditer selon leur besoins.
		+
		+	== Empaqueter l'Addin ==
		+
		+	Compilez votre code comme d'habitude, et assurez-vous que tous les fichiers qui doivent être inclus sont tous dans le même répertoire. Dans notre exemple, cela est effectué par les directives qui sont dans [https://github.com/diva/diva-distribution/blob/master/addon-modules/02AddinExample/prebuild.xml prebuild.xml]:
		+	<Files>
		+	<Match pattern="*.cs" recurse="true"/>
		+	<Match pattern="*.ini" buildAction="Copy" destination="../../bin/" />
		+	<Match pattern="*.html" buildAction="Copy" destination="../../bin/" />
		+	<Match pattern="*.dll" recurse="true" buildAction="Copy" destination="../../bin/" />
		+	</Files>
		+
		+	Selon ces directives, tous les fichiers nécessaires se retrouvent dans un dossier bin deux niveaux au-dessus.
		+
		+	Pour empaqueer les fichiers, nous utilisons [https://monoaddins.codeplex.com/wikipage?title=Creating%20and%20Managing%20Add-in%20Packages mautil] outil de ligne de commande qui se trouve dans le dossier bin d'OpenSim.
		+
		+	$ ''/path/to/mautil.exe'' pack bin/Diva.AddinExample.dll
		+
		+	This creates a file called '''Diva.AddinExample_''osversion''.1.mpack'''. This is the addin package that will be distributed and installed at the user's sites.
		+
		+	Note that .mpack files are compressed (zip) archives. You can open them and verify their contents using tools for inspecting zip files.

	==Distribuer des modules complémentaires==		==Distribuer des modules complémentaires==

← Older revision		Revision as of 20:25, 11 February 2015
Line 42:		Line 42:

	== Configuration ==		== Configuration ==
		+	Une part importante du processus se passe au travers de la configuration de votre addin. Plutôt que de forcer les utilisateurs à éditer manuellement leurs fichiers OpenSim.ini et d'ajouter une section de configuration pour votre addin, nous vous encourageons à utiliser des configurations modulaires. Dans des configurations modulaires, vos composants vont lire eux-mêmes leurs propres fichiers de configuration.
		+
		+	Jetez un oeil sur la méthode utilisée dans le module AddinExample : https://github.com/diva/diva-distribution/blob/master/addon-modules/02AddinExample/AddinExampleModule.cs
		+
		+	Dans la méthode d'initialisation, avant le coeur de cette méthode, nous appelons LoadConfiguration(...), mais seulement si la configuration principale ne comporte pas de section pertinente:
		+
		+	public void Initialise(IConfigSource config)
		+	{
		+	//Nous chargeon le fichier de configuration uniquemeny si la config principale ne sait rien à propos de ce module
		+	IConfig cnf = config.Configs["AddinExample"];
		+	if (cnf == null)
		+	{
		+	LoadConfiguration(config);
		+	cnf = config.Configs["AddinExample"];
		+	if (cnf == null)
		+	{
		+	m_log.WarnFormat("[Diva.AddinExample]: La section de configurationConfiguration pour AddinExample n'a pas été trouvée. Impossible de continuer");
		+	return;
		+	}
		+	}
		+
		+	LoadConfiguration est déclaré plus bas, la voici:
		+
		+	private void LoadConfiguration(IConfigSource config)
		+	{
		+	string configPath = string.Empty;
		+	bool created;
		+	if (!Util.MergeConfigurationFile(config, "AddinExample.ini", Path.Combine(AssemblyDirectory, "AddinExample.ini"), out configPath, out created))
		+	{
		+	m_log.WarnFormat("[Diva.AddinExample]: Fichier de configuration non fusionné");
		+	return;
		+	}
		+	if (created)
		+	{
		+	m_log.ErrorFormat("[Diva.AddinExample]: PLEASE EDIT {0} BEFORE RUNNING THIS ADDIN", configPath);
		+	throw new Exception("Addin must be configured prior to running");
		+	}
		+	}
		+
		+	Cette méthode utiliser '''OpenSim.Framework.Util.MergeConfigurationFile''', qui va lire la varibale ConfigDirectory dans la configuration OpenSim et contrôler si la configuration du module est déjà là. Si c'est le cas, alors elle est simplement fusionnée avec les configurations d'OpenSim. Sinon, le fichier de configuration associé au package est copié vers un fichier de configuration non fusionné et averti les opérateurs qu'ils devront l'éditer selon leur besoins.
		+
	==Distribuer des modules complémentaires==		==Distribuer des modules complémentaires==

@@ Line 33: / Line 33: @@
   [assembly: '''ImportAddinFile'''("AddinExample.html")]
-La première directive [assembly: '''Addin'''("Diva.AddinExample", OpenSim.VersionInfo.VersionNumber + ".1")] établit le nom public de votre addin: c'est ce que les utilisateurs verront.Portez une attention spéciale au numéro de version. Même si vous pouvez utiliser tout numéro de version que vous souhaitez, il est fortement conseillé d'attacher le numéro de version de votre addin à celui de la version OpenSim que vous avez utilisé pour compiler votre code.  La raison à cela est simple : .NET est très sensible à la compatibilité binaire, c'est pourquoi vous devez informer les utilisateurs à propos de la version d'OpenSim  compatible avec votre addin. La façon la plus directe de passer cette information est de l'indiquer dans le numéro de version de votre addin. Ainsi, nous utilisons les premiers chiffres pour indiquer le numéro de version d'OpenSim et le dernier chiffre pour désigner la version de l'addin. Si l'addin devait évoluer tout en utilisant la même version d'OpenSim, ce dernier chiffre passerait à 2, tandis que lespremiers chiffres resteraient les mêmes.
+La première directive [assembly: '''Addin'''("Diva.AddinExample", OpenSim.VersionInfo.VersionNumber + ".1")] établit le nom public de votre addin: c'est ce que les utilisateurs verront. Prêtez une attention particulière au numéro de version du module. Même si vous pouvez utiliser n'importe quel numéro de version, il est fortement conseillé d'attacher le numéro de version de votre addin à celui de la version OpenSim que vous avez utilisée pour compiler votre code.  La raison à cela est simple : .NET est très sensible à la compatibilité binaire, c'est pourquoi vous devez informer les utilisateurs à propos de la version d'OpenSim  compatible avec votre addin. La façon la plus directe de passer cette information est de l'indiquer dans le numéro de version de votre addin. Ainsi, nous utilisons les premiers chiffres pour indiquer le numéro de version d'OpenSim et le dernier chiffre pour désigner la version de l'addin. Si l'addin devait évoluer tout en utilisant la même version d'OpenSim, ce dernier chiffre passerait à 2, tandis que lespremiers chiffres resteraient les mêmes.
 La deuxième directive [assembly: '''AddinDependency'''("OpenSim.Region.Framework", OpenSim.VersionInfo.VersionNumber)] établit la dépendance avec la dll OpenSim que  cet addin va compléter. Tous les modules de région complémentaires prolongent OpenSim.Region.Framework. Aussi, le numéro de version devrait être le numéro de version d'OpenSim utilisé car c'est la dll avec laquelle vous avez compiler votre code. Pour plus d'information sur le fonctionnement du versionig référez-vous à la page [[Installing_3rd_party_addins#Versioning]]