Difference between revisions of "Manual"

From GCompris
Jump to: navigation, search
Line 36: Line 36:
  
 
An icon indicates if a good functioning of sound support is required for an activity :
 
An icon indicates if a good functioning of sound support is required for an activity :
* Haut parleur : Les fichiers sons pour cette activité sont bien installés.
+
* Soundspeaker : The audio files are settled for this activity.
* Haut parleur avec une croix rouge : Les fichiers sons ne sont pas installés pour la langue courante.
+
* Soundspeaker with a red cross : The audio files are not installed in the present language.
  
Les étoiles indiquent le groupe d'âge adapté à chaque jeu :
+
The stars indicates the age group adapted to each gameLes étoiles indiquent le groupe d'âge adapté à chaque jeu :
* [[Image:Difficulty star1.png|32 px]] 1, 2 ou 3 étoiles - de 2 à 6 ans
+
* [[Image:Difficulty star1.png|32 px]] 1, 2 or 3 stars - from 2 to 6 years old.
* [[Image:Difficulty star4.png|32 px]] 1, 2 ou 3 étoiles complexes - 6 ans et plus.
+
* [[Image:Difficulty star4.png|32 px]] 1, 2 or 3 complex stars - more than 6.
  
Au bas de l'écran se trouve la barre de contrôle de GCompris. Les icônes suivantes sont décrites ci-dessous de droite à gauche. (Notons que ces icônes ne sont affichées que si elles sont disponibles dans l'activité) :
+
At the bottom of the screen there is a control bar of GCompris. The following icons are described below from the right to the left (the icons are only displayed if they are available in the activity) :
* [[Image:Home.png|32 px]] Accueil - Quitte l'activité en cours, revient au menu précédent
+
* [[Image:Home.png|32 px]] Home - Leaves the running activity, returns to the previous menu.
* [[Image:Button ok.png|32 px]] Pouce - Valider, confirmer ta réponse. Certaines activités ne détectent pas automatiquement que l'enfant a terminé la tâche. Dans ce cas, il faut cliquer sur cette icône. Il est aussi possible dans ce cas d'utiliser la touche 'entrée' du clavier.
+
* [[Image:Button ok.png|32 px]] Thumb - Validate, confirm your answer. Some activities do not detect automatically if the child has completed the task. In this case, you have to click on this icon. It is possible to you use the "enter" key on your keyboard.
* [[Image:Level1.png|32 px]] Dé - Le niveau courant est affiché. Clique dessus pour sélectionner un autre niveau. Les activités proposent en général plusieurs niveaux. Le nombre de niveaux dépend de l'activité. Dans GCompris, il est possible de passer au niveau suivant sans avoir terminé le niveau en cours.
+
* [[Image:Level1.png|32 px]] Dice - The present level is displayed. Click on the dice to select another level. Generally, the activities propose several levels which numbers depends on the activity. In GCompris, it is possible to go to next level without having completed the running level.
* [[Image:Repeat.png|32 px]] Lèvres - Demande à GCompris de répéter la question
+
* [[Image:Repeat.png|32 px]] Lips - Ask GCompris to repeat the question.
* [[Image:Help.png|32 px]] Point d'interrogation - Affiche la boîte de dialogue de l'aide. Dans certains cas, une activité peut être trop complexe pour être décrite simplement dans la zone de description des activités. Dans ce cas, cette fonction donne accès aux informations additionnelles.
+
* [[Image:Help.png|32 px]] Interrogation mark - Display the help dialog box. Sometimes, an activity can be too complex to be described easily in the description area. In this case, this function gives access to additional information.
* [[Image:Config.png|32 px]] Boîte à outils - Menu de configuration. La configuration est persistante et est sauvée dans le répertoire de l'utilisateur sous le nom .config/gcompris/gcompris.conf. Ce fichier est un fichier texte qui peut être édité manuellement.
+
* [[Image:Config.png|32 px]] Tool box - Configuration menu. The configuration persists and is saved in the user repertory under the name .config/gcompris/gcompris.conf. This is a text file which can be manually edited.
* [[Image:About.png|32 px]] Tux et son avion - Boîte d'information sur GCompris, présente les contributeurs principaux et la version du logiciel.
+
* [[Image:About.png|32 px]] Tux and his plane - Information box on GCompris, presents the main contributors and the version of the software.
* [[Image:Button exit.png|32 px]] Nuit - Quitter GCompris. Vous pouvez aussi utiliser le raccourci clavier 'ctrl-q'.
+
* [[Image:Button exit.png|32 px]] Night - Quit GCompris. You can also use the short cut on your keyboard 'ctrl-q'.
  
  

Revision as of 17:42, 8 July 2007

Introduction

GCompris is a complete a Free educational software which contains a wide range of activities. It proposes a set of various activities aimed to cover several fields such as the functioning of the computer - mouse, keyboard...-, general learnings - reading, writing, foreign languages, algebra - as well as various activities such as memory and logic games, scientific experiments...

Today, you can find many softwares which propose individually parts of GCompris activities. Unfortunately, it is difficult to follow and maintain them and each one offers different graphic interfaces of more or less good quality. The purpose of GCompris is to provide with a development platform for educational activities. GCompris is part of GNU project and is placed under GPL license.


Minimal configuration

  • Processor : Pentium 2 166Mhz
  • Read only memory (RAM) : 32 Mega Bytes
  • Operating system : GNU/Linux, BSD, MacOSX, Windows
  • Video : A 3D card is NOT required.

Installation

The software is delivered under several forms. Follow the process according to your case.

  • GNU/Linux : Use the packages delivered by GNU/Linux. If GCompris is not packaged in your Linux distribution, please contact them to ask for the inclusion of GCompris in your Linux distribution.
  • Windows : Delivered under a classic installer for Windows. Windows version is limited to a number of activities, you can contribute to GCompris development and obtain the activation code for a fee.
  • MacOSX : Porting in progress.

The user interface

The interface is designed to be easy to use for small children. GCompris is controlled with a mouse, it cannot be used without a mouse or a pointing system.

Main window

The main menu. On the left the main sections. On top the sub menus.

When you start the game, GCompris shows out a graphic interface which presents the list of activities and a control bar at the bottom.

Each icon represents an activity. When the mouse is set on it, the activity is highlighted and the name, the description, the author of the activity are displayed in the description area.

Around each one, you can find small icons which give additional information about the activity. A simple click on the icon will lead you to an activity or a menu of activities.

An icon indicates if a good functioning of sound support is required for an activity :

  • Soundspeaker : The audio files are settled for this activity.
  • Soundspeaker with a red cross : The audio files are not installed in the present language.

The stars indicates the age group adapted to each gameLes étoiles indiquent le groupe d'âge adapté à chaque jeu :

  • Difficulty star1.png 1, 2 or 3 stars - from 2 to 6 years old.
  • Difficulty star4.png 1, 2 or 3 complex stars - more than 6.

At the bottom of the screen there is a control bar of GCompris. The following icons are described below from the right to the left (the icons are only displayed if they are available in the activity) :

  • Home.png Home - Leaves the running activity, returns to the previous menu.
  • Button ok.png Thumb - Validate, confirm your answer. Some activities do not detect automatically if the child has completed the task. In this case, you have to click on this icon. It is possible to you use the "enter" key on your keyboard.
  • Level1.png Dice - The present level is displayed. Click on the dice to select another level. Generally, the activities propose several levels which numbers depends on the activity. In GCompris, it is possible to go to next level without having completed the running level.
  • Repeat.png Lips - Ask GCompris to repeat the question.
  • Help.png Interrogation mark - Display the help dialog box. Sometimes, an activity can be too complex to be described easily in the description area. In this case, this function gives access to additional information.
  • Config.png Tool box - Configuration menu. The configuration persists and is saved in the user repertory under the name .config/gcompris/gcompris.conf. This is a text file which can be manually edited.
  • About.png Tux and his plane - Information box on GCompris, presents the main contributors and the version of the software.
  • Button exit.png Night - Quit GCompris. You can also use the short cut on your keyboard 'ctrl-q'.


Kiosk mode

Language learning

Administering GCompris

Activity selection

Select an activity.

Profile creation

Editing profiles.

Using a profile

Activity configuration

User and class creation

The classes and the users.


Groups creation

Creating groups.


Reporting

Trace usage for the children Jon.

Identification

Children recognize their name and click on it.
Children enter their login.

Deployment

If you administer a school network, you can over load the configuration options of your users by yours. To edit a configuration file, the easiest way is to create one from GCompris. Simply configure GCompris as you wish, quit it and copy the created configuration file in the system one. From it, you can remove the options you don't want to be compulsory.

Configuration file example:

music=1
fx=1
screensize=1
fullscreen=1
timer=1
key="default"

GNU/Linux

On GNU/Linux, the configuration file is in the user directory under ~/.config/gcompris/gcompris.conf

You must copy your own system configuration file under /etc/gcompris.conf

Windows

On Windows, the configuration file is in C:\Documents and Settings\YOUR USER\.config\gcompris\gcompris.conf

You must put the system configuration file at the GCompris's root installation directory. By default, it's C:\Program Files\Gcompris

On Windows, it makes sense to put at least the line 'key="your 6 digit key"'. This way, all users on this PC won't have to activate GCompris.

On school networks, you can simply copy this file using your deployment system.

Portable GCompris

Portable software is a class of software that is suitable for use on portable drives such as a USB (thumb) drive or iPod, although any external hard drive could theoretically be used. The concept of carrying one's favored applications, utilities, and files on a portable drive for use on any computer is one which has evolved considerably in recent years.

GCompris can be made portable very easily by installing it on the target thumb drive and adding in its directory a gcompris.conf configuration file which includes a local user and configuration directory. The directory are specified as relative to the gcompris.exe binary.

Configuration file example:

user_dir="../My GCompris"
config_dir="../GCompris_config"
key="your 6 digit key if you have it"

Useful options

Running GCompris from a console with the --help option will display all the parameters it accepts:

  • -f, --fullscreen run gcompris in fullscreen mode.
  • -w, --window run gcompris in window mode.
  • -s, --sound run gcompris with sound enabled.
  • -m, --mute run gcompris without sound.
  • -c, --cursor run gcompris with the default gnome cursor.
  • -d, --difficulty display only activities with this difficulty level.
  • -D, --debug display debug informations on the console.
  • -v, --version Print the version of gcompris
  • -x, --noxf86vm Disable XF86VidMode (No screen resolution change).
  • -l, --root-menu Run gcompris with local menu (e.g -l /reading will let you play only activities in the reading directory, -l /strategy/connect4 only the connect4 activity)
  • -L, --local-activity Run GCompris with local activity directory added to menu
  • -a, --administration Run GCompris in administration and user-management mode
  • -b, --database Use alternate database for profiles [$HOME/.config/gcompris/gcompris_sqlite.db]
  • -j, --logs Use alternate database for logs
  • --create-db Create the alternate database for profiles
  • --reread-menu Re-read XML Menus and store them in the database
  • -p, --profile Set the profile to use. Use 'gcompris -a' to create profiles
  • --profile-list List all available profiles. Use 'gcompris -a' to create profiles
  • --config-dir Config directory location: [$HOME/.config/gcompris]. Alternate is to set $XDG_CONFIG_HOME.
  • --user-dir The location of user directories: [$HOME/My GCompris]
  • --experimental Run the experimental activities
  • --disable-quit Disable the quit button
  • --disable-config Disable the config button
  • --display-resource Display the resources on stdout based on the selected activities
  • --server GCompris will get images, sounds and activity data from this server if not found locally.
  • --web-only Only when --server is provided, disable check for local resource first. Data are always taken from the web server.
  • --cache-dir In server mode, specify the cache directory used to avoid useless downloads.
  • -g, --drag-mode Global drag and drop mode: normal, 2clicks, both. Default mode is normal.
  • --nobackimg Do not display the background images of activities.