Script

Qu'est-ce qu'un "script" Celestia ?

Un script Celestia est un fichier texte (enregistré au format .cel ou .celx) comportant une série de commandes qui permettent d'exécuter et surtout d'enchaîner automatiquement la plupart des fonctions habituellement accessibles à travers les différents menus. Les scripts offrent donc la possibilité d'enchaîner, sans intervention de l'utilisateur, des déplacements, des mouvements de caméra, des changements de textures de planètes, bref de réaliser l'équivalent d'une véritable séquence vidéo dans Celestia. Ils permettent aussi d'afficher des commentaires textuels au cours de ces séquences.
En d'autres termes, il est donc possible de "programmer" Celestia pour visualiser de nombreux objets célestes (sous toutes les coutures), tout en affichant simultanément des commentaires, ce qui fait de Celestia un outil pédagogique de premier ordre. A ce titre, un "script" Celestia peut être considéré comme un véritable "scénario".

Comment lancer ou interrompre un script dans Celestia ?

• Les scripts sont accessibles à partir du Menu "File" ("Fichier") > "Open script" ("Ouvrir script")
• Lors de l'installation de Celestia, les fichiers .cel et .celx ont été associés à ce logiciel (sauf consigne contraire de l'utilisateur). Ainsi, il est possible de lancer un script à partir d'un gestionnaire de fichiers par un simple double-clic. Dans ce cas, Celestia se lancera automatiquement, puis chargera et lancera ledit script tout aussi automatiquement.
• Pour interrompre un script, il suffit d'une simple pression sur la touche <Echap> (ou <Esc>).

Quelle est la différence entre les fichiers .cel et .celx ?

Ces 2 types de scripts n'utilisent pas le même langage de programmation.

• Les fichiers .cel utilisent un langage propre à Celestia. Ils enchaînent de manière linéaire une série de commandes et ne permettent pas à l'utilisateur d'influer sur leur déroulement, si ce n'est de l'interrompre en cours d'exécution.
  

• Les fichiers .celx utilisent une partie des fonctions du langage Lua. Plus complexes, ils autorisent - en plus des commandes propres à Celestia - des variables, un traitement mathématique et logique des valeurs, des tests, des boucles et offrent une forme d'interactivité avec l'utilisateur. Par exemple, il est possible de demander le nom d'une planète pour pouvoir s'y rendre, de proposer des menus pour pouvoir passer directement à la 2ème partie d'un script, ou de demander la distance à laquelle on veut s'approcher d'un objet, etc. Une description (en anglais) des fonctions Lua disponibles sous Celestia a été rédigée par Harald Schmidt et est consultable ici : http://celestia.h-schmidt.net/.

Comment modifier un script ?

Un script peut être écrit ou modifié comme tout autre fichier texte, en utilisant votre éditeur de texte préféré (Notepad, ...). Il vous suffit ensuite de l'enregistrer au format .cel ou celx (exemple : MonScript.cel). Voir aussi l'article traitant des fichiers en format "texte".

Note: A l'origine, Celestia est un logiciel anglophone, et ignore donc les spécificités des langues latines comme les accents.
Si vous souhaitez donc pouvoir afficher les caractères accentués dans Celestia, assurez-vous d'utiliser un Editeur de texte qui supporte les caractères Unicode et le codage en UTF-8, sans quoi Celestia fera disparaître le caractère accentué ainsi que le caractère qui suit.

Le logiciel Wordpad, fourni avec Microsoft Windows, est capable de changer d'encodage et permet théoriquement d'enregistrer les scripts en format texte "unicode". Néanmoins ce logiciel est à éviter puisque les scripts enregistrés ainsi ont généré des bugs.

Les deux éditeurs de texte à privilégier pour l'écriture de scripts sont :

• Notepad2, un petit utilitaire qui reproduit le Notepad de Windows, mais amélioré (coloration syntaxique, indentation, encodages).
  
• PSPad. Il s'agit également d'un éditeur de texte amélioré mais qui supporte en plus les macros-commandes et qui, grâce à l'optimisation de Bluz, vous permettra de mettre sous forme de Macro les commandes de Celestia, de sorte à ne pas avoir à les retaper constamment. Installation : décompresser l'archive puis lancer le fichier setup. Ensuite, placer le dossier "macro" dans votre dossier personnel : "utilisateur\Application Data\Pspad". Enfin, lancez l'application et faites CTRL+MAJ+F5 pour faire apparaître la liste des fonctions. (Pour toute question concernant l'utilisation de PSPad pour Celestia, voir ici.) (Le lien indiqué n'est pas disponible pour le moment ; pour télécharger PSPad, rendez-vous, par exemple, sur le site de Clubic.)

Quelles sont les principales commandes .cel ?

Deux précisions au préalable

1. Certaines commandes figurant ci-dessous ne sont disponibles qu'à partir d'une version précise de Celestia. Dans ce cas, le numéro de la version est indiqué entre crochets. Par exemple, si vous lisez : constelations [v1.5.1], sachez que vous devez avoir installé la version 1.5.1 de Celestia pour utiliser la fonction constelations dans vos scripts.

2. Les commandes listées ci-dessous sont suivies d'un court descriptif, mais en cliquant sur leur nom, il est possible d'obtenir des informations plus détaillées (notamment en ce qui concerne leur syntaxe) et/ou des exemples d'utilisation. Néanmoins, cette liste étant en cours d'élaboration, toutes les commandes ne sont pas présentes. Par ailleurs, les commandes listées ne disposent pas toutes d'une fiche détaillée (elles apparaissent en rouge). Au passage, si vous souhaitez apporter votre contribution, n'hésitez pas !

La liste des commandes

• cancel
  

Annuler les commandes goto et track, et réinitialiser le Système de Coordonnées sur universal.

• center
  

Centrer l'objet sélectionné sur l'écran.

• changedistance
  

Changer la distance entre la caméra et l'objet sélectionné.

• chase
  

Régler le Système de Coordonnées sur chase.

• constelations [v1.5.1]
  

Activer ou désactiver l'affichage d'une ou plusieurs constellations.

• constellationcolor [v1.5.1]
  

Modifier la couleur d'une ou plusieurs constellations.

• deleteview [v1.6]
  

Supprimer une vue en mode multi-vues.

• exit
  

Quitter Celestia.

• follow
  

Suivre l'objet sélectionné - Régler le Système de Coordonnées sur ecliptical.

• goto
  

Déplacer la caméra et la positionner face à l'objet sélectionné sans changer le Système de Coordonnées.

• gotoloc
  

Déplacer la caméra et la positionner aux valeurs spécifiées de position et d'orientation de l'objet sélectionné sans changer le Système de Coordonnées.

• gotolonglat
  

Déplacer la caméra et la positionner aux valeurs spécifiées de longitude et de latitude de l'objet sélectionné.

• labels
  

Activer ou désactiver l'affichage des noms pour les différentes classes d'objets.

• lock
  

Verrouiller 2 objets par rapport à la position de la caméra - Régler le Système de Coordonnées sur lock.

• lookback
  

Changer instantanément (sans mouvement de caméra) le champ de la caméra de 180°.

• mark
  

Activer le marquage d'un objet avec le symbole spécifié.

• move
  

Déplacer la caméra à la vitesse spécifiée.

• orbit
  

Se déplacer en orbite autour de l'objet sélectionné sans changer le Système de Coordonnées.

• orbitflags
  

Activer / désactiver l'affichage des orbites pour les différentes classes d'objets.

• play (commande disponible uniquement avec la version celestia_1.4.1_patch)
  

Jouer un fichier son.

• preloadtex
  

Pré-charger en mémoire une texture avant son affichage à l'écran.

• print
  

Afficher un message à l'écran sous forme de texte.

• renderflags
  

Activer / désactiver l'affichage des différentes classes d'objets.

• renderpath
  

Changer/choisir le chemin de rendu (basic, multitexture, vp, vp-nv, glsl).

• rotate
  

Effectuer une rotation du champ de la caméra.

• select
  

Selectionner un objet (planète, satellite, galaxie, etc...).

• set
  

Régler les valeurs de Min Orbit Size, Ambient Light Level, Field Of View, Star Distance Limit, Star Style.

• setambientlight
  

Régler le niveau de lumière ambiante.

• setactiveview [v1.6]
  

Activer une vue en mode multi-vues.

• setfaintestautomag45deg
  

Régler la magnitude automatique à 45°.

• setframe
  

Choisir le Système de Coordonnées à utiliser.

• setgalaxylightgain [v1.6]
  

Régler le gain de luminosité des galaxies.

• setlabelcolor [v1.6]
  

Régler les couleurs de la palette des noms d'objets.

• setlinecolor [v1.6]
  

Régler les couleurs de la palette des lignes.

• setorientation
  

Régler l'orientation de la caméra.

• setposition
  

Régler la position de la caméra dans l'espace.

• setradius [v1.6]
  

Régler le rayon d'un objet ssc.

• setsurface
  

Choisir une texture alternative pour l'objet sélectionné.

• setvisibilitylimit
  

Régler la magnitude minimale des étoiles à afficher lorsque l'option Auto-Magnitude est désactivée.

• seturl
  

Placer la caméra à la position définie par une fonction Cell://URL.

• singleview [v1.6]
  

Revenir en mode vue unique.

• splitview [v1.6]
  

Scinder une vue (-> mode multi-vues).

• synchronous
  

Se placer en orbite autour de l'objet sélectionné en mode Synch Orbit - Régler le Système de Coordonnées sur geographic.

• time
  

Régler la date et l'heure en utilisant les formats JulianDay ou UTC.

• timerate
  

Régler la vitesse d'écoulement du temps.

• track
  

Fixer la caméra sur l'objet sélectionné pour le garder centré sur l'écran.

• unmark
  

Désactiver le marquage d'un objet.

• unmarkall
  

Désactiver le marquage de tous les objets.

• wait
  

Insérer une pause dans l'exécution du script (du nombre de secondes spécifiées).

Quelques exemples de scripts décortiqués

Après la théorie, la pratique... Les quelques scripts qui suivent exposent des exemples concrets qui permettront de se faire une idée plus précise du sujet. Si vous êtes vous-même auteur d'un script pour Celestia, n'hésitez pas à en faire profiter les lecteurs de ce wiki.

• Spoutnik 1. Commandes utilisées : time, select, goto.
• Start. Commandes utilisées : preloadtext, select, follow, goto, wait, print.

Aide à la création de scripts

La création d'un script peut parfois se révéler fastidieuse. Heureusement, K.holo nous a concocté Promenade, un petit logiciel destiné à rendre le scripting plus accessible.

A télécharger sur son site : http://perso.orange.fr/surok/promenade/html/promenade.htm
Si vous avez des remarques, des commentaires au sujet de ce soft, postez-les ici : http://www.jcvignoli.com/celestia/forum/viewtopic.php?t=45.
A noter qu'un bug empêchait certains d'utiliser Promenade. Bug résolu, qui était dû à deux .dll manquantes : msvbvm60.dll et VB6FR.DLL (à copier dans le dossier d'installation de Promenade et non dans "c:\Windows\System" !). Voir le forum cité ci-dessus. (Un grand merci à K.holo qui n'a pas lâché le morceau, sans oublier Bluz qui a mis la main à la pâte.)