Applications

Ce chapitre décrit les différentes applications contenues dans Crystal Entity Layer. Ces applications peuvent aussi bien servir d'applications test pour essayer les fonctionnalités de Crystal Entity Layer, que comme exemples d'utilisation du programme, ou parfois les deux.

Vue générale

Les applications actuellement empaquetées avec CEL sont :

celstart 

CELstart est une application simple pouvant être utilisée pour lancer un jeu CEL. Comme un paramètre, il prévoit un simple fichier de configuration qui décrit entièrement comment le jeu doit démarrer et quels paramètres doivent être retenus. Il peut être lancé comme une application fonctionnant intégralement à partir de scripts sans aucun besoin de programmation C++.

celtest 

C'est une application test conçue pour expérimenter les divers modules CEL et donner une démonstration basique de ce que fait une classe de propriété.

bootstrap 

Bootstrap est une ancienne application qui était capable de lancer une map intégralement construite en XML et en script. Mais elle moins polyvalente que CELstart et est maintenant non maintenue.

celtest

TODO: Document celtest

nootstrap

TODO: Document bootstrap

celstart

CELstart est une application simple conçue pour lancer un jeu utilisant CEL. Si vous utilisez cette application alors vous pouvez écrire un jeu en vous servant de scripts XML ou Python, sans avoir à rédiger une seule ligne de C++.

CELstart a un unique argument qui peut être de la forme d'un(e):

• Archive zip :

dans ce cas l'archive zip doit contenir un fichier de configuration appelé celstart.cfg

• Répertoire de système de fichier réel :

dans ce cas le répertoire doit également contenir un fichier de configuration appelé celstart.cfg

• Répertoire VFS :

Même chose que pour le précédent, doit contenir un fichier celstart.cfg

• Chemin réel vers un fichier de configuration :

dans ce cas le fichier de configuration pourra avoir un autre nom.

• Chemin VFS vers un fichier de configuration :

dans ce cas aussi le fichier de configuration pourra avoir un autre nom.

Après avoir démarré, CELstart essayera tout d'abord d'ouvrir le fichier de configuration, et alors transmettra cette configuration à Crystal Space. De façon claire, le fichier de configuration est traité comme un fichier de configuration Crystal Space, et celui-ci pourra contenir des informations concernant les plugins à charger, la résolution désirée, et plusieurs autres options. De plus, CELstart comprendra les options de configuration supplémentaires suivantes :

• CelStart.MapFile.<somename> = <filename> :

avec cette option vous pouvez laisser CELstart charger le fichier map donné. Il est possible d'en avoir plusieurs dans le même fichier de configuration, auquel cas CELstart tentera de tous les charger.

• CelStart.Entity.<somename> = <name>> :

c'est le moyen de laisser CELstart créer une entité depuis le début. Si cette option est présente, alors CELstart essayera également de trouver CelStart.EntityBehaviour.<name> et CelStart.EntityBehaviourLayer.<name>. Avec ces deux fichiers vous pouvez spécifier le nom du comportement (et optionnellement le nom de la Couche Comportement, sans quoi le nom par défaut sera choisi).

• CelStart.BehaviourLayer.<bhname> = <classid> :

c'est la façon de charger des Couches Comportement supplémentaires. Notez que par défaut les scripts XML chargent automatiquement leur Couche Comportement. Il n'y a donc pas besoin de l'ajouter si vous utilisez uniquement des comportements XML.

• CelStart.ClearScreen = true :

si vous avez un jeu XML en 2D seulement, alors il peut être nécessaire de forcer CELstart à rafraichir l'écran à chaque frame, étant donné qu'il n'y aura aucune caméra 3D pour le faire.

• CelStart.ConfigDir.<somename> = <dirname> :

avec cette option vous pouvez laisser CELstart charger les fichiers système depuis un répertoire VFS spécifique (spécifique en fonction du chemin vers le celstart.cfg). Il est possible d'en avoir plusieurs dans la même configuration, auquel cas CELstart les chargera tous.

Voici un exemple de ce à quoi peut ressembler un fichier de configuration :

; We always need a dummy name after CelStart.MapFile. Even if we have only one map file.
CelStart.MapFile.a = data/maingame.xml
CelStart.MapFile.b = data/screenmanager.xml
; Use 'iCelBlLayer' for the default behaviour layer. Use another name for the others.
CelStart.BehaviourLayer.iCelBlLayer = cel.behaviourlayer.python
CelStart.BehaviourLayer.blxml = cel.behaviourlayer.xml
; Create one entity.
CelStart.Entity.start = start
CelStart.EntityBehaviourLayer.start = blxml
CelStart.EntityBehaviour.start = start_behaviour
; Load config files from the 'config' dir (under map vfs).
CelStart.ConfigDir.Behaviours = config
; Some CS stuff.
Video.ScreenWidth = 1024
Video.ScreenHeight = 768
System.Plugins.iGraphics3D = crystalspace.graphics3d.opengl
System.Plugins.iEngine = crystalspace.engine.3d
...