Project

Profile

Help

Alias » History » Sprint/Milestone 2

Vincent Le Goff, 10/10/2016 04:16 AM

1 1 Vincent Le Goff
h1. Les alias dans CocoMUD
2 1 Vincent Le Goff
3 1 Vincent Le Goff
Les alias sont une fonctionnalité des clients MUD afin d'abréger une ou plusieurs commandes. Un alias est en vérité une commande, mais au lieu d'être envoyée au serveur, elle est d'abord analysée par le client, qui peut la modifier et la transmettre au serveur si besoin. Il est même possible de créer des alias qui n'ont de sens que pour le client et ne sont pas envoyés au serveur du tout.
4 1 Vincent Le Goff
5 1 Vincent Le Goff
Ce document décrit le concept d'alias et explique la façon de les créer et les gérer dans CocoMUD.
6 1 Vincent Le Goff
7 1 Vincent Le Goff
{{toc}}
8 1 Vincent Le Goff
9 1 Vincent Le Goff
h2. Ajouter un alias
10 1 Vincent Le Goff
11 1 Vincent Le Goff
Vous pouvez créer un alias via l'interface ou en utilisant la [[#Syntaxe-du-SharpScript|syntaxe du SharpScript]].  L'interface étant plus intuitive, elle sera décrite en premier.
12 1 Vincent Le Goff
13 1 Vincent Le Goff
h3. Création grâce à l'interface
14 1 Vincent Le Goff
15 2 Vincent Le Goff
Dans la barre de menu, sélectionnez Jeu -> Alias.  Vous vous trouverez dans une boîte de dialogue listant les alias existants pour cet univers. Notez que les alias sont généralement propres à un univers et partagés par les personnages de cet univers, ce qui changera dans les prochaines versions.
16 1 Vincent Le Goff
17 1 Vincent Le Goff
Dans cette boîte de dialogue, vous pouvez ajouter, éditer et supprimer des alias. Par défaut, la liste des alias de cet univers sera probablement vide, vous pouvez cliquer sur *Ajouter* pour en ajouter un.
18 1 Vincent Le Goff
19 1 Vincent Le Goff
Vous devrez ensuite choisir le nom de l'alias que vous voulez créer. C'est le nom de la commande que vous devrez entrer pour exécuter l'alias. Dans cet exemple, nous allons créer un alias "tts" qui permet d'activer ou de désactiver le TTS (text-to-speech).
20 1 Vincent Le Goff
21 1 Vincent Le Goff
Entrez donc "tts" dans ce champ de texte, puis appuyez sur la tabulation. Vous vous trouvez ensuite dans une liste d'actions possibles à lier à cet alias. Par exemple, vous pourriez vouloir créer un alias "rs" qui envoie deux commandes au serveur quand exécuté : "reload" et "shoot". Dans ce cas, vous devrez sélectionner l'action "Envoie une ou plusieurs commandes au serveur".
22 1 Vincent Le Goff
23 2 Vincent Le Goff
Poursuivant notre exemple, nous devrons choisir "Active/Désactive le TTS", puisque c'est ce que devrait faire notre alias "tts" quand exécuté. Sélectionnez donc ce choix et faites tabulation pour cliquer sur le bouton *Ajouter l'action*.
24 1 Vincent Le Goff
25 2 Vincent Le Goff
Vous vous trouverez dans une nouvelle boîte de dialogue vous demandant des informations supplémentaires. Dans le cas de cette action, il n'y en a aucune, appuyez donc sur "OK" pour ajouter l'action.
26 1 Vincent Le Goff
27 1 Vincent Le Goff
La nouvelle action a bien été ajoutée. Le curseur se trouvera sur la liste des actions actuellement liées à cet alias. Vous pouvez lier un alias à plusieurs actions, si besoin lier un alias à la même action plusieurs fois (pour par exemple jouer différents sons en même temps, même si cela n'est peut-être pas bien utile).
28 1 Vincent Le Goff
29 1 Vincent Le Goff
Pour résumer le contenu de cette boîte de dialogue quand vous ajoutez ou éditez un alias, vous avez:
30 1 Vincent Le Goff
31 1 Vincent Le Goff
* Le nom de l'alias.
32 1 Vincent Le Goff
* Une liste d'actions que vous pouvez relier à cet alias.
33 1 Vincent Le Goff
* Le bouton pour ajouter une de ces actions.
34 1 Vincent Le Goff
* La liste des actions liées à cet alias.
35 1 Vincent Le Goff
* Un bouton pour éditer la ligne d'action sélectionnée.
36 1 Vincent Le Goff
* Un bouton pour supprimer la liste d'action sélectionnée.
37 1 Vincent Le Goff
38 1 Vincent Le Goff
Vous devriez vous habituer autant que possible à cette boîte de dialogue, car elle sera présente pour la plupart des fonctionnalités incluant du SharpScript dans CocoMUD. Il s'agit en fait de l'éditeur de SharpScript, qui vous permet d'éditer la configuration avancée du client sans ouvrir le fichier de configuration. Vous verrez bien d'autres exemples dans le reste de la documentation.
39 1 Vincent Le Goff
40 1 Vincent Le Goff
Pour enregistrer cet alias, n'oubliez pas de sélectionner "OK" plusieurs fois pour bien refermer toutes les boîtes de dialogues ouvertes.
41 1 Vincent Le Goff
42 1 Vincent Le Goff
Si dans le client, vous entrez "tts", vous devriez voir :
43 1 Vincent Le Goff
44 1 Vincent Le Goff
<pre>
45 1 Vincent Le Goff
TTS off.
46 1 Vincent Le Goff
</pre>
47 1 Vincent Le Goff
48 2 Vincent Le Goff
Entrez cette commande de nouveau pour l'activer. Le TTS (text-to-speech) sera donc activé ou désactivé en entrant cet alias.
49 1 Vincent Le Goff
50 1 Vincent Le Goff
h3. Syntaxe du SharpScript
51 1 Vincent Le Goff
52 1 Vincent Le Goff
Vous pouvez aussi ajouter un alias en éditant un fichier de configuration. Cette solution sera peut-être préférée par certains.
53 1 Vincent Le Goff
54 1 Vincent Le Goff
Le fichier de configuration lié à cet univers se trouve dans le dossier "worlds", sous-dossier portant le nom de votre univers, fichier "config.set". Vous pouvez ouvrir ce fichier avec un éditeur simple, comme bloc-notes.
55 1 Vincent Le Goff
56 1 Vincent Le Goff
Pour ajouter un alias, utilisez l'action @#alias@ avec deux paramètres :
57 1 Vincent Le Goff
58 1 Vincent Le Goff
* Le nom de l'alias.
59 1 Vincent Le Goff
* Les actions liées à cet alias.
60 1 Vincent Le Goff
61 1 Vincent Le Goff
Si vous voulez créer un alias "tts" qui active ou désactive le TTS (text-to-speech), écrivez dans votre fichier de configuration :
62 1 Vincent Le Goff
63 1 Vincent Le Goff
<pre>
64 1 Vincent Le Goff
#alias tts #tts
65 1 Vincent Le Goff
</pre>
66 1 Vincent Le Goff
67 1 Vincent Le Goff
Si vous voulez lier votre alias à plusieurs actions, n'hésitez pas à l'écrire sur plusieurs lignes :
68 1 Vincent Le Goff
69 1 Vincent Le Goff
<pre>
70 1 Vincent Le Goff
#alias go {
71 1 Vincent Le Goff
    #play sounds/go.wav
72 1 Vincent Le Goff
    #say {C'est parti !}
73 1 Vincent Le Goff
}
74 1 Vincent Le Goff
</pre>
75 1 Vincent Le Goff
76 1 Vincent Le Goff
Pour une explication plus détaillée de la syntaxe du SharpScript, référez-vous à [[SharpScript|la section consacrée au SharpScript]].
77 1 Vincent Le Goff
78 1 Vincent Le Goff
h2. Editer un alias
79 1 Vincent Le Goff
80 1 Vincent Le Goff
A tout moment, que vous ayez créé l'alias depuis l'interface ou depuis le fichier de configuration, vous pouvez l'éditer. Si vous l'avez créé via le fichier de configuration, vous pouvez l'éditer via l'interface, et réciproquement.
81 1 Vincent Le Goff
82 2 Vincent Le Goff
Souvenez-vous : la configuration est chargée quand l'univers est sélectionnée, vraisemblablement à l'ouverture du programme. Si vous modifiez le fichier de configuration, redémarrez le programme pour voir ces modifications.
83 1 Vincent Le Goff
84 1 Vincent Le Goff
h2. Supprimer un alias
85 1 Vincent Le Goff
86 2 Vincent Le Goff
Vous pouvez retirer un alias depuis l'interface ou le fichier de configuration. Souvenez-vous de bien quitter l'interface en cliquant sur "OK" même après avoir supprimé un alias, sans quoi la modification ne sera pas sauvegardée.