1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>
Extending Tux Paint </title>
<meta http-equiv="Content-Type"
content="text/html; charset=utf-8">
<style>
body { font-size: large; }
table { font-size: large; }
div.screenshot-center {
text-align: center;
}
div.screenshot-right {
float: right;
margin-left: 1em;
margin-bottom: 1em;
}
div.screenshot-right-after {
clear: both;
}
div.keeptogether { page-break-inside: avoid; }
section h1 { font-size: 2em; }
h1, h2, h3, h4, h5 { font-family: sans; }
h1 { color: #800; page-break-before: always; break-before: always; }
h2 { color: #440; page-break-after: avoid; break-after: avoid; }
h3 { color: #080; page-break-after: avoid; break-after: avoid; }
h4 { color: #008; page-break-after: avoid; break-after: avoid; }
h5 { color: #808; page-break-after: avoid; break-after: avoid; }
h1 + p { page-break-inside: avoid; }
h2 + p { page-break-inside: avoid; }
h3 + p { page-break-inside: avoid; }
h4 + p { page-break-inside: avoid; }
h5 + p { page-break-inside: avoid; }
dt {
font-size: large;
color: #404;
font-family: sans;
margin-top: 1em;
margin-bottom: 0.25em;
}
dd, blockquote {
border-left: 1px solid #888;
padding-left: 1em;
border-radius: 0 0 0 1em;
}
p.note {
border: 1px solid #000;
background-color: #eee;
border-radius: 0.5em;
padding: 0.5em;
display: inline-block;
margin-right: 3em;
}
section.outer {
padding-bottom: 1em;
border-bottom: 2px solid #000;
}
section.indent p,dl {
margin-left: 2em;
}
section.indent dl p {
margin-left: 0;
}
p + ul {
margin-left: 2em;
}
@media print {
p {
orphans: 3;
widows: 3;
}
}
</style>
</head>
<body bgcolor="#FFFFFF"
text="#000000"
link="#0000FF"
vlink="#FF0000"
alink="#FF00FF">
<!-- Title -->
<section class="outer">
<header>
<center>
<h1>
Extending<br>
<img src="../../html/images/tuxpaint-title.png"
width="205"
height="210"
alt="Tux Paint"><br>
version 0.9.28 </h1>
<p>
Copyright © 2002-2022 by various contributors; see <a href="../../AUTHORS.txt">AUTHORS.txt</a>.<br>
<a href="https://tuxpaint.org/">https://tuxpaint.org/</a>
</p>
<p>
June 4, 2022 </p>
</center>
</header>
<table border="2"
cellspacing="0"
cellpadding="2"
summary="Table of Contents"
align="center"
style="page-break-inside: avoid;">
<tr>
<th>
Table of Contents </th>
</tr>
<tr>
<td>
<ul>
<li><a href="#where_files_go">Where Files Go</a> <ul>
<li><a href="#standard_files">Standard Files</a></li> <li><a href="#personal_files">Personal Files</a></li> </ul>
</li>
<li><a href="#brushes">Brushes</a> <ul>
<li><a href="#brush_options">Brush Options</a></li> </ul>
</li>
<li><a href="#stamps">Stamps</a> <ul>
<li><a href="#stamps_images">Stamp Images</a></li> <li><a href="#description_text">Stamp Descriptive Text</a></li> <li><a href="#sound_effects">Stamp Sound Effects</a></li> <li><a href="#descriptive_sound">Stamp Descriptive Sound</a></li> <li><a href="#stamp_options">Stamp Options</a></li> <li><a href="#pre_mirroed_and_flipped_images">Pre-Mirrored and Flipped Stamps</a></li> </ul>
</li>
<li><a href="#fonts">Fonts</a></li> <li><a href="#starters">'Starters'</a> <ul>
<li><a href="#coloring_book_style">Coloring-Book Style Starters</a></li> <li><a href="#scene_style">Scene-Style Starters</a></li> </ul>
</li>
<li><a href="#templates">'Templates'</a></li> <li><a href="#translations">Translations</a></li> <li><a href="#input_methods">Alternative Input Methods</a></li> <li><a href="#on_screen_keyboard">On-screen Keyboard</a></li> </ul>
</td>
</tr>
</table>
</section>
<section class="outer">
<p>
If you wish to add or change things like Brushes, Starters, Rubber Stamps, and other content used by Tux Paint, you can do so fairly easily by simply adding, changing, or removing files where Tux Paint looks for them. </p>
<p class="note">
<span title="Information">💡</span> <strong>Note:</strong> You'll need to re-launch Tux Paint for the changes to take effect. </p>
</section>
<section class="indent outer"><!-- H1: Where Files Go -->
<header>
<h1>
<a name="where_files_go"
id="where_files_go">Where Files Go</a>
</h1>
</header>
<section class="indent"><!-- H2: Standard Files -->
<header>
<h2>
<a name="standard_files"
id="standard_files">Standard Files</a>
</h2>
</header>
<p>
Tux Paint looks for its various data files in its '<code>data</code>' directory. </p>
<dl>
<dt><strong>Linux and Unix</strong></dt>
<dd>
<p>
Where this directory goes depends on what value was set for "<code>DATA_PREFIX</code>" when Tux Paint was built. See 'Install documentation' for details. </p>
<p>
By default, though, the directory is: <blockquote>
<code>/usr/local/share/tuxpaint/</code>
</blockquote>
</p>
<p>
If you installed from a package, it is more likely to be: <blockquote>
<code>/usr/share/tuxpaint/</code>
</blockquote>
</p>
</dd>
<dt><strong>Windows</strong></dt>
<dd>
<p>
Tux Paint looks for a directory called '<code>data</code>' in the same directory as the executable. This is the directory that the installer used when installing Tux Paint e.g.: <blockquote>
<code style="white-space: nowrap;">C:\Program Files\TuxPaint\data</code>
</blockquote>
</p>
</dd>
<dt><strong>macOS</strong></dt>
<dd>
<p>
Tux Paint stores its data files inside the "Tux Paint" application icon (which is actually a special kind of folder on macOS & Mac OS X before it). The following steps explain how to get to the folders within it: </p>
<ol>
<li>
Bring up a 'context' menu by holding the <b><code>[Control]</code></b> key and clicking the Tux Paint icon the in <cite>Finder</cite>. (If you have a mouse with more than one button, you can simply right-click the icon.) </li>
<li>
Select "Show Contents" from the menu that appears. A new <cite>Finder</cite> window will appear with a folder inside called "Contents". </li>
<li>
Open the "Contents" folder and open the "Resources" folder found inside. </li>
<li>
There, you will find various sub-folders, such as "starters", "stamps", "brushes", etc. Adding new content to these folders will make the content available to any user that launches this copy (icon) of Tux Paint. </li>
</ol>
<p class="note">
<span title="Information">💡</span> <em>Note:</em> If you install a newer version of Tux Paint and replace or discard the old version, you will lose changes made by following the instructions above, so keep backups of your new content (stamps, brushes, etc.). </p>
<p>
Tux Paint also looks for files in a "TuxPaint" folder that you can place in your system's "Application Support" folder (found under "Library" at the root of your filesystem): <blockquote>
<code style="white-space: nowrap;">/Library/Application Support/TuxPaint/</code>
</blockquote>
</p>
<p>
When you upgrade to a newer version of Tux Paint, the contents of this "TuxPaint" folder will stay the same, and remain accessible by all users of Tux Paint. </p>
</dd>
</dl>
</section><!-- H2: Standard Files -->
<section class="indent"><!-- H2: Personal Files -->
<header>
<h2>
<a name="personal_files"
id="personal_files">Personal Files</a>
</h2>
</header>
<p>
You can also create brushes, stamps, 'starters', templates, and fonts in your own user account directory (folder) for Tux Paint to find. </p>
<dl>
<dt><strong>Windows</strong></dt>
<dd>
<p>
Your personal Tux Paint folder is stored in your personal "Application Data". For example, on newer Windows:
<blockquote>
<code style="white-space: nowrap;">C:\Documents and Settings\<i>(username)</i>\Application Data\TuxPaint\</code>
</blockquote>
</p>
</dd>
<dt><strong>macOS</strong></dt>
<dd>
<p>
Your personal Tux Paint folder is stored in your personal "Application Support" folder: <blockquote>
<code style= "white-space: nowrap;">/Users/<i>(username)</i>/Library/Application Support/TuxPaint/</code>
</blockquote>
</p>
</dd>
<dt><strong>Linux and Unix</strong></dt>
<dd>
<p>
Your personal Tux Paint files go into a 'hidden directory' found in your account's home directory: "<code>$(HOME)/.tuxpaint/</code>" (also known as "<code>~/.tuxpaint/</code>"). </p>
<p>
That is, if your home directory is "<code>/home/tux</code>", then your personal Tux Paint files go in "<code>/home/tux/.tuxpaint/</code>". </p>
<p>
Don't forget the period ("<code>.</code>") before the "<code>tuxpaint</code>"! </p>
</dd>
</dl>
<p>
To add your own brushes, stamps, 'starters,' templates, and fonts, create subdirectories under your personal Tux Paint directory named "<code><b>brushes</b></code>", "<code><b>stamps</b></code>", "<code><b>starters</b></code>", "<code><b>templates</b></code>", "<code><b>fonts</b></code>", respectively. </p>
<p>
(For example, if you created a brush named "<code>flower.png</code>", you would put it in "<code>~/.tuxpaint/brushes/</code>" under Linux or Unix.) </p>
</section><!-- H2: Personal Files -->
</section><!-- H1: Where Files Go -->
<section class="indent outer"><!-- H1: Brushes -->
<header>
<h1>
<a name="brushes"
id="brushes">Brushes</a>
</h1>
</header>
<p>
The brushes used for drawing with the 'Brush' and 'Lines' tools in Tux Paint are simply PNG image files. </p>
<img src="../../html/images/brush_edit.png"
width="123"
height="147"
alt=""
align="right">
<p>
The alpha (transparency) of the PNG image is used to determine the shape of the brush, which means that the shape can be 'anti-aliased' and even partially-transparent! </p>
<p>
Greyscale pixels in the brush PNG will be drawn using the currently-selected color in Tux Paint. Color pixels will be tinted. </p>
<section><!-- H2: Brush Options -->
<header>
<h2>
<a name="brush_options"
id="brush_options">Brush Options</a>
</h2>
</header>
<p>
Aside from a graphical shape, brushes can also be given other attributes. To do this, you need to create a 'data file' for the brush. </p>
<p>
A brush's data file is simply a plain ASCII text file containing the options for the brush. </p>
<p>
The file has the same name as the PNG image, but a "<code>.dat</code>" extension. (e.g., "<code>brush.png</code>"'s data file is the text file "<code>brush.dat</code>", found in the same directory.) </p>
<dl>
<dt><strong>Brush Spacing</strong></dt>
<dd>
<p>
As of Tux Paint version 0.9.16, you can now specify the spacing for brushes (that is, how often they are drawn). By default, the spacing will be the brush's height, divided by 4. </p>
<p>
Add a line containing the line "<code><b>spacing=<i>N</i></b></code>" to the brush's data file, where "<i>N</i>" is the spacing you want for the brush. (The lower the number, the more often the brush is drawn.) </p>
</dd>
<dt><strong>Animated Brushes</strong></dt>
<dd>
<p>
As of Tux Paint version 0.9.16, you may now create animated brushes. As the brush is used, each frame of the animation is drawn. </p>
<p>
Lay each frame out across a wide PNG image. For example, if your brush is 30x30 and you have 5 frames, the image should be 150x30. </p>
<p>
Add a line containing the line "<code><b>frames=<i>N</i></b></code>" to the brush's data file, where "<i>N</i>" is the number of frames in the brush. </p>
<p class="note">
<span title="Configuration option">⚙</span> <strong>Note:</strong> If you'd rather the frames be flipped through randomly, rather than sequentially, also add a line containing "<code><b>random</b></code>" to the brush's data file. </p>
</dd>
<dt><strong>Directional Brushes</strong></dt>
<dd>
<p>
As of Tux Paint version 0.9.16, you may now create directional brushes. As the brush is used, different shapes are drawn, depending on the direction the brush is going. </p>
<p>
The directional shapes are divided into a 3x3 square in a PNG image. For example, if your brush is 30x30, the image should be 90x90, and each of the direction's shapes placed in a 3x3 grid. The center region is used for no motion. The top right is used for motion that's both up, and to the right. And so on. </p>
<p>
Add a line containing the word "<code><b>directional</b></code>" to the brush's data file. </p>
</dd>
<dt><strong>Rotating Brushes</strong></dt>
<dd>
<p>
As of Tux Paint version 0.9.27, you may now create rotating brushes. As the brush is used, it is rotated 360 degrees, depending on the direction the brush is going. </p>
<p>
Add a line containing the word "<code><b>rotate</b></code>" to the brush's data file. </p>
</dd>
<dt><strong>Animated Directional or Rotating Brushes</strong></dt>
<dd>
<p>
You may mix both animated and either directional or rotating features into one brush. Use both options desired ("<code><b>frames=<i>N</i></b></code>" and "<code><b>directional</b></code>" or "<code><b>rotate</b></code>"), in separate lines in the brush's "<code>.dat</code>" file. </p>
<p>
For directional brushes, lay the brush out so that each 3x3 set of directional shapes are laid out across a wide PNG image. For example, if the brush is 30x30 and there are 5 frames, it would be 450x90. (The leftmost 150x90 pixels of the image represent the 9 direction shapes for the first frame, for example.) </p>
</dd>
</dl>
</section><!-- H2: Brush Options -->
<p>
Place the brush image PNGs (and any data text files) in the "<code><b>brushes</b></code>" directory. </p>
<p class="note">
<span title="Information">💡</span> <strong>Note:</strong> If your new brushes all come out as solid squares or rectangles, it's because you forgot to use alpha transparency! See the 'PNG documentation' in Tux Paint for more information and tips. </p>
</section><!-- H1: Brushes -->
<section class="indent outer"><!-- H1: Stamps -->
<header>
<h1>
<a name="stamps"
id="stamps">Stamps</a>
</h1>
</header>
<p>
All stamp-related files go in the "<code><b>stamps</b></code>" directory. It's useful to create subdirectories and sub-subdirectories there to organize the stamps. (For example, you can have a "<code>holidays</code>" folder with "<code>halloween</code>" and "<code>christmas</code>" sub-folders.) </p>
<section><!-- H2: Stamp Images -->
<header>
<h2>
<a name="stamps_images"
id="stamps_images">Stamp Images</a>
</h2>
</header>
<p>
Rubber Stamps in Tux Paint can be made up of a number of separate files. The one file that is required is, of course, the picture itself. </p>
<img src="../../html/images/stamp_edit.png"
width="128"
height="147"
alt=""
align="right">
<p>
As of Tux Paint version 0.9.17, Stamps may be either PNG bitmap images or SVG vector images. They can be full-color or greyscale. The alpha (transparency) channel of PNGs is used to determine the actual shape of the picture (otherwise you'll stamp a large rectangle on your drawings). </p>
<p>
PNGs can be any size, and Tux Paint (by default) provides a set of sizing buttons to let the user scale the stamp up (larger) and down (smaller). </p>
<p>
SVGs are vector-based, and will be scaled appropriately for the canvas size being used in Tux Paint. </p>
<p class="note">
<span title="Information">💡</span> <strong>Note:</strong> If your new PNG-based stamps all come out as solid squares or rectangles, it's because you forgot to use alpha transparency! See the 'PNG documentation' in Tux Paint for more information and tips. </p>
<p class="note">
<span title="Information">💡</span> <strong>Note:</strong> If your new SVG stamps seem to have a lot of whitespace, make sure the SVG 'document' is no larger than the shape(s) within. If they are being clipped, make sure the 'document' is large enough to contain the shape(s). See the 'SVG documentation' in Tux Paint for more information and tips. </p>
<p class="note">
<span title="Configuration option">⚙</span> <b>Advanced Users:</b> The 'Advanced Stamps How-To' document describes, in detail, how to make PNG images which will scale perfectly when used as stamps in Tux Paint. </p>
</section><!-- H2: Stamp Images -->
<section><!-- H2: Stamp Descriptive Text -->
<header>
<h2>
<a name="description_text"
id="description_text">Stamp Descriptive Text</a>
</h2>
</header>
<p>
Tux Paint will display descriptive text when a stamp is selected. These are placed in plain text files with the same name as the PNG or SVG, but with a "<code>.txt</code>" filename extension. (e.g., "<code>stamp.png</code>"'s description is stored in "<code>stamp.txt</code>" in the same directory.) </p>
<p>
The first line of the text file will be used as the US English description of the stamp's image. It must be encoded in UTF-8. </p>
<dl>
<dt><strong>Localization Support</strong></dt>
<dd>
<p>
Additional lines can be added to the text file to provide translations of the description, to be displayed when Tux Paint is running in a different locale (like French or Spanish). </p>
<p>
The beginning of the line should correspond to the language code of the language in question (e.g., "<code>fr</code>" for French, and "<code>zh_TW</code>" for Traditional Chinese), followed by "<code>.utf8=</code>" and the translated description (Unicode, encoded in UTF-8). </p>
<p>
<b>For Tux Paint developers:</b> There are scripts in the "<code>po</code>" directory for converting the text files to PO format (and back) for easy translation to different languages. Therefore you should never add or change translations in the "<code>.txt</code>" files directly. </p>
<p>
If no translation is available for the language Tux Paint is currently running in, the US English text is used. </p>
</dd>
<dt><strong>Windows Users</strong></dt>
<dd>
<p>
Use <cite>NotePad</cite> or <cite>WordPad</cite> to edit/create these files. Be sure to save them as plain-text, and make sure they have a "<code>.txt</code>" extension at the end of the filename. </p>
</dd>
</dl>
</section><!-- H2: Stamp Descriptive Text -->
<section><!-- H2: Stamp Sound Effects -->
<header>
<h2>
<a name="sound_effects"
id="sound_effects">Stamp Sound Effects</a>
</h2>
</header>
<p>
Tux Paint can play a sound effect when a stamp is selected. For example, the sound of a duck quaking when selecting a duck, or a brief piece of music when a musical instrument is chosen. Files may be in "WAVE ("<code>.wav</code>")" or "OGG Vorbis ("<code>.ogg</code>")" formats, and are given same name as the PNG or SVG image. (e.g., "<code>stamp.svg</code>"'s sound effect is the sound file "<code>stamp.ogg</code>" in the same directory.) </p>
<dl>
<dt><strong>Localization Support</strong></dt>
<dd>
<p>
For sounds for different locales (e.g., if the sound is someone saying a word, and you want translated versions of the word said), also create WAV or OGG files with the locale's label in the filename, in the form: "<code>stamp_LOCALE.EXT</code>" </p>
<p>
The sound effect that will be played when the stamp corresponding to the image file "<code>stamp.png</code>" is selected, and when Tux Paint is using the Spanish locale, would be "<code>stamp_es.wav</code>". Under the French locale, it would be "<code>stamp_fr.wav</code>". Under the Brazilian Portuguese locale, "<code>stamp_pt_BR.wav</code>". And so on... </p>
<p>
If no localized sound effect can be loaded, Tux Paint will attempt to load the 'default' sound file. (e.g., "<code>stamp.wav</code>") </p>
</dd>
</dl>
<p class="note">
<span title="Information">💡</span> <strong>Note:</strong> Also consider using descriptive sounds; see 'Stamp Descriptive Sound', below. </p>
</section><!-- H2: Stamp Sound Effects -->
<section><!-- H2: Stamp Descriptive Sound -->
<header>
<h2>
<a name="descriptive_sound"
id="descriptive_sound">Stamp Descriptive Sound</a>
</h2>
</header>
<p>
Tux Paint can also play a descriptive sound when a stamp is selected. For example, the sound of someone saying the word "duck" when selecting a duck, or the name of a musical instrument when one is chosen. Files may be in "WAVE ("<code>.wav</code>")" or "OGG Vorbis ("<code>.ogg</code>")" formats, and are given same name as the PNG or SVG image, with "<code>_desc</code>" at the end. (e.g., "<code>stamp.svg</code>"'s descriptive sound is the sound file "<code>stamp_desc.ogg</code>" in the same directory.) </p>
<dl>
<dt><strong>Localization Support</strong></dt>
<dd>
<p>
For descriptive sounds for different locales, also create WAV or OGG files with <em>both</em> "<code>_desc</code>" <em>and</em> the locale's label in the filename, in the form: "<code>stamp_desc_LOCALE.EXT</code>" </p>
<p>
The descriptive sound that will be played when the stamp corresponding to the image file "<code>stamp.png</code>" is selected, and when Tux Paint is using the Spanish locale, would be "<code>stamp_desc_es.wav</code>". Under the French locale, it would be "<code>stamp_desc_fr.wav</code>". Under the Brazilian Portuguese locale, "<code>stamp_desc_pt_BR.wav</code>". And so on... </p>
<p>
If no localized descriptive sound can be loaded, Tux Paint will attempt to load the 'default' sound file. (e.g., "<code>stamp_desc.wav</code>") </p>
</dd>
</dl>
</section><!-- H2: Stamp Descriptive Sound -->
<section><!-- H2: Stamp Options -->
<header>
<h2>
<a name="stamp_options"
id="stamp_options">Stamp Options</a>
</h2>
</header>
<p>
Aside from a graphical shape, a textual description, a sound effect, and a descriptive sound, stamps can also be given other attributes. To do this, you need to create a 'data file' for the stamp. </p>
<p>
A stamp's data file is simply a plain ASCII text file containing the options for the stamp. </p>
<p>
The file has the same name as the PNG or SVG image, but a "<code>.dat</code>" extension. (e.g., "<code>stamp.png</code>"'s data file is the text file "<code>stamp.dat</code>", found in the same directory.) </p>
<dl>
<dt><strong>Colored Stamps</strong></dt>
<dd>
<p>
Stamps can be made to be either "colorable" or "tintable." </p>
<dl>
<dt><strong>Colorable</strong></dt>
<dd>
<p>
"Colorable" stamps they work much like brushes - you pick the stamp to get the shape, and then pick the color you want it to be. (Symbol stamps, like the mathematical and musical ones, are an example.) </p>
<p>
Nothing about the original image is used except the transparency (from "alpha" channel). The color of the stamp comes out solid. </p>
<center>
<img src="../../html/images/ex_colorable.png"
width="74"
height="92"
alt="">
</center>
<p>
Add a line containing the word "<code><b>colorable</b></code>" to the stamp's data file. </p>
</dd>
<dt><strong>Tinted</strong></dt>
<dd>
<p>
"Tinted" stamps are similar to "colorable" ones, except the details of the original image are kept. (To put it technically, the original image is used, but its hue is changed, based on the currently-selected color.) </p>
<center>
<img src="../../html/images/ex_tintable.png"
width="151"
height="78"
alt="">
</center>
<p>
Add a line containing the word "<code><b>tintable</b></code>" to the stamp's data file. </p>
</dd>
<dt><strong>Tinting Options:</strong></dt>
<dd>
<p>
Depending on the contents of your stamp, you might want to have Tux Paint use one of a number of methods when tinting it. Add one of the following lines to the stamp's data file: </p>
<dl>
<dt>
Normal tinter — "<code><b>tinter=normal</b></code>" (the default) </dt>
<dd>
This is the normal tinting mode. First, the primary hue of the stamp is determined. (For example, a picture of a flower with a stem will have the petal color seen as the primary hue of the overall image.) Next, the most highly saturated part of the picture is found. With "normal tinter", the range of hue used to do this starts out within ±18° of the pimary hue found in step 1. (If none can be found, it widens the range by 50% and tries again.) Finally, the image is tinted. Anything falling within 50% of the range (e.g., ±27°) is altered to have the hue of the color chosen by the user. </dd>
<dt>
Narrow tinter — "<code><b>tinter=narrow</b></code>"
</dt>
<dd>
This like the "<code>normal</code>" option described above, but starts a narrower hue range of ±6°. Anything found within 50% of the range (e.g. ±9°) is tinted. If too much of your stamp is being tinted, try this option. </dd>
<dt>
'Any hue' tinter — "<code><b>tinter=anyhue</b></code>"
</dt>
<dd>
This remaps <em>all</em> hues in the stamp. It works similarly to the "<code>anyhue</code>" and "<code>narrow</code>" options described above, but the hue range is ±180°. </dd>
<dt>
Vector tinter — "<code><b>tinter=vector</b></code>"
</dt>
<dd>
This maps 'black through white' to 'black through destination'. </dd>
</dl>
</dd>
</dl>
</dd>
<dt><strong>Unalterable Stamps</strong></dt>
<dd>
<p>
By default, a stamp can be flipped upside down, shown as a mirror image, or both. This is done using the control buttons below the stamp selector, at the lower right side of the screen in Tux Paint. </p>
<p>
Sometimes, it doesn't make sense for a stamp to be flippable or mirrored; for example, stamps of letters or numbers. Sometimes stamps are symmetrical, so letting the user flip or mirror them isn't useful. </p>
<p>
To prevent a stamp from being flipped vertically, add the option "<code><b>noflip</b></code>" to the stamp's data file. </p>
<p>
To prevent a stamp from being mirrored horizontally, add the option "<code><b>nomirror</b></code>" to the stamp's data file. </p>
</dd>
<dt><strong>Initial Stamp Size</strong></dt>
<dd>
<p>
By default, Tux Paint assumes that your stamp is sized appropriately for unscaled display on a 608x472 canvas. This was the original Tux Paint canvas size, provided by a 640x480 screen. Tux Paint will then adjust the stamp according to the current canvas size and, if enabled, the user's stamp size controls. </p>
<p>
If your stamp would be too big or too small, you can specify a scale factor. If your stamp would be 2.5 times as wide (or tall) as it should be, add one of the following options, which represent the same adjustment, to the stamp's data file. (An equals sign, "<code>=</code>", may be included after the word "<code>scale</code>".) </p>
<ul>
<li>"<code><b>scale 40%</b></code>"</li>
<li>"<code><b>scale 5/2</b></code>"</li>
<li>"<code><b>scale 2.5</b></code>"</li>
<li>"<code><b>scale 2:5</b></code>"</li>
</ul>
</dd>
<dt><strong>Windows Users</strong></dt>
<dd>
<p>
Use <cite>NotePad</cite> or <cite>WordPad</cite> to edit/create these files. Be sure to save them as plain-text, and make sure they have a "<code>.txt</code>" extension at the end of the filename. </p>
</dd>
</dl>
</section><!-- H2: Stamp Options -->
<section><!-- H2: Pre-Mirrored and Flipped Stamps -->
<header>
<h2>
<a name="pre_mirroed_and_flipped_images"
id="pre_mirroed_and_flipped_images">Pre-Mirrored and Flipped Stamps</a>
</h2>
</header>
<p>
In some cases, you may wish to provide a pre-drawn version of a stamp's mirror-image, flipped image, or even both. For example, imagine a picture of a fire truck with the words "<cite>Fire Department</cite>" written across the side. You probably do not want that text to appear backwards when the image is flipped! </p>
<p>
To create a mirrored version of a stamp that you want Tux Paint to use, rather than mirroring one on its own, simply create a second "<code>.png</code>" or "<code>.svg</code>" graphics file with the same name, except with "<code><b>_mirror</b></code>" before the filename extension. </p>
<p>
For example, for the stamp "<code>stamp.png</code>" you would create another file named "<code>stamp_mirror.png</code>", which will be used when the stamp is mirrored (rather than using a backwards version of "<code>stamp.png</code>"). </p>
<p>
As of Tux Paint 0.9.18, you may similarly provide a pre-flipped image with "<code><b>_flip</b></code>" in the name, and/or an image that is both mirrored and flipped, by naming it "<code><b>_mirror_flip</b></code>". </p>
<p class="note">
<span title="Information">💡</span> <strong>Note:</strong> If the user flips and mirrors an image, and a pre-drawn "<code>_mirror_flip</code>" doesn't exist, but either "<code>_flip</code>" or "<code>_mirror</code>" does, it will be used, and mirrored or flipped, respectively. </p>
</section><!-- H2: Pre-Mirrored and Flipped Stamps -->
</section><!-- H1: Stamps -->
<section class="indent outer"><!-- H1: Fonts -->
<header>
<h1>
<a name="fonts"
id="fonts">Fonts</a>
</h1>
</header>
<img src="../../html/images/fontsizes.png"
width="48"
height="48"
alt=""
align="right">
<p>
The fonts used by Tux Paint are TrueType Fonts (TTF). </p>
<p>
Simply place them in the "<code><b>fonts</b></code>" directory. Tux Paint will load the font and provide four different sizes in the 'Letters' selector when using the 'Text' and 'Label' tools. </p>
</section><!-- H1: Fonts -->
<section class="indent outer"><!-- H1: Starters -->
<header>
<h1>
<a name="starters"
id="starters">'Starters'</a>
</h1>
</header>
<img src="../../html/images/open_open.png"
width="48"
height="48"
alt=""
align="right">
<p>
'Starter' images appear in the 'New' dialog, along with solid color background choices. </p>
<p>
When you use a 'starter' image, make modifications, and save it, the original 'starter' image is not overwritten. Additionally, as you edit your new picture, the contents of the original 'starter' can affect it. </p>
<section><!-- H2: Coloring-Book Style Starters -->
<header>
<h2>
<a name="coloring_book_style"
id="coloring_book_style">Coloring-Book Style Starters</a>
</h2>
</header>
<p>
The most basic kind of 'starter' is similar to a picture in a coloring book. It's an outline of a shape which you can then color in and add details to. In Tux Paint, as you draw, type text, or stamp stamps, the outline remains 'above' what you draw. You can erase the parts of the drawing you made, but you can't erase the outline. </p>
<p>
To create this kind of 'starter' image, simply create an outlined black and white picture in a paint program, and save it as a raster PNG file, or vector SVG. If saving as a PNG, you may optionally render the image as black-and-transparent, rather than black-and-white, but (as of Tux Paint 0.9.21) this is not required. </p>
</section><!-- H2: Coloring-Book Style Starters -->
<section><!-- H2: Scene-Style Starters -->
<header>
<h2>
<a name="scene_style"
id="scene_style">Scene-Style Starters</a>
</h2>
</header>
<p>
Along with the 'coloring-book' style overlay, you can also provide a separate background image as part of a 'starter' picture. The overlay acts the same: it can't be drawn over, erased, or affected by 'Magic' tools. However, the background can be! </p>
<p>
When the 'Eraser' tool is used on a picture based on this kind of 'starter' image, rather than turning the canvas to a solid color, such as white, it returns that part of the canvas to the original background picture from the 'starter' image. </p>
<p>
By creating both an overlay and a background, you can create a 'starter' which simulates depth. Imagine a background that shows the ocean, and an overlay that's a picture of a reef. You can then draw (or stamp) fish in the picture. They'll appear in the ocean, but never 'in front of' the reef. </p>
<p>
To create this kind of 'starter' picture, simply create an overlay (with transparency) and save it as a PNG. Then create another image (without transparency), and save it with the same filename, but with "<code>-back</code>" (short for 'background') appended to the name. (e.g., "<code>starter-back.png</code>" would be the background ocean picture that corresponds to the overlay, or foreground.) </p>
</section><!-- H2: Scene-Style Starters -->
<p>
For best results, 'starter' images should be at least the same size as Tux Paint's drawing canvas. (See the "Loading Other Pictures into Tux Paint" section of Tux Paint's main documentation (README) for details on sizing.) If they are not, they will be stretched or scaled. This is done without affecting the shape ("aspect ratio"); however some smudging may be applied to the edges. </p>
<p>
Place them in the "<code><b>starters</b></code>" directory. When the 'New' dialog is accessed in Tux Paint, the 'starter' images will appear in the screen that appears, after the various solid color choices. </p>
<p class="note">
<span title="Information">💡</span> <strong>Note:</strong> 'Starters' are 'attached' to saved pictures, via a small text file that has the same name as the saved file, but with "<code>.dat</code>" as the extension. This allows it to continue to affect the drawing even after Tux Paint has been quit, or another picture is loaded or a new image is created. (In other words, if you base a drawing on a 'starter' image, it will always be affected by it.) </p>
</section><!-- H1: Starters -->
<section class="indent outer"><!-- H1: 'Templates' -->
<header>
<h1>
<a name="templates"
id="templates">'Templates'</a>
</h1>
</header>
<img src="../../html/images/open_open.png"
width="48"
height="48"
alt=""
align="right">
<p>
'Template' images also appear in the 'New' dialog, along with solid color background choices and 'Starters'. (Note: Tux Paint prior to version 0.9.22 did not have the 'Template' feature.) </p>
<p>
Unlike pictures drawn in Tux Paint by users and then opened later, opening a 'template' creates a new drawing. When you save, the 'template' image is not overwritten. Unlike 'starters', there is no immutable 'layer' above the canvas. You may draw over any part of it. </p>
<p>
When the 'Eraser' tool is used on a picture based on this kind of 'template' image, rather than turning the canvas to a solid color, such as white, it returns that part of the canvas to the original background picture from the 'template' image. </p>
<p>
'Templates' are simply image files (in PNG, JPEG, SVG, or KPX (KidPix) format). No preparation or conversion should be required. </p>
<p>
For best results, 'template' images should be at least the same size as Tux Paint's drawing canvas. (See the "Loading Other Pictures into Tux Paint" section of Tux Paint's main documentation (README) for details on sizing.) If they are not, they will be stretched or scaled. This is done without affecting the shape ("aspect ratio"); however some smudging may be applied to the edges. </p>
<p>
Place them in the "<code><b>templates</b></code>" directory. When the 'New' dialog is accessed in Tux Paint, the 'template' images will appear in the screen that appears, after the various solid color choices. </p>
<p class="note">
<span title="Information">💡</span> <strong>Note:</strong> 'Templates' are 'attached' to saved pictures, via a small text file that has the same name as the saved file, but with "<code>.dat</code>" as the extension. This allows it to continue to affect the drawing even after Tux Paint has been quit, or another picture is loaded or a new image is created. (In other words, if you base a drawing on a 'template' image, it will always be affected by it.) </p>
<br clear="all">
</section><!-- H1: 'Templates' -->
<section class="indent outer"><!-- H1: Translations -->
<header>
<h1>
<a name="translations"
id="translations">Translations</a>
</h1>
</header>
<p>
Tux Paint supports numerous languages, thanks to use of the "gettext" localization library. (See "Options documentation" for how to change locales in Tux Paint.) </p>
<p>
To translate Tux Paint to a new language, copy the translation template file, "<code>tuxpaint.pot</code>" (found in Tux Paint's source code, in the folder "<code>src/po/</code>"). Rename the copy as a "<code>.po</code>" file, with an appropriate name for the locale you're translating to (e.g., "<code>es.po</code>" for Spanish; or "<code>pt_BR.po</code>" for Brazilian Portuguese, versus "<code>pt.po</code>" or "<code>pt_PT.po</code>" for Portuguese spoken in Portugal.) </p>
<p>
Open the newly-created "<code>.po</code>" file — you can edit in a <i>plain</i> text edtior, such as Emacs, Pico or VI on Linux, or NotePad on Windows. The original English text used in Tux Paint is listed in lines starting with "<code>msgid</code>". Enter your translations of each of these pieces of text in the empty "<code>msgstr</code>" lines directly below the corresponding "<code>msgid</code>" lines. (<i>Note:</i> Do not remove the quotes.) </p>
<p>
Example:
<blockquote>
<code>msgid "Smudge"<br>
msgstr "<u>Manchar</u>"<br>
<br>
msgid "Click and drag to draw large bricks."<br>
msgstr "<u>Haz clic y arrastra para dibujar ladrillos grandes.</u>"</code>
</blockquote>
</p>
<p>
Various tools exist to manage gettext translation catalogs, so you don't have to edit them by hand in a text editor. Here are a few: <ul>
<li><a href="http://www.poedit.net/">Poedit</a></li>
<li><a href="https://wiki.gnome.org/Apps/Gtranslator">Gtranslator (GNOME Translator)</a></li>
<li><a href="https://virtaal.translatehouse.org/">Virtraal</a></li>
<li><a href="https://apps.kde.org/en/lokalize">Lokalize</a></li>
</ul>
</p>
<p class="note">
<span title="Information">💡</span> <strong>Note:</strong> It is best to always work off of the <i>latest</i> Tux Paint text catalog template ("<code>tuxpaint.pot</code>"), since new text is added, and old text is occasionally changed. The text catalog for the upcoming, unreleased version of Tux Paint can be found in Tux Paint's Git repository (see: <a href="https://tuxpaint.org/download/source/git/">https://tuxpaint.org/download/source/git/</a>), and on the Tux Paint website at <a href="https://tuxpaint.org/help/po/">https://tuxpaint.org/help/po/</a>. </p>
<p>
To edit an existing translation, download the latest "<code>.po</code>" file for that language, and edit it as described above. </p>
<p>
You may send new or edited translation files to Bill Kendrick, lead developer of Tux Paint, at: <a href="mailto:bill@newbreedsoftware.com">bill@newbreedsoftware.com</a>, or post them to the "tuxpaint-i18n" mailing list (see: <a href="https://tuxpaint.org/lists/">https://tuxpaint.org/lists/</a>). </p>
<p>
Alternatively, if you have an account with <a href="http://www.sourceforge.net/">SourceForge.net</a>, you can request to be added to the "<code>tuxpaint</code>" project and receive write-access to the Git source code repository so that you may commit your changes directly. </p>
<p class="note">
<span title="Information">💡</span> <strong>Note:</strong> Support for new locales requires making additions to Tux Paint's source code ("<code>/src/i18n.h</code>" and "<code>/src/i18n.c</code>"), and requires updates to the <code>Makefile</code>, to ensure the "<code>.po</code>" files are compiled into "<code>.mo</code>" files, and available for use at runtime. </p>
</section><!-- H1: Translations -->
<section class="indent outer"><!-- H1: Alternative Input Methods -->
<header>
<h1>
<a name="input_methods"
id="input_methods">Alternative Input Methods</a>
</h1>
</header>
<p>
Tux Paint's 'Text' and 'Label' tools can provide alternative input methods for some languages. For example, when Tux Paint is running with a Japanese locale, the right <b><code>[Alt]</code></b> key can be pressed to cycle between Latin, Romanized Hiragana and Romanized Katakana modes. This allows native characters and words to be entered into the 'Text' and 'Label' tools by typing one or more keys on a keyboard with Latin characters (e.g., a <i>US QWERTY</i> keyboard). </p>
<p>
To create an input method for a new locale, create a text file with a name based on the locale (e.g., "<code>ja</code>" for Japanese), with "<code>.im</code>" as the extension (e.g., "<code>ja.im</code>"). </p>
<p>
The "<code>.im</code>" file can have multiple character mapping sections for different character mapping modes. For example, on a Japanese typing system, typing <b><code>[K]</code></b> <b><code>[A]</code></b> in Hiragana mode generates a different Unicode character ("か") than typing <b><code>[K]</code></b> <b><code>[A]</code></b> in Katakana mode ("カ"). </p>
<p>
List the character mappings in this file, one per line. Each line should contain (separated by whitespace): </p>
<ul>
<li>the Unicode value of the character, in hexadecimal (more than one character can be listed, separated by a colon (':'), this allowing some sequences to map to words) </li>
<li>the keycode sequence (the ASCII characters that must be entered to generate the Unicode character) </li>
<li>a flag (or "<code>-</code>" if none) </li>
</ul>
<p>
Start additional character mapping sections with a line containign the word "<code>section</code>". </p>
<p>
Example:
<blockquote>
<code># Hiragana<br>
304B ka -<br>
304C ga -<br>
304D ki -<br>
304E gi -<br>
304D:3083 kya -<br>
3063:305F tta -<br>
<br>
# Katakana<br>
section<br>
30AB ka -<br>
30AC ga -<br>
30AD ki -<br>
30AE gi -</code>
</blockquote>
</p>
<p class="note">
<span title="Configuration option">⚙</span> <strong>Note:</strong> Blank lines within the "<code>.im</code>" file will be ignored, as will any text following a "<code>#</code>" (pound/hash) character — it can be used to denote comments, as seen in the example above. </p>
<p class="note">
<span title="Information">💡</span> <strong>Note:</strong> Meanings of the flags are locale-specific, and are processed by the language-specific source code in "<code>src/im.c</code>". For example, "<code>b</code>" is used in Korean to handle Batchim, which may carry over to the next character. </p>
<p class="note">
<span title="Information">💡</span> <strong>Note:</strong> Support for new input methods requires making additions to Tux Paint's source code ("<code>/src/im.c</code>"), and requires updates to the <code>Makefile</code>, to ensure the "<code>.im</code>" files are available for use at runtime. </p>
</section><!-- H1: Alternative Input Methods -->
<section class="indent outer"><!-- H1: On-screen Keyboard -->
<header>
<h1>
<a name="on_screen_keyboard"
id="on_screen_keyboard">On-screen Keyboard</a>
</h1>
</header>
<p>
As of version 0.9.22, Tux Paint's 'Text' and 'Label' tools can present an on-screen keyboard that allows the pointer (via a mouse, eye-tracking systems, etc.) to be used to input characters. Files that describe the layout and available keys are stored in Tux Paint "<code>osk</code>" directory. Each keyboard layout is defined by a number of files (some of which may be shared by different layouts). </p>
<p>
We'll use the QWERTY keyboard as an example: </p>
<section><!-- H2: Layout overview file ("qwerty.layout") -->
<header>
<h2>
Layout overview file ("<code>qwerty.layout</code>") </h2>
</header>
<p>
This is a text file that specifies the other files used to describe the layout and key mappings. </p>
<blockquote>
<p>
<code>layout qwerty.h_layout<br>
keymap us-intl-altgr-dead-keys.keymap<br>
composemap en_US.UTF-8_Compose<br>
keysymdefs keysymdef.h<br>
keyboardlist qwerty.layout default.layout</code>
</p>
</blockquote>
<p class="note">
<span title="Configuration option">⚙</span> <strong>Note:</strong> Blank lines within the "<code>.layout</code>" file will be ignored, as will any text following a "<code>#</code>" (pound/hash) character — it can be used to denote comments, as seen in the example above. </p>
<p>
The "<code>keyboardlist</code>" line describes which layouts to switch to, when the user clicks the left and right buttons on the keyboard. (See below.) </p>
</section><!-- H2: Layout overview file ("qwerty.layout") -->
<section><!-- H2: Keyboard layout file ("qwerty.h_layout") -->
<header>
<h2>
Keyboard layout file ("<code>qwerty.h_layout</code>") </h2>
</header>
<p>
This describes how big the keyboard is (as a "width × height" grid), and lists each key with its numeric keycode (see the "<code>keymap</code>" file, below), the width it should be drawn at (typically "<code>1.0</code>", to take one space on the keyboard, but in the example below, notice the "<code>TAB</code>" and "<code>SPACE</code>" keys are much wider), the character or text to display on the key, depending on which modifier keys have been pressed (one each for: no modifiers, <b><code>[Shift]</code></b>, <b><code>[AltGr]</code></b>, and <b><code>[Shift]</code></b> + <b><code>[AltGr]</code></b>), and finally whether or not the key is affected by the <b><code>[CapsLock]</code></b> key (use "<code>1</code>") or <b><code>[AltGr]</code></b> (alternate graphics) key (use "<code>2</code>"), or not at all (use "<code>0</code>"). </p>
<blockquote>
<p>
<code>WIDTH 15<br>
HEIGHT 5<br>
<br>
KEY 49 1.0 ` ~ ` ~ 0<br>
KEY 10 1.0 1 ! ¡ ¹ 0<br>
KEY 11 1.0 2 @ ² ˝ 0<br>
KEY 12 1.0 3 # · ³ 0<br>
KEY 13 1.0 4 $ ¤ £ 0<br>
KEY 14 1.0 5 % € ¸ 0<br>
KEY 15 1.0 6 ^ ¼ ^ 0<br>
...<br>
KEY 21 1.0 = + × ÷ 0<br>
KEY 22 2.0 DELETE DELETE DELETE DELETE 0<br>
<br>
NEWLINE<br>
<br>
KEY 23 1.5 TAB TAB TAB TAB 0<br>
KEY 24 1.0 q Q ä Ä 1<br>
KEY 25 1.0 w W å Å 1<br>
KEY 26 1.0 e E é É 1<br>
KEY 27 1.0 r R ® ® 1<br>
...<br>
<br>
NEWLINE<br>
<br>
# Arrow to left will change to the previous keyboard<br>
KEY 2 1.0 <- <- <- <- 0<br>
<br>
KEY 133 2.0 Cmp Cmp Cmp Cmp 0<br>
<br>
# The ALT or ALTGR keys are used in im to switch the input mode<br>
KEY 64 2.0 Alt Alt Alt Alt 0<br>
<br>
# Space<br>
KEY 65 7.0 SPACE SPACE SPACE SPACE 0<br>
<br>
KEY 108 2.0 AltGr AltGr AltGr AltGr 0<br>
<br>
# Arrow to right will change to the next keyboard<br>
KEY 1 1.0 -> -> -> -> 0</code>
</p>
</blockquote>
<p>
Notice here that alphabetic keys (<b><code>[Q]</code></b>, <b><code>[W]</code></b>, etc.) will be affected by <b>[CapsLock]</b>, while numeric keys (<b><code>[1]</code></b>, <b><code>[2]</code></b>, etc.), <b><code>[Space]</code></b>, and so on, will not. </p>
<p>
Keycodes up to "<code>8</code>" are reserved for internal use. The ones currently used are described below. </p>
<ul>
<li>
<code>0</code> —
empty button </li>
<li>
<code>1</code> —
next layout (per the layout file's "<code>keyboardlist</code>" setting) </li>
<li>
<code>2</code> —
previous layout (per the layout file's "<code>keyboardlist</code>" setting) </li>
</ul>
</section><!-- H2: Keyboard layout file ("qwerty.h_layout") -->
<section><!-- H2: Keymap file ("us-intl-altgr-dead-keys.keymap") -->
<header>
<h2>
Keymap file ("<code>us-intl-altgr-dead-keys.keymap</code>") </h2>
</header>
<p>
This file defines which numeric keycodes (seen in the keyboard layout files, such as "<code>qwerty.h_layout</code>" described above) should be mapped to which actual characters that an application such as Tux Paint expects to receive when keys (e.g., on a real keyboard) are pressed. </p>
<p>
If you're using an operating system such as <cite>Linux</cite>, which runs <cite>X-Window</cite> and has the "<code>xmodmap</code>" command-line tool available, you can run it with the ("print keymap expressions" option, "<code>-pke</code>", to generate a keymap file. </p>
<blockquote>
<p>
<code>keycode 9 = Escape NoSymbol Escape Escape<br>
keycode 10 = 1 exclam exclamdown onesuperior 1 exclam 1
exclam NoSymbol onesuperior<br>
keycode 11 = 2 at twosuperior dead_doubleacute 2 at 2
at onehalf twosuperior<br>
keycode 12 = 3 numbersign periodcentered threesuperior
dead_macron periodcentered<br>
...<br>
keycode 52 = z Z ae AE Arabic_hamzaonyeh asciitilde
guillemotright NoSymbol Greek_zeta Greek_ZETA U037D
U03FF<br>
keycode 53 = x X x X Arabic_hamza Arabic_sukun
guillemotleft NoSymbol Greek_chi Greek_CHI rightarrow
leftarrow<br>
keycode 54 = c C copyright cent Arabic_hamzaonwaw
braceright Greek_psi Greek_PSI copyright<br>
keycode 55 = v V v V Arabic_ra braceleft Greek_omega
Greek_OMEGA U03D6<br>
keycode 56 = b B b B UFEFB UFEF5 Greek_beta Greek_BETA
U03D0<br>
keycode 57 = n N ntilde Ntilde Arabic_alefmaksura
Arabic_maddaonalef Greek_nu Greek_NU U0374 U0375<br>
keycode 58 = m M mu mu Arabic_tehmarbuta apostrophe
Greek_mu Greek_MU U03FB U03FA<br>
keycode 59 = comma less ccedilla Ccedilla Arabic_waw
comma comma less guillemotleft<br>
keycode 60 = period greater dead_abovedot dead_caron
Arabic_zain period period greater guillemotright
periodcentered<br>
keycode 61 = slash question questiondown dead_hook
Arabic_zah Arabic_question_mark slash question<br>
keycode 62 = Shift_R NoSymbol Shift_R Shift_R<br>
...<br></code>
</p>
</blockquote>
</section><!-- H2: Keymap file ("us-intl-altgr-dead-keys.keymap") -->
<section><!-- H2: Composemap file ("en_US.UTF-8_Compose") -->
<header>
<h2>
Composemap file ("<code>en_US.UTF-8_Compose</code>") </h2>
</header>
<p>
This file describes single characters that can be composed by multiple inputs. For example, "<b><code>[Compose]</code></b>" followed by "<b><code>[A]</code></b>" and "<b><code>[E]</code></b>" can be used to create the "<code>æ</code>" character. </p>
<p>
The file that comes with Tux Paint is based on the US English UTF-8 (Unicode) composemap that comes with X.Org's <cite>X Window system</cite>. The current version from the <cite>Xlib</cite> library has a web located page at <a href="https://www.x.org/releases/current/doc/libX11/i18n/compose/en_US.UTF-8.html">https://www.x.org/releases/current/doc/libX11/i18n/compose/en_US.UTF-8.html</a>. </p>
</section><!-- H2: Composemap file ("en_US.UTF-8_Compose") -->
<section><!-- H2: Keysym definitions file ("keysymdef.h") -->
<header>
<h2>
Keysym definitions file ("<code>keysymdef.h</code>") </h2>
</header>
<p>
This file (which is a <cite>C</cite> programming language header file) is also from the <cite>X Window System</cite>. It defines the Unicode values of each keycap (e.g., "<code>XK_equal</code>" corresponds to "<code>U+003D</code>", for the character "<code>=</code>" ("<code>EQUALS SIGN</code>"). </p>
<p class="note">
<span title="Information">💡</span> <strong>Note:</strong> This file is not compiled into Tux Paint, but is read and parsed at runtime. </p>
<p>
It is unlikely that any modification will be required of this file. </p>
</section><!-- H2: Keysym definitions file ("keysymdef.h") -->
</section><!-- H1: On-screen Keyboard -->
</body>
</html>
|
