Dépôt subversion

De WikiPlee.

Un dépôt subversion est fourni par SourceForge.net et nous permet de garder un historique des changements faits dans le jeu. Ce dépôt contient tout ce qui a été produit pour le jeu : le code, les dessins, les sons ; mais aussi des éléments annexes comme le site Internet. Il peut être vu à cette adresse.

Les dépôt est scindé en trois parties nommées branch, tag et trunk. Ce dernier dossier contient le projet en cours de modification. Cela signifie qu'il peut ne pas fonctionner, même si nous essayons de le garder dans un état relativement stable (c'est à dire que ça compile et ça s'exécute). Le dossier tag contient le projet dans l'état qu'il était lors des publications effectuées depuis le début du projet. Enfin, le dossier branch contient des versions du projet sur lesquelles sont effectuées de grosses modifications. Il n'est pas rare qu'une versions prise dans ce dossier ne compile pas ou contienne d'énormes bugs.

Cette page décrit la procédure à suivre pour récupérer le jeu depuis le dépôt, le compiler et le lancer.

Sommaire

Prérequis

Le premier logiciel nécessaire est évidemment subversion, pour pouvoir récupérer le jeu depuis le dépôt. Pour pouvoir ensuite le compiler, vous aurez besoin des bibliothèques listées ci-dessous.

Pour toutes les bibliothèques, il faut installer les versions de développement, avec les fichiers d'entête. Sous Debian et dérivées, les paquets suivants sont de bons candidats : 

libsdl-mixer1.2-dev libboost-filesystem-dev libboost-thread-dev mesa-common-dev libwxgtk2.8-dev libgl1-mesa-dev

Vous aurez aussi besoin d'un compilateur C++, de CMake et d'une carte graphique avec accélération 3D.

Récupération du matériel

Le dossier à récupérer depuis le dépôt est /trunk/game. Il contient le jeu, le moteur du jeu et les éditeurs de niveaux et de modèles. Pour l'obtenir, il suffit de taper la commande suivante dans un terminal 

svn co https://plee-the-bear.svn.sourceforge.net/svnroot/plee-the-bear/trunk/game

Inutile de regarder les noms de fichier défiler, il y en a pour au moins 300 Mio. Une fois cette commande terminée, il ne sera plus nécessaire de l'exécuter à nouveau. Pour mettre à jour les fichiers avec la version du dépôt, il suffira de taper, dans le dossier téléchargé, la commande suivante 

svn update

Le dossier téléchargé contient trois sous-dossiers nommés bear-engine, bear-factory et plee-the-bear. Le premier contient le code pour le moteur du jeu et est en partie organisé comme suit :

  • ./bear-engine
    • ./common : des fichiers partagés avec l'éditeur de niveaux ;
    • ./core : source et documentation du moteur ;
    • ./lib : bibliothèque d'objets génériques (c'est à dire non liés à Plee the Bear) ;
    • ./running-bear : le programme à lancer pour exécuter un jeu fait pour le moteur (voir la ligne de commande).

Le dossier bear-factory contient les éditeurs. Il est en partie organisé comme suit :

  • ./bear-factory
    • ./animation-editor : l'éditeur d'animations ;
    • ./bear-editor : une bibliothèque partagée par les différents éditeurs ;
    • ./item-description : les fichiers de description d'objet, qui décrivent les objets du jeu pour être utilisés via l'éditeur de niveaux ;
    • ./level-editor : l'éditeur de niveaux ;
    • ./model-editor : l'éditeur de modèles.

Enfin, le dossier plee-the-bear contient le matériel du jeu en lui même. Il est en partie organisé comme suit :

  • ./plee-the-bear
    • ./data : les données du jeu (niveaux, modèles, polices de caractères, images, animations, sons) ;
    • ./game : contient un script qui lance le programme running-bear avec les bons paramètres pour Plee the Bear ;
    • ./item-description : les fichiers de description d'objet, qui décrivent les objets du jeu pour être utilisés via l'éditeur de niveaux ;
    • ./src : le code source du jeu.

Compilation

La compilation se fait en deux étapes, à partir du dossier récupéré via la commande svn. Premièrement, il faut créer les Makefiles à l'aide de CMake, qui va en plus se charger de trouver toutes les bibliothèques, si elles sont installées. 

cmake .

Puis, il ne reste qu'à compiler le tout à l'aide de la bonne vieille commande make. 

make

Remarquez qu'il n'est pas nécessaire d'exécuter un make install. Le jeu est immédiatement utilisable à partir du dossier ./plee-the-bear/game (voir plus bas).

Options pour CMake

Plusieurs paramètres peuvent être passés à CMake pour peaufiner la compilation. Par exemple, pour ne pas compiler les éditeurs tout en produisant une version de débogage, il faut écrire 

cmake . -DBEAR_NO_EDITOR=TRUE -DCMAKE_BUILD_TYPE=debug

Quelques options valides sont listées ci-dessous. D'autres peuvent être trouvées dans la documentation de CMake.

  • -DCMAKE_INSTALL_PREFIX=/un/chemin : change le répertoire d'installation pour /un/chemin (par défaut, /usr/local est utilisé) ;
  • -DCMAKE_BUILD_TYPE={release,debug} : compile avec toutes les optimisations (release) ou avec les informations de débogage (debug) ;
  • -DBEAR_NO_EDITOR=TRUE : indique de ne pas compiler les éditeurs (ils sont compilés par défaut) ;
  • -DBEAR_ENGINE_INSTALL_EXECUTABLE_DIR=un/chemin : le répertoire où les exécutables du moteur seront installés, relativement à CMAKE_INSTALL_PREFIX (par défaut, bin est utilisé) ;
  • DBEAR_ENGINE_INSTALL_LIBRARY_DIR=un/chemin : le répertoire où les bibliothèques du moteur seront installées, relativement à CMAKE_INSTALL_PREFIX (par défaut, lib est utilisé, ou BEAR_INSTALL_EXECUTABLE_DIR sous Windows) ;
  • -DBEAR_FACTORY_INSTALL_EXECUTABLE_DIR=un/chemin : le répertoire où les exécutables des éditeurs seront installés, relativement à CMAKE_INSTALL_PREFIX (par défaut, bin est utilisé) ;
  • DBEAR_FACTORY_INSTALL_LIBRARY_DIR=un/chemin : le répertoire où les bibliothèques des éditeurs seront installées, relativement à CMAKE_INSTALL_PREFIX (par défaut, lib est utilisé, ou BEAR_INSTALL_EXECUTABLE_DIR sous Windows) ;
  • -DBEAR_FACTORY_INSTALL_EXECUTABLE_DIR=un/chemin : le répertoire où les exécutables du jeu Plee the Bear seront installés, relativement à CMAKE_INSTALL_PREFIX (par défaut, bin est utilisé) ;
  • -DPTB_INSTALL_DATA_DIR=un/chemin : le répertoire où les données du jeu Plee the Bear seront installées, relativement à CMAKE_INSTALL_PREFIX (par défaut, share/plee-the-bear est utilisé) ;
  • -DPTB_INSTALL_CUSTOM_LIBRARY_DIR=un/chemin le répertoire ou les bibliothèques d'objets seront installées, relativement à CMAKE_INSTALL_PREFIX (par défaut, BEAR_INSTALL_LIBRARY_DIR/plee-the-bear est utilisé).

Exécution

Une fois la compilation terminée, il suffit d'aller dans le dossier plee-the-bear/game pour lancer le jeu en tapant 

./plee-the-bear

ou, sous Windows, 

plee-the-bear.bat

Après quoi l'écran titre devrait apparaître. Des messages de log sont sauvegardés dans un fichier log.txt et peuvent permettre de retrouver la cause d'un problème, ou de suivre l'exécution du programme.

Windows

Pour que le jeu se lance correctement, il est fortement conseillé de copier les bibliothèques suivantes dans ce dossier 

boost_filesystem-mgw34-mt-1_34_1.dll
boost_thread-mgw34-mt-1_34_1.dll
jpeg62.dll
libclaw_application.dll
libclaw_configuration_file.dll
libclaw_dynamic_library.dll
libclaw_graphic.dll
libclaw_logger.dll
libclaw_net.dll
libiconv2.dll
libintl3.dll
libogg-0.dll
libpng3.dll
libvorbis-0.dll
libvorbisfile-3.dll
mingwm10.dll
sdl.dll
SDL_mixer.dll
smpeg.dll
zlib1.dll

Certaines peuvent avoir un nom différent selon le compilateur et les versions des bibliothèques que vous utilisez. En particulier, les bibliothèques de boost_filesystem-mgw34-mt-1_34_1.dll, boost_thread-mgw34-mt-1_34_1.dll et mingwm10.dll sont spécifiques à la bibliothèque boost dans sa version 1.34.1 et à l'utilisation du compilateur mingw.

Récupérée de « http://plee-the-bear.sourceforge.net/wiki/index.php/D%C3%A9p%C3%B4t_subversion »