1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml">
3  <head>
4    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5    <meta http-equiv="Content-Style-Type" content="text/css" />
6    <title>ctr_FontConverterConsole</title>
7    <style type="text/css">
8    <!--
9    body {
10    /*
11        font-size       : 10pt;
12    */
13        font-weight     : normal;
14        color           : #000000;
15        margin          : 8px;
16    }
17
18    div {
19        width           : 98%;
20        white-space     : nowrap;
21    }
22
23    div.title {
24        text-align      : left;
25        font-weight     : bold;
26    /*
27        font-size       : 16pt;
28    */
29        font-size       : 150%;
30        color           : #202020;
31        border-style    : double;
32        border-width    : 8px;
33        /* タイトルを囲む枠線の色を指定 */
34        border-color    : #FF6600;
35
36        /* RVLプラットフォーム系列 */
37    /*
38        border-color    : #34beed;
39    */
40
41        /* TWLプラットフォーム系列 */
42    /*
43        border-color    : #ff458f;
44    */
45
46        margin          : 4px;
47        padding         : 4px;
48    }
49    H1 {
50      font-size         : 150%;
51      font-family               : Arial;
52      border-bottom-width       : 5px;
53      border-bottom-style       : solid;
54      border-bottom-color       : #FF6600;
55      padding-bottom            : 1px;
56      margin-bottom             : 20px;
57      letter-spacing            : normal;
58      font-weight               : bold;
59    }
60
61    h2 {
62        font-weight     : bold;
63    /*
64        font-size       : 16pt;
65    */
66        font-size       : 150%;
67        border-style    : none none solid double;
68        border-width    : 0px 0px 2px 8px;
69        /* 見出しの線の色を指定 */
70        border-color    : #FF6600;
71
72        /* RVLプラットフォーム系列 */
73    /*
74        border-color    : #34beed;
75    */
76
77        /* TWLプラットフォーム系列 */
78    /*
79        border-color    : #ff458f;
80    */
81
82        margin-left     : 2px;
83        padding-left    : 4px;
84    }
85    CODE {
86      font-family               : "Courier New", monospace;
87      position          : normal;
88      left                      : 12px;
89      font-size         : 10pt;
90    }
91    table {
92      margin-top        : 2pt;
93      margin-bottom     : 2pt;
94      margin-left       : 0pt;
95      margin-right      : 0pt;
96      padding-left      : 0pt;
97      padding-right     : 0pt;
98      position          : relative;
99      left              : 12px;
100      font-family       : Arial;
101      font-size         : 10pt;
102      border-style      : none none none none;
103    }
104    td,th {
105      padding           : 2pt;
106      border-width      : 2pt;
107      border-style      : none none none none;
108      font-style        : normal;
109      text-align        : left;
110    }
111    td {
112      background        : #e8f4f4;
113      font-weight       : normal;
114    }
115    th {
116      background        : #c0d8d8;
117      font-weight       : bold;
118    }
119
120    p {
121        margin-left     : 4px;
122    }
123    p.code {
124      font-family               : "Courier New", monospace;
125      position          : normal;
126      left                      : 12px;
127      font-size         : 10pt;
128      background            : #e8f4f4;
129    }
130
131    -->
132    </style>
133
134  </head>
135  <body>
136    <h1>ctr_FontConverterConsole</h1>
137    <h2>Description</h2>
138    <p>
139      The ctr_FontConverterConsole tool can be used to display any font installed on a PC as text on CTR.
140    </p>
141    <p>
142      ctr_FontConverterConsole is a command line version of ctr_FontConverter (hereafter referred to as the &quot;GUI version&quot;). Other than differences in the interface, functionality is equivalent to the GUI version. This tool is intended for use in Makefiles and batchfiles.
143    </p>
144    <h2>Font Licenses</h2>
145    <p>
146      ctr_FontConverterConsole can convert any font installed on a PC for use on the CTR. However, a user license may be required to use such fonts in game software that will be sold. Acquire the appropriate licenses for each game application. ctr_FontConverterConsole and CTR SDK do not include font licenses of any kind.
147    </p>
148    <h2>How to Use</h2>
149    <h3>Command</h3>
150
151    <p class="code">
152      ctr_FontConverterConsole.exe -i &lt;input format&gt; &lt;input option&gt; -o &lt;output format&gt; &lt;output option&gt; [‑f &lt;character filter file path&gt;]
153    </p>
154    <p>
155      As shown in , -i, -o, and -f are used to specify input, output, and filter options, respectively.
156    </p>
157    <p>
158      &lt;input option&gt; and &lt;output option&gt; change based on the specifications for &lt;input format&gt; and &lt;output format&gt;, respectively. These elements are discussed in subsequent sections.
159    </p>
160    <p>
161      Enclose elements that contain spaces between words with quotation marks (&quot;). (Example &quot;parameter with spaces&quot;.) Quotation marks cannot be used inside of quotation marks.
162    </p>
163
164    <h4>Input options</h4>
165    <p>
166      Use the following options with &lt;input option&gt; according to the &lt;input format&gt;.
167    </p>
168
169    <h5>Input: Image (-i image)</h5>
170    <p>
171      <table class="table"><tbody>
172        <tr>
173          <th>Options</th><th>Omittability</th><th>Comments</th>
174        </tr>
175        <tr>
176          <td>-if &lt;image file path&gt;</td><td>Impossible</td><td></td>
177        </tr>
178        <tr>
179          <td>-io &lt;letter order file path&gt;</td><td>Impossible</td><td></td>
180        </tr>
181        <tr>
182          <td>-ic &lt;color format&gt;</td><td>Impossible</td>
183          <td>
184            Specify one of the following for &lt;color format&gt;: A4, A8, LA4, LA8, RGB565, RGB5A1, RGBA4, RGB8, or RGBA8.
185          </td>
186        </tr>
187        <tr>
188          <td>-ia</td><td>Possible</td>
189          <td>
190            Executes linear interpolation countermeasure processing if specified.
191          </td>
192        </tr>
193      </tbody></table>
194    </p>
195    <p>
196      <B>Example:</B>
197    </p>
198    <p class="code">
199      -i image -if font.bmp -io xlor/cp1252.xlor -ic LA8
200    </p>
201    <p>
202      As shown above, the BMP file font.bmp will be read as input according to the letter order file xlor/cp1252.xlor. The BMP color will be interpreted using LA8 format.
203    </p>
204
205    <h5>Input: bcfnt (-i bcfnt)</h5>
206    <p>
207      <table class="table"><tbody>
208        <tr>
209          <th>Options</th><th>Omittability</th><th>Comments</th>
210        </tr>
211        <tr>
212          <td>-if &lt;font file path&gt;</td><td>Impossible</td>
213          <td>
214            Specifies a bcfnt or bcfna file.
215          </td>
216        </tr>
217      </tbody></table>
218    </p>
219    <p>
220      <B>Example:</B>
221    </p>
222    <p class="code">
223      -i bcfnt -if font.bcfnt
224    </p>
225    <p>
226      Accepts the bcfnt file named font.bcfnt as input.
227    </p>
228
229    <h5>Input: Windows フォント (-i win)</h5>
230    <p>
231      <table class="table"><tbody>
232        <tr>
233          <th>Options</th><th>Omittability</th><th>Comments</th>
234        </tr>
235        <tr>
236          <td>-in &lt;font name&gt;</td><td>Impossible</td><td></td>
237        </tr>
238        <tr>
239          <td>-is &lt;font size&gt;</td><td>Impossible</td>
240          <td>
241            The conversion source font size in pixel units.
242          </td>
243        </tr>
244        <tr>
245          <td>-isw &lt;average witdh&gt;</td><td>Possible</td>
246          <td>
247            Specifies the average width in pixels. The aspect ratio can be changed by making this specification.
248          </td>
249        </tr>
250        <tr>
251          <td>-ic &lt;number of gradations&gt;</td><td>Impossible</td>
252          <td>
253            Specify any one of A1 through LA6 given below for &lt;number of gradations&gt;. A8 or LA8 format results when the texture format used to output the bcfnt is 64 levels. A4 or LA4 results in all other cases.<br/>
254            <table>
255              <tbody>
256                <tr><th>Alpha</th><th>2 levels</th><th>16 levels</th><th>64 levels</th></tr>
257                <tr><td>Alpha only</td><td>A1</td><td>A4</td><td>A6</td></tr>
258                <tr><td>Luminosity and alpha</td><td>LA1</td><td>LA4</td><td>LA6</td></tr>
259              </tbody>
260            </table>
261          </td>
262        </tr>
263        <tr>
264          <td>-ia</td><td>Possible</td>
265          <td>
266            Output using software anti-aliasing if specified.
267          </td>
268        </tr>
269        <tr>
270          <td>-it &lt;character width&gt;</td><td>Possible</td>
271          <td>
272            Specify one of the following for &lt;character width&gt;. If omitted, char is assumed.<BR>
273            <table>
274              <tbody>
275                <tr><th>Character Width</th><th>Description</th></tr>
276                <tr><td>glyph</td><td>Uses the glyph width as the character width.</td></tr>
277                <tr>
278                  <td>keepsp</td>
279                  <td>
280                    The character width specified for the font is used for spaces, while the glyph width is used as the character width in all other cases.
281                  </td>
282                </tr>
283                <tr><td>char</td><td>Uses the character width specified for the font.</td></tr>
284                <tr><td>fixed</td><td>Uses the same width for all characters.</td></tr>
285              </tbody>
286            </table>
287          </td>
288        </tr>
289        <tr>
290          <td>-iw &lt;monospace width&gt;</td><td>Possible/Impossible</td>
291          <td>
292            Required when -it fixed is specified. Invalid in all other cases.
293          </td>
294        </tr>
295      </tbody></table>
296    </p>
297    <p>
298      <B>Example:</B>
299    </p>
300    <p class="code">
301      -i win -in &quot;MS Gothic&quot; -is 16 -ib 4 -it glyph
302    </p>
303    <p>
304      Data is loaded using Windows MS Gothic font with a size of 16 pixels and 64 gradations alpha only (=A6). The glyph width is used for the character width.
305    </p>
306
307    <h4>Output options</h4>
308    <p>
309      The following options can be used with &lt;output option&gt;, according to the &lt;output format&gt;.
310    </p>
311
312    <h5>Output: Image (-o image)</h5>
313    <p>
314      <table class="table"><tbody>
315        <tr>
316          <th>Options</th><th>Omittability</th><th>Comments</th>
317        </tr>
318        <tr>
319          <td>-of &lt;image file path&gt;</td><td>Impossible</td>
320          <td>
321            Unlike the GUI version, the command line version does nothing if the image format and file extension do not match. Output is made using the specified file name.
322          </td>
323        </tr>
324        <tr>
325          <td>-oo &lt;letter order file path&gt;</td><td>Impossible</td><td></td>
326        </tr>
327        <tr>
328          <td>-oi &lt;image format&gt;</td><td>Possible</td>
329          <td>
330            Specifies the image file format to be output. Specify one of the following for &lt;image format&gt;. If omitted, ext is assumed.
331            <table>
332              <tbody>
333                <tr><th>Image format</th><th>Description</th></tr>
334                <tr><td>ext</td><td>Determines the format based on the image file extension.</td></tr>
335                <tr><td>BMP</td><td>Ouput is made in BMP format.</td></tr>
336                <tr><td>tga</td><td>Ouput is made in TGA format.</td></tr>
337              </tbody>
338            </table>
339          </td>
340        </tr>
341        <tr>
342          <td>-og</td><td>Possible</td>
343          <td>
344            No grid if specified.
345          </td>
346        </tr>
347        <tr>
348          <td>-ow &lt;cell width&gt;</td><td>Possible</td>
349          <td>
350            The default specifies a width sufficient for output. Cannot be specified concurrently with -or or -ob.
351          </td>
352        </tr>
353        <tr>
354          <td>-oh &lt;cell height&gt;</td><td>Possible</td>
355          <td>
356            The default specifies a height sufficient for output. Cannot be specified concurrently with -or or -ob.
357          </td>
358        </tr>
359        <tr>
360          <td>-ol &lt;cell left margin width&gt;</td><td>Possible</td>
361          <td>
362            The default is 0.
363          </td>
364        </tr>
365        <tr>
366          <td>-or &lt;cell right margin width&gt;</td><td>Possible</td>
367          <td>
368            The default specifies the same value as -ol. Cannot be specified concurrently with -ow or -oh.
369          </td>
370        </tr>
371        <tr>
372          <td>-ot &lt;cell top margin width&gt;</td><td>Possible</td>
373          <td>
374            The default is 0.
375          </td>
376        </tr>
377        <tr>
378          <td>-ob &lt;cell bottom margin width&gt;</td><td>Possible</td>
379          <td>
380            If omitted, the same value as specified for -ot is assumed. Cannot be specified concurrently with -ow or -oh.
381          </td>
382        </tr>
383        <tr>
384          <td>-ocg &lt;grid color&gt;</td><td>Possible</td>
385          <td>
386            Specifies the color as a 6-digit hexadecimal. Treated as 000000 if omitted.
387          </td>
388        </tr>
389        <tr>
390          <td>-ocm &lt;margin color&gt;</td><td>Possible</td>
391          <td>
392            Specifies the color as a 6-digit hexadecimal. Treated as 99AA99 if omitted.
393          </td>
394        </tr>
395        <tr>
396          <td>-ocw &lt;width line color&gt;</td><td>Possible</td>
397          <td>
398            Specifies the color as a 6-digit hexadecimal. Treated as FF0000 if omitted.
399          </td>
400        </tr>
401        <tr>
402          <td>-ocn &lt;null color&gt;</td><td>Possible</td>
403          <td>
404            Specifies the color as a 6-digit hexadecimal. Treated as FF7F7F if omitted.
405          </td>
406        </tr>
407      </tbody></table>
408    </p>
409    <p>
410      <B>Example:</B>
411    </p>
412    <p class="code">
413      -o image -of font.bmp -oo xlor/cp1252.xlor -og -ol 1 -ot 3
414    </p>
415    <p>
416      The above specifications apply a 1 pixel margin to the left and right and a 3 pixel margin to the top and bottom of each cell according to the letter order file xlor/cp1252.cxlor.
417    </p>
418
419    <h5>Output: bcfnt (-o bcfnt)</h5>
420    <p>
421      <table class="table"><tbody>
422        <tr>
423          <th>Options</th><th>Omittability</th><th>Comments</th>
424        </tr>
425        <tr>
426          <td>-oe &lt;character code&gt;</td><td>Possible</td>
427          <td>
428            Specify one of the following for &lt;character code&gt;. If omitted, unicode is assumed.<BR>
429            <table>
430              <tbody>
431                <tr><th>Character Codes</th><th>Description</th></tr>
432                <tr><td>unicode</td><td>Specifies Unicode.</td></tr>
433                <tr><td>sjis</td><td>Specifies ShiftJIS.</td></tr>
434                <tr><td>cp1252</td><td>Specifies a CP1252.</td></tr>
435              </tbody>
436            </table>
437          </td>
438        </tr>
439        <tr>
440          <td>-op &lt;glyph group file&gt;</td><td>Possible</td>
441          <td>
442            No grouping (no compression) if omitted.
443          </td>
444        </tr>
445        <tr>
446          <td>-os &lt;sheet size&gt;</td><td>Possible</td>
447          <td>
448            Specifies the sheet size as a number of pixels in units of 1000's of pixels. A power of two greater than or equal to 16 and less than or equal to 1024 must be specified for &lt;sheet size&gt;. Sheet size is determined automatically if omitted.
449          </td>
450        </tr>
451        <tr>
452          <td>-oa &lt;alternate character&gt;</td><td>Possible</td>
453          <td>
454            The default is based on the input.
455          </td>
456        </tr>
457        <tr>
458          <td>-oh &lt;line feed width&gt;</td><td>Possible</td>
459          <td>
460            The default is based on the input.
461          </td>
462        </tr>
463        <tr>
464          <td>-ol &lt;default left space&gt;</td><td>Possible</td>
465          <td>
466            The default is based on the input.
467          </td>
468        </tr>
469        <tr>
470          <td>-ow &lt;default glyph width&gt;</td><td>Possible</td>
471          <td>
472            The default is based on the input.
473          </td>
474        </tr>
475        <tr>
476          <td>-or &lt;default right space&gt;</td><td>Possible</td>
477          <td>
478            The default is based on the input.
479          </td>
480        </tr>
481      </tbody></table>
482    </p>
483    <p>
484      <B>Example:</B>
485    </p>
486    <p class="code">
487      -o bcfnt -of font.bcfnt -os 256 -oe sjis -oa ?
488    </p>
489    <p>
490      Outputs data to font.bcfnt using a sheet size of 256K pixels, Shift_JIS encoding and ’?’ as the substitute character.
491    </p>
492
493    <h2>Revision History</h2>
494    <dl class="history">
495      <dt>2010/09/14</dt>
496      <dd>Initial version.</dd>
497    </dl>
498  <hr><p>CONFIDENTIAL</p></body>
499</html>
500