Cleanup doc Fr

README_FR.md

@@ -4,7 +4,7 @@ Blender addon - Boîte a outils de grease pencil pour la production d'animation.
 
 **[Télécharger la dernière version](https://gitlab.com/autour-de-minuit/blender/GP_toolbox/-/archive/master/GP_toolbox-master.zip)**
 
-> Une fois en place un système de mise a jour facilité est accessible dans les préférence (La vérification automatique dde nouvelle mise a jour peut y être activé)
+> Une fois en place un système de mise a jour facilité est accessible dans les préférence (La vérification automatique de nouvelle mise a jour peut y être activé)
 
 Il est recommandé de désactiver l'addon natif "Grease pencil tools" car ces outils sont déjà intégré dans la toolbox et risque de créer des conflit.
 
@@ -25,35 +25,33 @@ Expose les options suivantes:
 - passepartout de caméra - active-désactive + opactité
 - liste de boutons pour activer/désactiver les background de caméra (tous ou individuellement) avec icone par type.
 
-**Edit line opacity** - Il est en réalité pratique de pouvoir cacher l'edit line pour avoir un meilleur aperçu du rendu lors du sculpt par exemple. C'est une option lié au layer. Ce slider appelle une fonction pour affecter tout les layers de tout les objets au lieu de se cantonner au layer courant.
+**Edit line opacity** - Il est pratique de pouvoir cacher l'edit line pour avoir un meilleur aperçu du rendu lors du sculpt par exemple. C'est une option lié au layer. Ce slider appelle une fonction pour affecter tout les layers de tout les objets au lieu de se cantonner au layer courant.
 
 
 ### Tools principaux d'anim:
 
 
-**Système de Main cam VS draw cam / action cam** : pour permettre le roll du viewport quand on est en vue caméra (sans affecter la caméra def du layout) la draw cam peut être activée. c'est simplement une duplication de la caméra principale (main) parenté a cette dernière et sur laquelle on peut se permettre de faire le roll via rotate canvas (Workaround tant que blender ne permet pas de roll la vue en cam).  
+**Système de Main cam VS draw cam / action cam** - pour permettre le roll du viewport depuis la vue caméra (sans affecter la caméra def) la draw cam peut être activée. c'est simplement une duplication de la caméra principale (main) qui partage la même data, et se retrouve parenté à cette dernière. On peut ainsi se permettre de faire le roll via rotate canvas. Solution de fortune tant que blender ne permet pas de roll la vue en cam.  
 
-L'action cam (aurait du s'appeler follow_cam) fonctionne sur le principe que la draw sauf qu'elle se parente à l'objet selectionné. le but est de pouvoir suivre un objet en mouvement pour le dessiner en contitnue sans nécessairement désactiver les anims. Concrètement, cette dernière solution est plus clean et sans doute moins galère, c'est ce que les animateurs ont majoritairement utilisé.
+L'action cam (peut-être renommé en follow_cam ?) fonctionne sur le même principe que la draw sauf qu'elle se parente à l'objet selectionné. Le but est de pouvoir suivre un objet en mouvement pour le dessiner en continu sans nécessairement désactiver les anims. Concrètement, désactiver les animation d'objets est sans doute plus clean et sans doute moins galère donc option a potentiellement retirer dans le futur.
 
-**Rotate canvas** (`ctrl + alt + clic-droit`): différence avec celui intégré a grease pencil tools : la rotation en vue cam n'est possible que si on est dans une caméra de manipulation "manip_cam" pour éviter de caasser l'anim le roll de la cam principale.
+**Rotate canvas** (`ctrl + alt + clic-droit`) - Différence avec celui intégré a grease pencil tools : la rotation en vue cam n'est possible que si on est dans une caméra de manipulation (`manip_cam`) pour éviter de casser l'anim le roll de la cam principale.
 
-**Box deform** (`Ctrl+T`) : Déformation 4 coins (Peut-être le retirer maintenant qu'il est dans le _Grease pencil tools_ pour éviter les conlfits/redondances, mais d'un autre côté la version intégrée peut éventeullement être customisée et corriger d'éventuel souci, sans attendre les updates de blender, a voir)
+**Box deform** (`Ctrl+T`) - Déformation 4 coins (Déjà dans _Grease pencil tools_ donc a potentiellement retirer pour éviter de possible confits/redondances, mais d'un autre côté la version intégrée peut être customisée et corriger d'éventuel souci sans attendre les updates de la version native...)
 
-**GP keyframe jump** (raccourci a ajouter manuellement, tant qu'on a pas une keymap anim un minimum standard): Essentiel, permet d'ajouter une ou plusieurs paire de raccourcis pour aller de keyframe en keyframe (filtrage du saut personnalisable). le raccourci doit appeler l'operateur `screen.gp_keyframe_jump`, (en faire un second avec le next décoché pour faire un saut arrière)
+**GP keyframe jump** (raccourci a ajouter manuellement, tant qu'on a pas une keymap anim un minimum standard) - Essentiel ! Permet d'ajouter une ou plusieurs paire de raccourcis pour aller de keyframe en keyframe (filtrage du saut personnalisable). Le raccourci doit appeler l'operateur `screen.gp_keyframe_jump`, (en ajouter un second avec le `next` décoché pour faire un saut arrière)
 
-**Breakdown en mode objet** (`Shift+E`) : Breakdown en pourcentage entre les deux keyframes (pose une clé si l’auto-key est actif et utilise le keying set si il est actif). Même comportement et raccourci que le breakdown de bones en pose mode (juste qu'il n'existait bizzarement pas en objet)
+**Breakdown en mode objet** (`Shift+E`) - Breakdown en pourcentage entre les deux keyframes (pose une clé si l’auto-key est actif et utilise le keying set si actif). Même comportement et raccourci que le breakdown de bones en pose mode (juste qu'il n'existait bizzarement pas en objet)
 
 
-**Snap cursor** - Snap le curseur sur le canvas de GP (respecte les paramètres "tool setting" qui définit le comportement du canvas)
+**Snap cursor** - Snap le curseur sur le canvas de GP (respecte les paramètres "tool setting" qui définit le comportement du canvas)  
 À placer dans la keymap manuellement pour le moment en utilisant l'id `view3d.cusor_snap` (original `view3d.cursor3d`)
 
 
-**Playblast** - Create a playblast folder in the blend's folder.
-in 0.8.0 normal playblast (file still within addon folder) was replaced by bg_playblast (adaptation of samy tichadou's playblaster)
+**Playblast** - Créer un playblast de l'animation dans le dosssier du blend.  
+Depuis la version 0.8.0 le playblast a été remplacé par le bg_playblast (adaptation de [playblaster](https://github.com/samytichadou/Playblaster) de Samy Tichadou)
 
-**GP copy paste** - permet de copier coller les clés en dur.
-TODO -> vérifier l'intégration. semble avoir des soucis.
-Pas mal de l'avoir en addon séparé aussi vu  qu'il a son propre panel a lui. 
+**GP copy paste** - Permet de couper-copier-coller les clés en place (world space)  
 
 **check files** - série de check écris en dur dans le code. Pratique pour "fixer" rapidement sa scène:
 - Lock main cam
@@ -70,61 +68,60 @@ Pas mal de l'avoir en addon séparé aussi vu  qu'il a son propre panel a lui.
 
 ### moins important
 
-**Mirror flip X** - Applique simplement un `scale.x -1` sur la cam active (un petit indicateur s'affiche pour indiquer qu'on est en mirror, recliquer sur le bouton permet de rétablir le scale d'origine)
+**Mirror flip X** - Applique simplement un `scale.x -1` sur la cam active (un petit indicateur s'affiche pour indiquer qu'on est en mirror, re-cliquer sur le bouton permet de rétablir le scale d'origine)
 
 
-**Cursor Follow** - (Utilise un handler) : ubne fois activé, permet de faire suivre le curseur 3D sur un objet animé.
-Souci connu: Il y a un décalage d'une frame une fois activé sur un nouvel objet, il suffit de le recaler une fois.
+**Cursor Follow** (Utilise un handler) - une fois activé, permet de faire suivre le curseur 3D sur un objet animé.  
+Souci connu: Il y a un décalage d'une frame une fois activé sur un nouvel objet, il faut le recaler une fois.
 
-**Animation manager** - permet d'aciver/désactiver les anims d'objets de tout les objets ou de tout les 
+**Animation manager** - Permet d'activer/désactiver les anims d'objets de tout les objets (ou uniquement les objets de type Grease pencil)
 
-### Présent mais pas utilisés:
+### Présent mais pas utilisés
 
-**Sticky key tool** 
-Les raccourci vers des tools temporaires sont très pratique, on peut facilement créer un raccourci qui appelle le tool durant la presion d'un bouton. Cet operator est un modal qui permet de faire la même chose mais en activant simplement le tool si la touche est rapide. (`OP_temp_cutter.py > GPTB_OT_sticky_cutter` idname : `wm.sticky_cutter`)
+**Sticky key tool** - Les raccourci vers des tools temporaires sont très pratique, on peut facilement créer un raccourci qui appelle le tool durant la presion d'un bouton. Cet operator est un modal qui permet de faire la même chose mais en activant simplement le tool si l'appui sur touche est rapide.  
+À placer manuellement si besoin : idname : `wm.sticky_cutter` (fichier: `OP_temp_cutter.py > GPTB_OT_sticky_cutter` )
 
+### À potentiellement mettre de côté (peu utilisé)
 
-### À potentiellement mettre de côté/retirer:
+**Tint layer** - Permet de mettre une teinte aléatoire par calque afin de les différencier rapidement. Souci de cet opérateurm, il ne faut pas l'utiliser si on utilise les tints de layer car il en change la couleur.
 
-**Tint layer** : Très peu utilisé, permet de mettre une teinte aléatoire par calque afin de les différencier rapidement. Souci de cet opérateurm, il ne faut pas l'utiliser si on utilise les tints de layer car il en change la couleur.
+<!-- **Colorize** (gros WIP) - un sous ensemble d'outils qui était censé permettre de faire du remplissage bitmap via des color spots en envoyant deux set d'images rendu automatiquement à GMIC en ligne de commande et recalé la séquence de résultat en BG de Cam. Finalement abandonné, pas eu le temps de finir la mise au point (malgré des résultats préliminaires intéressant).
+Mais trop long a mettre en place, trop hackeu, et surtout c'est dommage de basculer sur du bitmap, la source de couleur doit rester au maximum GP/vecto. -->
 
-**Colorize** (gros WIP): un sous ensemble d'outils qui était censé permettre de faire du remplissage bitmap via des color spots en envoyant deux set d'images rendu automatiquement à GMIC en ligne de commande et recalé la séquence de résultat en BG de Cam. Finalement abandonné, pas eu le temps de finir la mise au point (malgré des résultats préliminaires intéressant).
-Maistrop long a mettre en place, trop hackeu, et surtout c'est dommage de basculer sur du bitmap, la source de couleur doit rester au maximum GP/vecto.
+## colorisation
 
-## colorisation:
+**Line stopper** - Extension des lignes pour améliorer la fermeture des formes (génère un matériaux à part pour les masquer/supprimer facilement plus tard).  
+Le hack est très simple mais aide beaucoup à fermer les contour pour éviter le leak de l'outils pot de peinture.
+Permet de diminuer le `leak_size` de ce dernier ce qui corrige certains pins de colo dans les angles obtus.
 
-**Line stopper** - Extension des lignes dans un matériaux a part pour améliorer la fermeture des formes. le hack est très simple mais aide beaucoup a fermer les contour pour éviter le leak de l'outils pot de peinture.
+**Create empty frame** - Permet de créer des frames vides sur un calques partout où il y a des frames sur les calques supérieur (permet de faire un key to key sur le calque actif ensuite sur les key pré-créée pour faire sa colo).  
+En réalité pour quelque chose de plus pratique pour la colo, il suffit d'ajouter un autre `screen.gp_keyframe_jump` operator en activant le filtre (all layers)  
+TODO: faire un "all layer _above_" ou se baser sur le nouveau filtre natif existant pour cet usage depuis blender 2.91.
 
-**Create empty frame** - Permet de créer des frames vides sur un calques partout ou il y a des frames sur les calques supérieur (permet de faire un key to key sur le calque actif ensuite sur les key pré-créée pour faire sa colo). C'est pratique à utiliser.
-En réalité pour quelque chose de plus pratique pour la colo, il suffit d'utiliser le `screen.gp_keyframe_jump` operator en activant le filtre (all layers) : TODO faire un "all layer _above_" ou se baser sur le nouveau filtre natif lié a cet usage depuis blender 2.91
-
-**Render** chemin de sorties + 2 boutons
-    - layers individually (popup pour selecitonner des layers a render individuellement)
-    - layers grouped (popup pour selectionner des layers a rendre ensemble)
-    - TODO -> Le chemin de base est défini en dur dans le project template  
-    `blend.parents[1] / "compo" / "base" / obname / (obname+'_')`  
-    -> Basculer vers un chemin personnalisable dans les préférences.
-    TODO -> profiter du système de render layers (per layer) pour faire un meilleur batch renderer.
+**Render** - chemin de sorties + 2 boutons:
+- layers individually (popup pour selectionner des calques a rendre individuellement)
+- layers grouped (popup pour selectionner des layers a rendre ensemble)
+    - utilise le chemin relatif spécifié dans les preférences d'addon pour créer un chemin par groupe comme suit : `pref.location/name/name_####`  
+TODO: profiter du système de render layers (per layer) pour faire un meilleur batch renderer.
 
 
 ## tools supplémentaires
 
-**check links** - (pop une fenêtre) permet de lister les liens de la scène, voir si il y en a des cassés et ouvrir le dossier d'un lien existant.
+**Check links** (pop une fenêtre) - Permet de lister les liens de la scène, voir si il y en a des cassés et ouvrir le dossier d'un lien existant.
 
 
 ## raccourci supplémentaires
 
 Sculpt mode:
-    point/stroke filter shortcut sur `1`, `2`, `3` en toggle (similaire a l'edit mode)
 
-cursor_GP
-    Surcharge du raccourci curseur 3D pour le snapper à la surface du grease pencil.
-    Raccourci à remplacer manuellement dans la keymap, Pas forcément utile si il n'y a un mix de 2D/3D
-    Le mieux serait d'avoir un raccourci dédié, séparé de celui d'origine...
+- point/stroke filter shortcut sur `1`, `2`, `3` en toggle (similaire a l'edit mode)
+
+Grease pencil 3D cursor: Surcharge du raccourci curseur 3D pour le snapper à la surface du grease pencil. (Raccourci à remplacer manuellement dans la keymap, idname:`view3d.cusor_snap`, idname de l'opérateur de curseur natif `view3d.cursor3d`. Pas forcément utile si il n'y a pas de mix de 2D/3D.)
+Le mieux reste d'avoir un raccourci dédié, séparé de celui d'origine...
 
 ---
 
-TODO:
+### TODO:
 
 - Permettre de rendre avec la résolution spécifié dans le nom de la caméra active
 (utile dans les projet rendu a la résolution du BG mais ou la résolution finale peut être utilisé pour un bout-a-bout)