Documentation des fonctions accessibles dans les scripts de PlayOnLinux.
Préambule
Les fonctions présentées ci-dessous sont utilisables dans les scripts prévus pour être utilisées dans PlayOnLinux. Les paramètres écrits en vert sont obligatoires, les autres facultatifs.
Pour passer un paramètre à une fonction l'ordre doit être respecté, par exemple la fonction "exemple" reçoit 3 paramètres le premier et le dernier sont obligatoires, le deuxième facultatif. L'appel devra être au moins comme ceci :
exemple "paramètre obligatoire 1" "" "paramètre obligatoire 2"
ou
exemple "paramètre obligatoire 1" "paramètre facultatif 1" "paramètre obligatoire 2"
Ne sont présentées dans cette documentation que les fonctions utiles lors de la création de script, PlayOnLinux utilise d'autres fonctions qui ne sont pas présentées ici.
L'utilisation des commandes su, sudo, gksu, kdesu ... (toutes les commandes qui changent les privilèges de l'utilisateur) sont strictement interdites dans tous les scripts de PlayOnLinux (ainsi que dans le logiciel)
creer_lanceur
La fonction creer_lanceur permet de créer un lanceur accessible dans le menu PlayOnLinux, sur le bureau, ou dans le gestionnaire de fenêtre.
| Paramètre | Fonction | Type |
| WinePrefix | Définit dans quel préfixe le logiciel est installé | Chaîne de caractères |
| Repertoire | Définit dans quel dossier ou sous-dossier du préfixe le logiciel est installé. | Chaîne de caractères |
| Binaire | Définit le nom de l'exécutable devant être lancé. | Chaîne de caractères |
| Icone | Nom de l'icône devant être affichée lors de la création du raccourci. Les formats acceptés sont png et xpm. Les fichiers doivent être situés sur le site de PlayOnLinux. Contacter les administrateurs pour de plus amples informations |
Chaîne de caractères |
| Nom de l'icone | Définit le nom qui sera donné au lanceur, par défaut le nom du préfixe est utilisé. | Chaîne de caractères |
| Rien | Ce paramètre n'est pas utilisé, il s'agit d'une compatibilité avec les versions < 2.0 | Rien |
| Eventuel argument | Paramètre éventuel à passer au programme lors du lancement | Chaîne de caractères |
creer_lanceur "My Big Game" "Program Files/The_MulXGame/" "YetAnotherGame.exe"
message
Cette fonction affiche un message à l'intention de l'utilisateur du script.
| Paramètre | Fonction | Type |
| Message | Le corps du message | Chaîne de caractères |
| Titre | Titre de la fenàtre affichant le message | Chaîne de caractères |
| NumeroEtape | Numéro de l'étape en cours | Entier non signé |
| NombreEtape | Nombre total d'étapes du script | Entier non signé |
| BoutonAnnule | Définit la visibilité du bouton annulé. 1 = Visible ; 0 = Non visible |
Booléen |
| Image | Image à afficher dans la fenêtre | Chaîne de caractères |
| BoutonSuivant | Définit le texte du bouton suivant | Chaîne de caractères |
message "Everybody need, needed or will need a drawing to get the message to be understood."
erreur
La fonction erreur a un comportement identique à la fonction message.
erreur "Those who are never wrong never try."
attention
La fonction attention a un comportement identique à la fonction message.
attention "The greater danger in times of turbulence is not the turbulence. It's acting with yesterday's logic."
question
Pose une question � l'utilisateur.
La r�ponse est renvoy�e comme un bool�en. '1' signifie que l'utilisateur a r�pondu "Non" et '0' que l'utilisateur a r�pondu "Oui"
| Param�tre | Fonction | Type |
| message | La question � afficher | Cha�ne de caract�res |
| titreFenetre | Le titre de la fen�tre | Cha�ne de caract�res |
| NumeroEtape | Num�ro de l'�tape en cours | Entier non sign� |
| NombreEtape | Nombre total d'�tapes du script | Entier non sign� |
| BoutonAnnule | D�finit la visibilit� du bouton annul�. 1 = Visible ; 0 = Non visible |
Booleen |
| Image | Image � afficher dans la fen�tre | Cha�ne de caract�res |
question "Do you know the Answer to the Ultimate Question of Life, the Universe and Everything ?" "Don't Panic, It's just a question ! "
champ
La commande champ permet � l'utilisateur de remplir un champ. La saisie de l'utilisateur est retourn�e tel quel si il clique sur suivant, sinon rien n'est retourn�.
| Param�tre | Fonction | Type |
| message | Le texte justifiant la saisie de l'utilisateur (g�n�ralement une question) | Cha�ne de caract�res |
| D�faut | Valeur par d�faut du champ | Cha�ne de caract�res |
| NumeroEtape | Num�ro de l'�tape en cours | Entier non sign� |
| NombreEtape | Nombre total d'�tapes du script | Entier non sign� |
| BoutonAnnule | D�finit la visibilit� du bouton annul�. 1 = Visible ; 0 = Non visible |
Bool�en |
| titreFenetre | Le titre de la fen�tre | Cha�ne de caract�res |
| Image | Image � afficher dans la fen�tre | Cha�ne de caract�res |
champ "WHAT DO YOU GET IF YOU MULTIPLY SIX BY NINE?" "42" "" "" "" "Arthur's Scrabble tiles"
menu
Cette fonction affiche un menu � l'utilisateur. Le choix de l'utilisateur est renvoy�, si aucun choix n'est effectu� rien n'est retourn�.
| Param�tre | Fonction | Type |
| Message | texte du message | Cha�ne de caract�res |
| Items | �l�ments du menu | Cha�ne de caract�res |
| Titre | Le titre de la fen�tre | Cha�ne de caract�res |
| NumeroEtape | Num�ro de l'�tape en cours | Entier non sign� |
| NombreEtape | Nombre total d'�tapes du script. | Entier non sign� |
| BoutonAnnule | D�finit la visibilit� du bouton annul�. 1 = Visible ; 0 = Non visible |
Bool�en |
| Image | Image � afficher dans la fen�tre | Cha�ne de caract�res |
| S�parateur | D�finit sur quel caract�re les �l�ments du menu seront s�par�s | Cha�ne de caract�res |
| Suivant | Texte du bouton suivant | Cha�ne de caract�res |
| Type de retour | [ 1 = Par ID, 0 = Par Nom ] D�faut = 0 | Bool�en |
menu "Choose between oven, and the mill ! " "oven mill" "" "" "" "" "wizard.png"menu_list
Cette fonction est connue sous le nom de menu dans les versions < 2.1.0
Cette fonction propose une liste de choix � l'utilisateur. Une fois le choix de l'utilisateur fait, la valeur choisie est retourn�e.
Si aucune valeur n'a �t� choisie la fonction ne retourne rien.
| Param�tre | Fonction | Type |
| Message | Texte du message | Cha�ne de caract�res |
| Items | �l�ment du menu. | Cha�ne de caract�res |
| Titre | Le titre de la fen�tre | Cha�ne de caract�res |
| NumeroEtape | Num�ro de l'�tape en cours | Entier non sign� |
| NombreEtape | Nombre total d'�tapes du script. | Entier non sign� |
| BoutonAnnule | D�fini la visibilit� du bouton annul�, par d�faut le bouton n'est pas activ�. 1 = Visible ; 0 = Non visible |
Bool�en |
| Image | Image � afficher dans la fen�tre | Cha�ne de caract�res |
| S�parateur | D�finit sur quel caract�re les �l�ments du menu seront s�par�s | Cha�ne de caract�res |
| Suivant | D�finit le texte du bouton suivant | Cha�ne de caract�res |
menu_list "You must do a choice from this list" "First choice~Second choice" "This is the fabulous title :)" "" "" "" "" "~"
attendre
Cette fonction affiche une boite de dialogue indiquant � l'utilisateur qu'il doit attendre le temps que la commande lanc�e soit termin�e
| Param�tre | Fonction | Type |
| Message | Message devant �tre affich� � l'utilisateur. | Cha�ne de caract�res |
| Commande | Commande devant �tre ex�cut�e par le syst�me. Attention � ne pas utiliser des commandes propres � une distribution. Il ne s'agit pas d'une commande interne � PlayOnLinux. |
Cha�ne de caract�res |
| Titre | Le titre de la fen�tre | Cha�ne de caract�res |
| NumeroEtape | Num�ro de l'�tape en cours | Entier non sign� |
| NombreEtape | Nombre total d'�tapes du script. | Entier non sign� |
| BoutonAnnule | D�finit la visibilit� du bouton annul�, par d�faut le bouton est activ�. 1 = Visible ; 0 = Non visible |
Booleen |
| Image | Image � afficher dans la fen�tre | Cha�ne de caract�res |
| autoExit | D�termine si la fen�tre doit �tre ferm�e automatiquement une fois que la commande est termin�e.
1 = la fen�tre sera ferm�e automatiquement, 0 = la fen�tre ne sera pas ferm�e. |
Bool�en |
| exitMessage | Message devant �tre affich� une fois que la commande est termin�e
Ceci remplace le message d�fini par le premier param�tre |
Cha�ne de caract�res |
| Suivant | D�finit le texte du bouton suivant | Cha�ne de caract�res |
attendre "Wait 10s and you can know the answer" "sleep 10s" "Don't panic ! " "" "" "0" "" "" "So the answer ? It's 42 for what ;-)
But do you know the real question ?" "Yet H2G2"
telecharger
Cette fonction t�l�charge depuis internet un fichier, et l'enregistre dans le r�p�rtoire o� la fonction a �t� execut�e.
| Param�tre | Fonction | Type |
| Message | Message devant �tre affich� � l'utilisateur. | Cha�ne de caract�res |
| Fichier | Adresse du fichier � t�l�charger, de la forme http://www.exemple.com/fichier.txt | Cha�ne de caract�res, URL |
| Titre | Le titre de la fen�tre | Cha�ne de caract�res |
| NumeroEtape | Num�ro de l'�tape en cours | Entier non sign� |
| NombreEtape | Nombre total d'�tapes du script. | Entier non sign� |
| BoutonAnnule | D�finit la visibilit� du bouton annul�, par d�faut le bouton est activ�. 1 = Visible ; 0 = Non visible |
Booleen |
| Image | Image � afficher dans la fen�tre | Cha�ne de caract�res |
| autoExit | D�termine si la fen�tre doit �tre ferm�e automatiquement une fois que la commande est termin�e.
1 = la fen�tre sera ferm�e automatiquement, 0 = la fen�tre ne sera pas ferm�e. |
Bool�en |
| autoDl | Lance le t�l�chargement automatiquement
1 = le t�l�chargement d�marre automatiquement, 0 = le t�l�chargement ne d�marre pas automatiquement. |
Bool�en |
telecharger "Downloading Wine for Windows System (Strange is'nt it ? ) " "http://heanet.dl.sourceforge.net/sourceforge/wine/wine-dlls-0.9.14.zip" "" "" "" "0"
selectionner_fichier
La fonction selectionner_fichier permet de s�lectionner un fichier. Le chemin d'acc�s absolu est retourn� comme �tant une cha�ne de caract�res.
| Param�tre | Fonction | Type |
| Message | Message devant �tre affich� � l'utilisateur. | Cha�ne de caract�res |
| Defaut | Valeur du chemin par d�faut | Cha�ne de caract�res, chemin d'acc�s |
| NumeroEtape | Num�ro de l'�tape en cours | Entier non sign� |
| NombreEtape | Nombre total d'�tapes du script. | Entier non sign� |
| BoutonAnnule | D�finit la visibilit� du bouton annul�, par d�faut le bouton est activ�. 1 = Visible ; 0 = Non visible |
Booleen |
| Titre | Le titre de la fen�tre | Cha�ne de caract�res |
| Image | Image � afficher dans la fen�tre | Cha�ne de caract�res |
selectionner_fichier "Where is Dave ? " "/dev/null"
afficher_fichier
Cette fonction affiche le contenu d'un fichier.
| Param�tre | Fonction | Type |
| Fichier | Chemin d'acc�s au fichier. Le chemin peut �tre absolu ou relatif. | Cha�ne de caract�res |
| Titre | Le titre de la fen�tre | Cha�ne de caract�res |
| NumeroEtape | Num�ro de l'�tape en cours | Entier non sign� |
| NombreEtape | Nombre total d'�tapes du script. | Entier non sign� |
| BoutonAnnule | D�finit la visibilit� du bouton annul�, par d�faut le bouton est activ�. 1 = Visible ; 0 = Non visible |
Booleen |
| Image | Image � afficher dans la fen�tre | Cha�ne de caract�res |
| BoutonSuivant | D�finit le texte du bouton suivant | Cha�ne de caract�res |
afficher_fichier "/proc/diskstats"
navigateur
Ouvre le navigateur web par d�faut � l'adresse sp�fici�e en argument.
navigateur http://www.playonlinux.comsimuler_reboot
Cette commande permet de simuler un red�marrage de syst�me.
| Param�tre | Fonction | Type |
| NumeroEtape | Num�ro de l'�tape en cours | Entier non sign� |
| NombreEtape | Nombre total d'�tapes du script. | Entier non sign� |
select_prefixe
Cette fonction permet de s�lectionner le pr�fixe utilis� par Wine ou DosBox.
| Param�tre | Fonction | Type |
| Prefixe | Chemin d'acc�s au pr�fixe de Wine ou DosBox devant �tre utilis� | Cha�ne de caract�res |
creer_prefixe
Cette fonction permet de cr�er et de mettre � jour le pr�fixe de Wine pr�alablement d�fini par select_prefixe.
| Param�tre | Fonction | Type |
| NumeroEtape | Num�ro de l'�tape en cours | Entier non sign� |
| NombreEtape | Nombre total d'�tapes du script. | Entier non sign� |
Ask_For_cdrom
Cette fonction demande � l'utilisateur le chemin d'acc�s vers le CD-ROM et d�finit la variable CDROM comme chemin d'acc�s au CDROM.
| Param�tre | Fonction | Type |
| NumeroEtape | Num�ro de l'�tape en cours | Entier non sign� |
| NombreEtape | Nombre total d'�tapes du script. | Entier non sign� |
| NumeroCd | Le num�ro du CD-ROM lors de l'installation d'application multi-cd. | Entier non sign� |
Check_cdrom
Cette fonction v�rifie la pr�sence du fichier pass� en param�tre.
Cette fonction doit �tre appel�e apr�s Ask_For_cdrom
| Param�tre | Fonction | Type |
| Program | Chemin d'acc�s relatif (bas� sur le contenu de $CDROM) permettant de confirmer la pr�sence du (bon) CD-ROM. | Cha�ne de caract�res |
Set_OS
Cette fonction change la version du syst�me d'exploitation simul� par Wine.
Le pr�fixe de Wine doit �tre pr�alablement d�fini (par select_prefixe)
| Param�tre | Fonction | Type |
| Version | Les diff�rentes valeurs possibles sont : vista, win2003, winxp, win2k, winnt, winme, win98, win95, win31 Une seule valeur possible � la fois |
Cha�ne de caract�res |
Set_Managed
Cette fonction permet de d�finir si le gestionnaire de fen�tre contr�le la fen�tre
Le pr�fixe de Wine doit �tre pr�alablement d�fini (par select_prefixe)
| Param�tre | Fonction | Type |
| Managed | Les deux valeurs possibles sont : On ou Off. La casse doit �tre respect�e |
Bool�en |
Set_SoundDriver
Cette fonction d�finit le pilote audio qui doit �tre utilis�
Le pr�fixe de Wine doit �tre pr�alablement d�fini (par select_prefixe)
| Param�tre | Fonction | Type |
| Audio | Les valeurs possibles sont : alsa ; oss ; esd La casse doit �tre respect�e |
Tril�en :-/ |
Set_GLSL
Cette fonction permet de d�finir le support de GLSL par Wine (voir la page de wikipedia (en) pour de plus amples informations).
Le pr�fixe de Wine doit �tre pr�alablement d�fini (par select_prefixe)
| Param�tre | Fonction | Type |
| GLSL | Les deux valeurs possibles sont : On ou Off. La casse doit �tre respect�e |
Bool�en |
Set_DXGrab
Cette fonction d�finie si DirectX © peut contr�ler la souris
Le pr�fixe de Wine doit �tre pr�alablement d�fini (par select_prefixe)
| Param�tre | Fonction | Type |
| DXGrab | Les deux valeurs possibles sont : On ou Off. La casse doit �tre respect�e |
Bool�en |
Set_Iexplorer
Cette fonction simule la pr�sence de Microsoft Internet Explorer 6 ©
Le pr�fixe de Wine doit �tre pr�alablement d�fini (par select_prefixe)
Set_Desktop
Cette fonction active ou d�sactive le bureau virtuel Wine
Le pr�fixe de Wine doit �tre pr�alablement d�fini (par select_prefixe)
| Param�tre | Fonction | Type |
| Desktop | Les deux valeurs possibles sont : On ou Off. La casse doit �tre respect�e |
Bool�en |
| Width | D�finit la largeur du bureau virtuel obligatoire lors de l'activation (premier param�tre � On) | Entier non sign� |
| Height | D�finit la hauteur du bureau virtuel obligatoire lors de l'activation (premier param�tre � On) | Entier non sign� |
fonts_to_prefixe
Cette fonction copie les polices de caract�res dans le dossier Wine d�fini au pr�alable par select_prefixe
Set_WineVersion_Assign
Cette version permet de changer la version de Wine utilis� par une application pour une autre.
Tous les jeux not�s "Platinum" sur le site de Wine doivent �tre d�finis � une version fixe de Wine, en raison de probl�mes de r�gression possible entre les diff�rentes versions de Wine.
Si la version de Wine n'est pas pr�sente dans le dossier de l'utilisateur, elle sera automatiquement install�e (puis assign�e)
| Param�tre | Fonction | Type |
| Version | Version de Wine devant �tre assign�e. Utiliser --reset pour revenir � la version de Wine install�e sur le syst�me de l'utilisateur. | Cha�ne de caract�res |
| Jeu | Nom de l'application devant �tre assign�e, le nom doit �tre identique � celui utilis� dans creer_lanceur | Cha�ne de caract�res |
Set_WineVersion_Session
Cette fonction permet de changer la version de Wine devant �tre utilis�e.
Contrairement � Set_WineVersion_Assign cette fonction modifie la version de Wine uniquement pour la dur�e d'ex�cution du script.
Cette fonction devrait aussi �tre utilis�e pour r�aliser une installation avec une version de Wine dont le fonctionnement est connu sans probl�me.
| Param�tre | Fonction | Type |
| Version | Version de Wine devant �tre assign�e. Utiliser --reset pour revenir � la version de Wine install�e sur le syst�me de l'utilisateur. | Cha�ne de caract�res |
Variable
Il s'agit d'une liste non-exaustive des variables pouvant �tre utilis�es dans les scripts.
Le contenu des variables est obtenu par l'ajout du symbole $ devant le nom de la variable exemple : $LANG
La valeur d'une variable est affect�e par l'op�rande = exemple : auteur="MulX" ; la variable auteur est cr��e (si non existante) et initialis�e � la valeur MulX . Lors de l'affectation d'une cha�ne de caract�res il faut "encadrer" la cha�ne par des " (double quotes).
La casse doit �tre respect�e lors de l'utilisation d'une variable auteur est diff�rent de Auteur qui est aussi diff�rent de AUTEUR
Si vous avez un doute sur l'utilisation des variables n'h�sitez pas venir relire cette page
Les diff�rentes variables sont donc :
| Nom | Contenu |
| PLAYONLINUX | Contient le chemin d'acc�s absolu au logiciel PlayOnLinux |
| REPERTOIRE | Contient le chemin d'acc�s absolu au dossier PlayOnLinux de l'utilisateur de PlayOnLinux ( �quivalent � $HOME/.PlayOnLinux ) |
| POL_LANG | Contient la langue utilis�e par PlayOnLinux |
| CDROM | Contient le chemin absolu vers le CD-ROM, elle est initialis�e apr�s l'appel de Ask_For_cdrom |
| WINEPREFIX | Variable utilis�e par Wine pour savoir o� est install�e l'application, initialis�e par l'appel de select_prefixe |
Langue
Menu
Tchat
jason-pol : anyone in here have steam?
twosheddz : New to pol, need some help getting a game running, please
POL_Guest_7214 : hey all
POL_Guest_7214 : i just wana asj something wats up with unable to find auto ru...
shadowx-pol : any spanish?
skel-pol : salut a vous
jymbob : Hi. Can anyone help me change the icon of a launcher in pol?
Publicité
Qui est en ligne ?
154 personnes en ligne.
Partenaires
