Debian Codegraph @

texmf-dist/doc/latex/pixelarttikz/pixelarttikz-l3-doc.tex

raw
1 \documentclass[english,parskip=half-,paper=a4]{scrartcl}
2 \usepackage[margin=1.5cm,includeheadfoot]{geometry}
3 \RequirePackage[default]{lato}
4 \RequirePackage[math-style=french,bold-style=ISO]{lete-sans-math}
5 \setsansfont{Fira Sans}[Scale=MatchLowercase]
6 \setmonofont{CascadiaMono-Light}[Scale=MatchLowercase]
7
8 \usepackage{pixelarttikz-l3}
9
10 \usepackage{babel}
11 \usepackage{enumitem}
12 \usepackage{couleurs-fr}
13
14 \usepackage{minted-code}
15 \usepackage{hologo}
16 \usepackage{fancyvrb}
17 \usepackage{xcolor,url}
18 \usepackage[colorlinks]{hyperref}
19 \setlength\parindent{0pt}
20
21 \def\Lcs#1{\texttt{\textbackslash#1}\index{#1@\texttt{\textbackslash#1}}}
22 \def\Largb#1{\texttt{\{}\textit{#1}\texttt{\}}}
23 \def\Lpack#1{\texttt{#1}\index{#1@\texttt{#1}}\index{Package!#1@\texttt{#1}}}
24 \def\Loption#1{\texttt{#1}\index{#1@\texttt{#1}}\index{Option!#1@\texttt{#1}}}
25
26 \def\pixlartcolorskoala{%french version :-p
27 A=VertForet,
28 B=Noir,
29 C=GrisClair,
30 D=GrisFonce,
31 E=Beige,
32 F=Blanc,
33 G=BleuClair,
34 H=VertClair,
35 I=Marron
36 }
37
38 \subtitle{pixelart, with Ti\textit{k}Z and \hologo{LaTeX3}}
39 \title{pixelarttikz-l3 (0.1.9)}
40 \date{October 20, 2025}
41 \author{Cédric Pierquet\thanks{\protect\url{[email protected]}}}
42 \raggedbottom
43
44 \begin{document}
45
46 \maketitle
47
48 \tableofcontents
49
50 \vfill
51
52 \hfill%
53 \pixlarttikz[unit=0.2,text size=0.875]{\pixlartcolorskoala}{PAkoala.csv}~~
54 \pixlarttikz[unit=0.2,correction]{\pixlartcolorskoala}{PAkoala.csv}%
55 \hfill\null
56
57 \vspace*{5mm}
58
59 \pagebreak
60
61 \section{Introduction}
62
63 \subsection{Loading}
64
65 To use \Lpack{pixelarttikz-l3}, simply use:
66
67 \begin{codeblock}[title=Loading (only l3)]
68 \usepackage{pixelarttikz-l3}
69 \end{codeblock}
70
71 \begin{codeblock}[title=Loading (l3 and l2)]
72 \usepackage[legacy]{pixelarttikz-l3} %with latex2e version of package and macros
73 \end{codeblock}
74
75 \subsection{Idea(s)}
76
77 The idea behind this package is to provide a command for manipulating pixelarts, with a simplified syntax.
78
79 \smallskip
80
81 The basis of the macro is a \texttt{csv} file, which can be external file, or with internal generated version.
82
83 \smallskip
84
85 For \textit{huge} pixelarts, \hologo{LuaLaTeX} is necessary for compiling !
86
87 \subsection{First example(s)}
88
89 \begin{codeblock}[title=File csv sample]
90 \begin{filecontents*}[overwrite]{base.csv}
91 A,B,C,D
92 A,B,D,C
93 B,A,D,C
94 C,A,B,D
95 \end{filecontents*}
96 \end{codeblock}
97
98 \begin{exampleM}{}
99 \pixlarttikz%with letters
100 {A,B,C,D}
101 {base.csv}
102 \pixlarttikz[correction]%with colors
103 {A=green,B=blue,C=orange,D=pink}%
104 {base.csv}
105 \pixlarttikz[correction,borders=false]%with colors w/o borders
106 {A=green,B=blue,C=orange,D=pink}%
107 {base.csv}
108
109 \pixlarttikz[symbols]%with symbols
110 {A=12,B=-5,C=4,D=0}
111 {base.csv}
112 \pixlarttikz[symbols,text size=0.875]%with symbols and custom scale
113 {A=12,B=-5,C=4,D=0}
114 {base.csv}
115 \pixlarttikz[symbols]%with random symbols
116 {A=1§2§3§4,B=5§6§7§8,C=9§10§11§12,D=13§14§15§16}
117 {base.csv}
118 \end{exampleM}
119
120 \pagebreak
121
122 \section{Global usage}
123
124 \subsection{Main macro}
125
126 The main macro is:
127
128 \begin{codeblock}[title=Main macro]
129 \pixlarttikz%
130 [keys]%
131 <tikzpicture options>%
132 {letters association}%
133 {file.csv}
134 \end{codeblock}
135
136 Available keys are:
137
138 \begin{itemize}[noitemsep]
139 \item the key \Loption{unit} to specify unit, in cm;\hfill{}default \Loption{1}
140 \item the boolean \Loption{codes} to display codes;\hfill{}default \Loption{true}
141 \item the boolean \Loption{correction} to color the pixlart;\hfill{}default \Loption{false}
142 \item the boolean \Loption{symbols} to print the symbols (one or shuffle within list);\hfill{}default \Loption{false}
143 \item the boolean \Loption{borders} to print borders of the cells;\hfill{}default \Loption{true}
144 \item the key \Loption{font} for the font of codes/symbols;\hfill{}default \Loption{\textbackslash sffamily}
145 \item the key \Loption{cut} for cutting usage;\hfill{}default \Loption{empty}
146 \item the key \Loption{text size} for adapting height automatically.\hfill{}default \Loption{0.55}
147 \end{itemize}
148
149 The \Loption{cut} key can be given within the form:
150 %
151 \begin{itemize}
152 \item \Loption{<number of block length>x<number of block col>} to specify the size of the blocks;
153 \item \Loption{<number of V blocks>+<number of H blocks>} to specify the number of blocks.
154 \end{itemize}
155
156 \subsection{Macro for individual block}
157
158 The macro for individual block is (keys are identical of main macro):
159
160 \begin{codeblock}[title=Individual block]
161 \pixlarttikzblock%
162 [keys]%
163 <tikzpicture options>%
164 {letters association}%
165 {block number r/c}%
166 {file.csv}
167 \end{codeblock}
168
169 \pagebreak
170
171 \subsection{Sample}
172
173 \begin{codeblock}[title=Useful data]
174 \begin{filecontents*}[overwrite]{PAkoala.csv}
175 A,A,A,A,A,A,A,H,H,H,A,A,A,A,A,H,H,H,A,A,A,A,A,A,A,A,A,H,H,H,H,A,A,H,A,A,A,A,A,A
176 A,A,A,A,A,A,A,A,H,A,A,A,A,A,A,H,H,A,A,A,A,A,A,A,A,A,A,H,A,A,A,A,A,H,A,A,A,A,A,A
177 A,A,A,H,A,A,A,A,A,A,A,A,A,A,A,H,H,A,A,A,A,A,A,A,A,H,H,H,A,A,A,A,A,A,A,A,A,A,A,A
178 A,A,A,A,A,A,A,B,E,E,E,E,A,A,A,A,A,A,A,A,A,A,A,H,H,H,A,B,B,E,E,E,E,B,A,A,A,A,A,H
179 A,A,H,A,A,A,A,B,E,E,E,E,E,A,A,A,A,A,A,A,A,A,A,H,H,H,B,E,E,E,E,E,E,B,B,A,A,A,A,H
180 A,A,H,A,A,B,B,E,C,C,C,C,C,E,B,B,B,E,E,E,E,E,E,B,B,B,E,C,C,C,C,C,C,E,B,B,H,H,A,A
181 A,A,H,A,B,E,D,D,D,D,B,D,C,C,E,E,E,E,C,C,C,C,E,E,E,E,E,C,D,B,B,D,D,D,E,B,H,A,A,A
182 A,A,A,A,B,E,D,D,F,F,D,B,D,C,C,E,C,C,C,C,C,C,C,C,E,C,C,D,B,D,D,F,F,D,E,B,A,A,A,H
183 A,A,A,B,C,D,D,F,F,F,D,D,B,B,C,C,C,C,C,C,C,C,C,C,C,C,C,B,D,D,D,F,F,D,D,C,B,A,H,H
184 A,A,A,B,C,D,F,F,F,F,F,D,D,D,C,C,C,C,C,C,C,C,C,C,C,C,C,D,D,F,F,F,F,F,D,C,B,A,H,H
185 A,A,A,B,D,D,F,F,F,F,F,D,C,C,C,C,C,C,C,C,C,C,C,C,C,C,C,C,D,F,F,F,F,F,D,D,B,A,A,H
186 A,A,A,B,D,D,G,F,F,F,F,D,C,C,B,B,B,C,C,B,B,C,C,B,B,B,C,C,D,F,F,F,F,G,D,D,B,A,A,A
187 A,A,A,A,B,G,G,F,F,F,F,D,C,C,B,F,B,C,B,D,D,B,C,B,F,B,C,C,D,G,F,F,F,G,G,B,H,A,A,A
188 A,A,A,A,A,B,G,G,G,F,G,D,C,C,C,B,B,C,B,D,D,B,C,B,B,C,C,C,D,G,G,F,G,G,B,H,H,H,A,A
189 A,A,A,A,A,A,B,G,G,G,G,B,C,C,C,C,C,C,B,B,B,B,C,C,C,C,C,C,D,B,G,G,G,G,B,H,H,H,A,A
190 A,A,A,A,A,A,A,B,B,B,B,B,C,C,C,C,C,C,B,B,B,B,C,C,C,C,C,C,D,B,B,B,B,B,A,A,H,H,A,A
191 A,A,A,A,A,A,A,A,A,A,A,D,D,C,C,C,C,F,B,B,B,B,F,C,C,C,C,D,D,A,A,A,A,A,A,A,A,A,A,A
192 A,A,A,A,A,A,A,A,A,A,A,B,D,D,C,C,C,F,F,B,B,F,F,C,C,C,D,D,B,A,A,A,A,A,A,A,A,A,A,A
193 A,A,A,A,A,H,H,H,A,A,A,A,B,B,D,C,C,F,F,F,F,F,F,C,C,D,B,B,A,A,A,A,A,A,H,H,H,A,A,A
194 A,A,A,A,H,H,H,H,A,A,A,A,B,B,D,D,D,G,G,G,G,G,G,D,D,D,D,B,A,A,A,A,A,A,A,H,H,H,A,A
195 A,A,A,A,H,H,H,A,A,A,A,B,D,D,D,D,D,G,G,G,G,G,G,D,D,D,D,D,B,A,A,A,A,A,A,A,H,H,A,A
196 A,A,A,H,A,A,A,A,A,A,B,C,D,D,D,G,G,G,D,D,D,D,G,G,G,D,D,D,C,B,A,H,H,A,A,A,A,H,A,A
197 A,A,A,H,H,A,A,A,A,A,D,C,C,C,D,G,G,F,G,D,D,G,F,G,G,D,D,C,C,C,B,A,H,H,A,A,A,A,A,A
198 A,A,A,A,A,H,H,H,H,B,D,D,C,C,D,G,G,F,F,F,F,F,F,G,G,D,D,C,C,D,B,A,A,H,H,A,A,A,A,A
199 A,A,A,A,A,A,A,A,A,B,D,D,C,C,C,C,C,B,F,F,F,F,F,B,C,C,C,C,D,D,B,A,A,H,H,H,H,A,A,A
200 A,A,A,H,H,A,A,A,A,B,D,D,C,C,C,C,C,C,B,F,F,F,B,C,C,C,C,C,D,D,B,A,A,A,A,H,H,A,A,A
201 A,A,A,A,A,A,A,A,A,A,B,B,D,D,C,C,C,C,C,B,F,B,C,C,C,C,D,D,B,B,A,A,A,H,H,A,A,A,A,A
202 A,A,A,A,A,A,A,A,A,A,B,B,B,D,D,C,C,C,C,B,F,B,C,C,C,C,D,B,B,B,A,A,A,H,H,A,A,A,A,A
203 A,A,A,A,A,A,A,A,A,B,C,C,C,B,B,D,D,D,D,B,F,B,D,D,D,B,B,D,C,C,B,A,A,A,H,A,A,A,A,A
204 A,A,A,A,A,A,A,A,B,C,C,C,C,C,D,B,B,B,F,F,F,F,B,B,B,D,D,C,C,C,C,B,A,A,A,A,A,A,H,H
205 A,A,A,A,A,A,A,A,B,C,C,C,C,C,D,D,D,G,G,F,F,G,G,D,D,D,D,C,C,C,C,B,A,A,A,A,A,A,H,H
206 A,A,A,A,A,A,A,I,B,D,C,C,C,C,C,C,C,G,G,F,F,G,G,C,C,C,C,C,C,C,D,B,I,A,A,A,A,A,A,A
207 A,A,A,A,A,A,A,I,B,D,D,D,C,C,C,B,B,B,G,G,G,G,B,B,B,C,C,C,D,D,D,B,I,A,A,A,A,A,A,A
208 A,A,A,A,A,H,A,I,I,B,D,D,D,D,D,C,C,C,B,D,D,B,C,C,C,C,D,D,D,B,B,I,I,A,A,A,A,A,A,A
209 A,A,A,A,A,H,H,H,I,B,B,D,D,D,D,D,C,C,B,D,D,B,C,C,C,D,D,D,D,B,I,I,A,A,A,A,A,A,A,A
210 A,A,H,H,H,A,A,A,I,I,I,B,B,B,D,B,B,B,B,B,B,B,B,B,B,D,B,B,B,I,I,I,A,A,A,A,A,A,H,A
211 A,A,H,H,H,A,A,A,A,I,I,I,B,B,B,B,B,B,B,B,B,B,B,B,B,B,B,B,I,I,I,A,A,A,A,A,A,A,H,A
212 H,H,A,H,H,A,A,A,A,A,A,I,I,I,I,I,I,I,I,I,I,I,I,I,I,I,I,I,I,I,A,A,A,A,A,A,A,A,A,A
213 A,A,A,A,A,A,A,A,A,A,A,A,A,A,A,I,I,I,I,I,I,I,I,I,A,A,A,A,A,A,A,A,A,A,A,H,A,A,A,A
214 A,A,A,A,A,A,A,A,A,A,A,A,H,H,A,A,A,A,A,A,A,A,A,A,A,A,A,A,A,A,A,A,A,A,H,H,A,A,A,A
215 \end{filecontents*}
216
217 \def\pixlartcolorskoala{%french version :-p
218 A=VertForet,
219 B=Noir,
220 C=GrisClair,
221 D=GrisFonce,
222 E=Beige,
223 F=Blanc,
224 G=BleuClair,
225 H=VertClair,
226 I=Marron
227 }
228 \end{codeblock}
229
230 \pagebreak
231
232 \begin{exampleM}{}
233 \tikzset{pixlartcut/.style={semithick,blue}}
234 \pixlarttikz%
235 [unit=0.2,cut=8x8,text size=0.875]%
236 {A,B,C,D,E,F,G,H,I,J}%
237 {PAkoala.csv}
238
239 \pixlarttikz%
240 [unit=0.2,cut=8x8,correction]%
241 {\pixlartcolorskoala}%
242 {PAkoala.csv}
243 \end{exampleM}
244
245 \pagebreak
246
247 \begin{exampleM}{}
248 \tikzset{pixlartborder/.style={thin}}
249
250 \pixlarttikzblock%
251 [unit=0.75,cut=5+5,text size=0.9,font=\ttfamily]%
252 {A,B,C,D,E,F,G,H,I,J}%
253 {1/1}%first block
254 {PAkoala.csv}
255 \pixlarttikzblock%
256 [unit=0.75,cut=5+5,correction]%
257 {\pixlartcolorskoala}%
258 {1/1}%first block, correction
259 {PAkoala.csv}
260
261 \pixlarttikzblock%
262 [unit=0.75,cut=5+5,text size=0.9,font=\ttfamily]%
263 {A,B,C,D,E,F,G,H,I,J}%
264 {2/3}%intermediate block R2&C3
265 {PAkoala.csv}
266 \pixlarttikzblock%
267 [unit=0.75,cut=8x8,correction]%
268 {\pixlartcolorskoala}%
269 {2/3}%intermediate block R2&C3, correction
270 {PAkoala.csv}
271 \end{exampleM}
272
273 \pagebreak
274
275 \section{History}
276
277 \texttt{0.1.9: first version of l3 package}
278
279 \end{document}
280