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