1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 2<html> 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_makebanner</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 : #CD202C; 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 : #CD202C; 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 : #CD202C; 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<a name="top"></a> 137 138<h1><CODE>ctr_makebanner</CODE></h1> 139 140<h1>Table of Contents</h1> 141<ol> 142 <li><a href="#intro">Introduction</a></li> 143 <li><a href="#usage">How to Use</a></li> 144 <li><a href="#bsf">BSF</a></li> 145 <li><a href="#character">List of Characters Allowed in Title Names and Publisher Names</a></li> 146 <li><a href="#restrict">Data Restrictions</a></li> 147 <li><a href="#omake">Variables Defined In OMakefile</a></li> 148 <li><a href="#history">Revision History</a></li> 149</ol> 150 151 152 153<h2><a name="intro">Introduction</a></h2> 154<p><CODE>ctr_makebanner</CODE> is a tool for creating BNR (ctr BaNneR model data) and ICN (ctr ICoN data).<br /> BNR and ICN files are generated based on the content in banner spec files (BSF).</p> 155 <p>BNR files contain banner model data and sound data. ICN files contain banner headers and 2D icon data. </p> 156 157<h2><a name="usage">How to Use</a></h2> 158<h3>What's Required</h3> 159<p>You will need the following to create BNR and ICN files:</p> 160<ul> 161<li> A CBMD file containing banner model data created using <CODE>ctr_BannerModelConverter</CODE></li> 162<li> A CTPK file for large and small icons generated by <CODE>ctr_TexturePackager</CODE>, or an NW4C TGA file for large and small icons created by the NW4C plug-in. 163</li> 164<li> A BCWAV file containing banner sound data created using <CODE>ctr_WaveConverter</CODE></li> 165<li> BSF</li> 166</ul> 167 168<p> 169 BSF files contain the information required to create BNR and ICN files. They must be created individually for each application.<br /> 170</p> 171 172<h3>Commands</h3> 173 174 175<p class="code"> 176 % ctr_makebanner32 [-d] BANNERSPECFILE [BANNERFILE] [ICONFILE]<br /> % ctr_makebanner32 [-d] -noicn BANNERSPECFILE [BANNERFILE]<br /> % ctr_makebanner32 [-d] -nobnr BANNERSPECFILE [ICONFILE]</p> 177 178<p class="first_ja">You must specify <CODE>BANNERSPECFILE</CODE> (the BSF file). All other options are optional.</p> 179 180<h4 >Options</h4> 181 182 183<div class="table"> 184<table border="1"> 185<thead> 186<tr> 187<th align="center">Options</th> 188<th align="center">Description</th> 189</tr> 190</thead> 191<tbody> 192<tr> 193<td align="center"><CODE>-noicn</CODE></td> 194<td align="center">Does not output ICN files.</td> 195</tr> 196<tr> 197<td align="center"><CODE>-nobnr</CODE></td> 198<td align="center">Does not output BNR files.</td> 199</tr> 200<tr> 201<td align="center"><code>-d</code></td> 202<td align="center">Provides detailed output for debugging.</td> 203</tr> 204<tr> 205<td align="center"><CODE>BANNERFILE</CODE></td> 206<td align="center">Specifies a BNR file. If omitted, the output file will have the same basename as the BSF file used as input, but will have a file extension of <CODE>.bnr</CODE> instead of <CODE>.bsf</CODE>.</td> 207</tr> 208<tr> 209<td align="center"><CODE>ICONFILE</CODE></td> 210<td align="center">Specifies an ICN file. If omitted, the output file will have the same basename as the BSF file used as input, but will have a file extension of <CODE>.icn</CODE> instead of <CODE>.bsf</CODE>.</td> 211</tr> 212</tbody> 213</table> 214</div> 215 216<h2><a name="bsf">BSF</a></h2> 217 218<p>This file contains the settings for the BNR and ICN files to be generated.<br /> It must be coded and saved in Unicode (UTF-16LE with BOM). <br /> Notepad in Microsoft Windows 2000, Windows XP, Windows Vista, and Windows 7 supports Unicode. <br />Select <B>Unicode</B> from the <B>Encoding</B> drop-down list when saving the file. </p> 219 220<h3>Parameters</h3> 221 222<p>The delimiter between parameter specifications and values is a colon (<code>:</code>). If the same parameter occurs more than once, the instance written last in the file is used.</p> 223 224<h3>Format</h3> 225 226<p>Parameter specifications must come at the beginning of each line.<br /> All characters after a "#" are treated as a comment.<BR> Space and tab characters at the beginning and ending of the value are ignored. All other spaces are included in the string. If you want to include leading spaces or if you want to include quotation marks (<CODE>"</CODE>), "#" symbols, or colons (<CODE>:</CODE>) in the string, surround the string with quotation marks (<code>""</code>). 227</p> 228 229 230<h3>Format</h3> 231 232<p>The BSF file format is shown below.</p> 233 234<p class="code"> 235 BigIconFile: # 48x48-pixel icon filename<br /> 236 237 LittleIconFile: # 24x24-pixel icon filename<br /> 238 239 ModelFile: # Banner model filename<br /> 240 241 SoundFile: # Sound filename<br /> <br /> 242 243 JoinGameId: # Join-in game ID<br /> 244 245 JoinGameModeMask: # Join-in game mode mask<br /> CecUniqueId: # StreetPass unique ID<br /> <br /> 246 247 Region: # Card region<br /> <br /> 248 249 Ulcd: # Stereoscopic vision flag<br /> 250 251 AgreeEula: # EULA agreement required flag<br /> 252 253 AutoSave: # Auto save flag<br /> 254 255 ExBanner: # Extended banner use flag<br /> 256 257 SaveData: # Save data use flag<br /> <br /> 258 259 ThumbnailFrame: # Banner animation best frame<br /> <br /> 260 261 JPLongName: # Title name displayed on two lines (Japanese)<br /> ENLongName: # Title name displayed on two lines (English)<br /> FRLongName: # Title name displayed on two lines (French)<br /> GELongName: # Title name displayed on two lines (German)<br /> ITLongName: # Title name displayed on two lines (Italian)<br /> SPLongName: # Title name displayed on two lines (Spanish)<br /> DULongName: # Title name displayed on two lines (Dutch)<br /> POLongName: # Title name displayed on two lines (Portuguese)<br /> RULongName: # Title name displayed on two lines (Russian)<br /> CNLongName: # Title name displayed on two lines (Simplified Chinese) <B>Note</B>: For this item only, characters are restricted to a maximum of 108 characters.<br /> See the detailed description below.<br />KRLongName: # Title name displayed on two lines (Korean)<br /> TWLongName: # Title name displayed on two lines (Traditional Chinese)<br /> <br /> 262 263 JPShortName: # Title name displayed on one line (Japanese)<br /> ENShortName: # Title name displayed on one line (English)<br /> FRShortName: # Title name displayed on one line (French)<br /> GEShortName: # Title name displayed on one line (German)<br /> ITShortName: # Title name displayed on one line (Italian)<br /> SPShortName: # Title name displayed on one line (Spanish)<br /> DUShortName: # Title name displayed on one line (Dutch)<br /> POShortName: # Title name displayed on one line (Portuguese)<br /> RUShortName: # Title name displayed on one line (Russian)<br /> CNShortName: # Title name displayed on one line (Simplified Chinese)<br /> KRShortName: # Title name displayed on one line (Korean)<br /> TWShortName: # Title name displayed on one line (Traditional Chinese)<br /> <br /> 264 265 JPPublisher: # Publisher name (Japanese)<br /> ENPublisher: # Publisher name (English)<br /> FRPublisher: # Publisher name (French)<br /> GEPublisher: # Publisher name (German)<br /> ITPublisher: # Publisher name (Italian)<br /> SPPublisher: # Publisher name (Spanish)<br />DUPublisher: # Publisher name (Dutch)<br />POPublisher: # Publisher name (Portuguese)<br />RUPublisher: # Publisher name (Russian)<br />CNPublisher: # Publisher name (Simplified Chinese)<br /> KRPublisher: # Publisher name (Korean)<br /> TWPublisher: # Publisher name (Traditional Chinese)<br /> <br /> 266 267 RatingRequired: # Rating flag<br /> <br /> 268 269 CERO: # CERO rating (Japan)<br /> 270 271 ESRB: # ESRB rating (Americas)<br /> 272 273 USK: # USK rating (Europe)<br /> 274 275 PEGI_GEN: # PEGI rating (Required for titles sold in Europe outside of Portugal and the United Kingdom)<br /> 276 277 PEGI_PRT: # PEGI rating (Required for titles sold in Portugal)<br /> 278 279 PEGI_BBFC: # PEGI and BBFC ratings ((Required for titles sold in United Kingdom)<br /> 280 281 COB: # COB rating (Australia)<br /> 282 283 GRB: # GRB rating (Korea)<br /> 284 285 CGSRR: # CGSRR rating (Taiwan)<br /> <br /> 286 287 ISBN: # ISBN number (Required only in Chinese region. <B>Note</B>: There are exceptions. See the ISBN item below)<br /> 288 289 HTDJH: # Contract Registration Number (Required only in Chinese region. <B>Note</B>: There are exceptions. See the ISBN section later in this document.)<br /> 290 291 XCSZ_L: # GAPP Number (Required only in Chinese region. <B>Note</B>: There are exceptions. See the ISBN section later in this document.)<br /> 292 293 XCSZ_R: # Gapp Number (Required only in Chinese region. <B>Note</B>: There are exceptions. See the ISBN item below)<br /><br /> 294 295</p> 296 297<p> 298 Set the values using the following format: 299</p> 300 301<h3>Specifying Single Values</h3> 302 Specify single values as follows: 303<p class="code"> 304 Key Name: Value 305</p> 306 Use the following notation for two-line text, such as long title names.<BR> Although Unicode includes several characters that indicate a newline, use CR LF (0x00d 0x000a) for line breaks.<BR> The newline code entered when using Notepad included in Microsoft Windows 2000, XP, Vista, and 7 is okay as is. 307<p class="code"> 308 Key Name Value Line 1<BR>Value Line 2</p> 309 310<p> 311BSF files contain the information required to create BNR and ICN files. They must be created individually for each application.<br /> 312</p> 313 314<h4>Notes</h4> 315<ul> 316<li>There are limitations on the characters available for use in title names and publisher names in various regions. (Described later.)</li> 317<br /><br /> 318<li><B>Note:</B> Do not enter unnecessary strings or other dummy text in the title names of languages not supported by your title. Even if those languages are not supported in your region(s), the title names in those languages might be displayed by (for example) system applications in other regions. (If you leave such title names empty, the English title name will be displayed.)</li> 319</ul> 320 321 Descriptions of the settings for each of these items are shown below. 322<div class="table"> 323<table border="1"> 324<thead> 325<tr> 326<th align="center">Item</th> 327<th align="center">Description</th> 328<th align="center">Comments</th> 329</tr> 330</thead> 331<tbody> 332 333<tr> 334<td align="center"><CODE>BigIconFile</CODE></td> 335<td align="center">A 48x48-pixel icon filename. Specifies an icon filename as a file path.<BR> Either a relative or absolute path to the <CODE>.bsf</CODE> file may be used.<BR> Specify a TGA file created by the NW4C plug-in (48*48 RGB 565, no mipmap) or a 48*48 CTPK file (CTR icon package) created by the CTR-SDK <CODE>TexturePackager</CODE> with the <CODE>-dsl</CODE> option.</td> 336<td align="center">You must select the <B>For Layout</B> check box in the plug-in dialog box to save a 48*48 TGA file.<br /><br /> There is a bug where a few pixels of the top centers of large icons do not appear correctly in some built-in applications. See Known Issues (posted on WarioWorld) for details about workarounds.</td> 337</tr> 338 339<tr> 340<td align="center"><CODE>LittleIconFile</CODE></td> 341<td align="center">A 24x24-pixel icon filename. Specifies an icon filename as a file path.<br /> Either a relative or absolute path to the <CODE>.bsf</CODE> file may be used.<br /> Specify a TGA file created by the NW4C plug-in (24*24 RGB 565, no mipmap) or a 24*24 CTPK file (CTR icon package) created by the CTR-SDK <CODE>TexturePackager</CODE> with the <CODE>-dsl</CODE> option.</td> 342<td align="center">You must select the <B>For Layout</B> check box in the plug-in dialog box when saving a 24*24 TGA file.</td> 343</tr> 344 345<tr> 346<td align="center"><CODE>ModelFile</CODE></td> 347<td align="center">Specifies a banner model filename.<BR> Specify a <CODE>.cbmd</CODE> file that was created using <CODE>BannerModelConverter</CODE>, included in the CTR-SDK.<br /> Either a relative or absolute path to the <CODE>.bsf</CODE> file may be used. 348</td> 349<td align="center"></td> 350</tr> 351 352<tr> 353<td align="center"><CODE>SoundFile</CODE></td> 354<td align="center">Specifies a sound filename.<BR> Specify a <CODE>.bcwav</CODE> file that was created using <CODE>WaveConverter</CODE>, included in the CTR-SDK.<br /> Either a relative or absolute path to the <CODE>.bsf</CODE> file may be used. 355</td> 356<td align="center"></td> 357</tr> 358 359<tr> 360<td align="center"><CODE>JoinGameId</CODE></td> 361<td align="center">The matchmaking game ID.<BR> This information is to identify game titles that support online features.<br /> Specify as an 8-digit hexadecimal value. A prefix indicating hexadecimal notation (such as <CODE>0x</CODE> or <CODE>h</CODE>) is not required.</td> 362<td align="center"></td> 363</tr> 364 365<tr> 366<td align="center"><CODE>JoinGameModeMask</CODE></td> 367<td align="center">The matchmaking game mode mask.<BR> Specify as a 16-digit hexadecimal value. A prefix indicating hexadecimal notation (such as <CODE>0x</CODE> or <CODE>h</CODE>) is not required.</td> 368<td align="center"></td> 369</tr> 370<tr> 371<td align="center"><CODE>CecUniqueId</CODE></td> 372<td align="center">The StreetPass unique ID.<br /> Specify as a 6-digit hexadecimal value. A prefix indicating hexadecimal notation (such as <CODE>0x</CODE> or <CODE>&h</CODE>) is not required. When there is newly arrived data for the StreetPass box for the unique ID specified here, an update indicator is displayed on the application icon displayed in the HOME Menu.<br /> You must generally specify the application's unique ID, but you can instead specify a different unique ID for StreetPass between multiple applications, such as between different versions of the same application or between applications in a series.</td> 373<td align="center"></td> 374</tr> 375 376<tr> 377<td align="center"><CODE>Region</CODE></td> 378<td align="center">Indicates the card region. Software runs only when this matches the console's region. The following strings can be specified.<br /> <CODE>Japan</CODE> Japan<br /> <CODE>America</CODE> The Americas<br /> <CODE>Europe</CODE> Europe and Australia<br /> <CODE>China</CODE> China<br /> <CODE>Korea</CODE> Korea<br /> <CODE>Taiwan</CODE> Taiwan and Hong Kong<br /> <CODE>All</CODE> Unrestricted. (For debug use only. Not available for submitted ROMs.)<br /> 379 </td> 380<td align="center"></td> 381</tr> 382 383<tr> 384<td align="center"><CODE>Ulcd</CODE></td> 385<td align="center">Be sure to specify <CODE>true</CODE> for applications that can use stereoscopic vision. Specify either <CODE>true</CODE> or <CODE>false</CODE>.<br /> This flag is used as a determinant when 3D screen display is restricted in Parental Controls. 386</td> 387<td align="center">Default: <CODE>true</CODE></td> 388</tr> 389 390<tr> 391<td align="center"><CODE>AgreeEula</CODE></td> 392<td align="center">Specify <CODE>true</CODE> for applications that require Internet communication features or StreetPass to advance. Specify either <CODE>TRUE</CODE> or <CODE>FALSE</CODE>.<br /> When the application is launched before the EULA has been agreed to, the HOME Menu first seeks user agreement to the EULA. 393</td> 394<td align="center">Default: <CODE>false</CODE></td> 395</tr> 396 397<tr> 398<td align="center"><CODE>AutoSave</CODE></td> 399<td align="center">Specify <CODE>true</CODE> for applications that always auto-save when exiting the application.<BR>The warning message that appears when exiting an application from the HOME Menu changes depending on this flag. <CODE>True</CODE> --- Exits without displaying message. (But if another application has been launched, this message displays: <I>Would you like to close this software? (Data will be saved.)</I>)<BR><CODE>False</CODE> --- This message displays: <I>Would you like to close this software? (Anything not saved will be lost.)</I><br />Specify either <CODE>true</CODE> or <CODE>false</CODE>. An auto-save is performed when the application exits, but if not all data will be saved at such times, decide whether to specify <CODE>true</CODE> or <CODE>false</CODE> based on what you think users expect to be saved at such times. 400</td> 401<td align="center">Default: <CODE>false</CODE></td> 402</tr> 403 404<tr> 405<td align="center"><CODE>ExBanner</CODE></td> 406<td align="center">Be sure to specify <CODE>true</CODE> for applications that use extended banners. Specify either <CODE>true</CODE> or <CODE>false</CODE>.</td> 407<td align="center">Default: <CODE>false</CODE></td> 408</tr> 409 410<tr> 411<td align="center"><CODE>SaveData</CODE></td> 412<td align="center">Be sure to specify <CODE>true</CODE> for applications that use save data, extended save data, etc.<BR> With this flag, when terminating the application from the HOME Menu<br /> let the user know that auto save occurs and that the save data will be deleted.<br /> Specify either <CODE>true</CODE> or <CODE>false</CODE>.</td> 413<td align="center">Default: <CODE>true</CODE></td> 414</tr> 415 416<tr> 417<td align="center"><CODE>ThumbnailFrame</CODE></td> 418<td align="center">Represents a representative frame of the banner animation. Specify a value greater than 0 and less than 600.<br /> Be sure to specify the most representative frame in the banner. Specify as a floating point number.<br /> <B>Note:</B> Used for displaying a stopped (static) banner. (Details to be decided.)</td> 419<td align="center"></td> 420</tr> 421 422<tr> 423<td align="center"></td> 424<td align="center"> </td> 425<td align="center"></td> 426</tr> 427 428<tr> 429<td align="center"><CODE>JPLongName</CODE></td> 430<td align="center">This is the Japanese title, displayed on two lines.<BR> Specify using a newline between the two lines. Leading spaces are ignored in this case.<br /> There are restrictions on character widths. For this region, each line can hold up to 16 double-byte characters plus the width equivalent to 3 sinlge-byte (ASCII) "i" characters.<br /> The restriction on the number of characters is a maximum of 128 characters (including the newline and the terminator) on these two lines.<br /> Only use one line if text can fit on one line.</td> 431<td align="center">Required for Japanese region.</td> 432 433</tr> 434 435<tr> 436<td align="center"><CODE>ENLongName</CODE></td> 437<td align="center">This is the English title, displayed on two lines.<br /> This item is required for every application in every region. If your application has no English title, configure this item with its title in one of the languages it does support.<br /> Everything else is the same as above.</td> 438<td align="center">Required for all regions.</td> 439</tr> 440 441<tr> 442<td align="center"><CODE>FRLongName</CODE></td> 443<td align="center">This is the French title, displayed on two lines. Everything else is the same as above.</td> 444<td align="center"></td> 445</tr> 446 447<tr> 448<td align="center"><CODE>GELongName</CODE></td> 449<td align="center">This is the German title, displayed on two lines. Everything else is the same as above.</td> 450<td align="center"></td> 451</tr> 452 453<tr> 454<td align="center"><CODE>ITLongName</CODE></td> 455<td align="center">This is the Italian title, displayed on two lines. Everything else is the same as above.</td> 456<td align="center"></td> 457</tr> 458 459<tr> 460<td align="center"><CODE>SPLongName</CODE></td> 461<td align="center">This is the Spanish title, displayed on two lines. Everything else is the same as above.</td> 462<td align="center"></td> 463</tr> 464 465<tr> 466<td align="center"><CODE>DULongName</CODE></td> 467<td align="center">This is the Dutch title, displayed on two lines. Everything else is the same as above.</td> 468<td align="center"></td> 469</tr> 470 471<tr> 472<td align="center"><CODE>POLongName</CODE></td> 473<td align="center">This is the Portuguese title, displayed on two lines. Everything else is the same as above.</td> 474<td align="center"></td> 475</tr> 476 477<tr> 478<td align="center"><CODE>RULongName</CODE></td> 479<td align="center">This is the Russian title, displayed on two lines. Everything else is the same as above.</td> 480<td align="center"></td> 481</tr> 482 483<tr> 484<td align="center">KRLongName</td> 485<td align="center">This is the Korean title, displayed on two lines. Everything else is the same as above.</td> 486<td align="center">Required for Korean region.</td> 487</tr> 488 489<tr> 490<td align="center">TWLongName</td> 491<td align="center">This is the Chinese title in traditional Chinese, displayed on two lines. Everything else is the same as above.</td> 492<td align="center">Required for Taiwan/Hong Kong region</td> 493</tr> 494 495<tr> 496<td align="center">CNLongName</td> 497<td align="center">This is the Chinese title in simplified Chinese, displayed on two lines.<br /> <B>Note</B>: ISBN and other information are embedded at the end of the title name in a region 20 characters in size. So for this item only, characters are restricted to a maximum 108 characters.</td> 498<td align="center">Required for Chinese region.</td> 499</tr> 500 501<tr> 502<td align="center"> </td> 503<td align="center"></td> 504<td align="center"></td> 505</tr> 506 507<tr> 508<td align="center"><CODE>JPShortName</CODE></td> 509<td align="center">Indicates a one-line display title name in Japanese.<br /> There is a restriction on character width. It should fit within the width of 17 double-byte characters.<br /> The restriction on the number of characters allows for up to 64 characters (including newlines and a null terminator) to be used.<br /> Either enter enough on one of the two lines to distinguish the title or omit some of the two lines of text.<br /> If you just can't make the short title fit one line, add an ellipsis (...) at the end to indicate the title has been cut off in the middle.</td> 510<td align="center">Required for Japanese region.</td> 511</tr> 512 513<tr> 514<td align="center"><CODE>ENShortName</CODE></td> 515<td align="center">This is the English title, displayed on one line.<br /> This item is required for every application in every region. If your application has no English title, configure this item with its title in one of the languages it does support.<br /> Everything else is the same as above.</td> 516<td align="center">Required for all regions.</td> 517</tr> 518 519<tr> 520<td align="center"><CODE>FRShortName</CODE></td> 521<td align="center">This is the French title, displayed on one line. Everything else is the same as above.</td> 522<td align="center"></td> 523</tr> 524 525<tr> 526<td align="center"><CODE>GEShortName</CODE></td> 527<td align="center">This is the German title, displayed on one line. Everything else is the same as above.</td> 528<td align="center"></td> 529</tr> 530 531<tr> 532<td align="center"><CODE>ITShortName</CODE></td> 533<td align="center">This is the Italian title, displayed on one line. Everything else is the same as above.</td> 534<td align="center"></td> 535</tr> 536 537<tr> 538<td align="center"><CODE>SPShortName</CODE></td> 539<td align="center">This is the Spanish title, displayed on one line. Everything else is the same as above.</td> 540<td align="center"></td> 541</tr> 542 543<tr> 544<td align="center"><CODE>DUShortName</CODE></td> 545<td align="center">This is the Dutch title, displayed on one line. Everything else is the same as above.</td> 546<td align="center"></td> 547</tr> 548 549<tr> 550<td align="center"><CODE>POShortName</CODE></td> 551<td align="center">This is the Portuguese title, displayed on one line. Everything else is the same as above.</td> 552<td align="center"></td> 553</tr> 554 555<tr> 556<td align="center"><CODE>RUShortName</CODE></td> 557<td align="center">This is the Russian title, displayed on one line. Everything else is the same as above.</td> 558<td align="center"></td> 559</tr> 560 561<tr> 562<td align="center">KRShortName</td> 563<td align="center">This is the Korean title, displayed on one line. Everything else is the same as above.</td> 564<td align="center">Required for Korean region.</td> 565</tr> 566 567<tr> 568<td align="center">TWShortName</td> 569<td align="center">This is the Chinese title in traditional Chinese, displayed on one line. Everything else is the same as above.</td> 570<td align="center">Required for Taiwan/Hong Kong region</td> 571</tr> 572 573<tr> 574<td align="center">CNShortName</td> 575<td align="center">This is the Chinese title in simplified Chinese, displayed on one line. Everything else is the same as above.</td> 576<td align="center">Required for Chinese region.</td> 577</tr> 578 579<tr> 580<td align="center"> </td> 581<td align="center"></td> 582<td align="center"></td> 583</tr> 584 585<tr> 586<td align="center"><CODE>JPPublisher</CODE></td> 587<td align="center">Indicates the Japanese publisher name.<br /> There is a restriction on character width. It should fit within the width of 17 double-byte characters.<br /> The restriction on the number of characters allows for up to 64 characters (including newlines and a null terminator) to be used.</td> 588<td align="center">Required for Japanese region.</td> 589</tr> 590 591<tr> 592<td align="center"><CODE>ENPublisher</CODE></td> 593<td align="center">Indicates the English publisher name. Everything else is the same as above.</td> 594<td align="center">Required for all regions.</td> 595</tr> 596 597<tr> 598<td align="center"><CODE>FRPublisher</CODE></td> 599<td align="center">Indicates the French publisher name. Everything else is the same as above.</td> 600<td align="center"></td> 601</tr> 602 603<tr> 604<td align="center"><CODE>GEPublisher</CODE></td> 605<td align="center">Indicates the German publisher name. Everything else is the same as above.</td> 606<td align="center"></td> 607</tr> 608 609<tr> 610<td align="center"><CODE>ITPublisher</CODE></td> 611<td align="center">Indicates the Italian publisher name. Everything else is the same as above.</td> 612<td align="center"></td> 613</tr> 614 615<tr> 616<td align="center"><CODE>SPPublisher</CODE></td> 617<td align="center">Indicates the Spanish publisher name. Everything else is the same as above.</td> 618<td align="center"></td> 619</tr> 620 621<tr> 622<td align="center"><CODE>DUPublisher</CODE></td> 623<td align="center">Indicates the Dutch publisher name. Everything else is the same as above.</td> 624<td align="center"></td> 625</tr> 626 627<tr> 628<td align="center"><CODE>POPublisher</CODE></td> 629<td align="center">Indicates the Portuguese publisher name. Everything else is the same as above.</td> 630<td align="center"></td> 631</tr> 632 633<tr> 634<td align="center"><CODE>RUPublisher</CODE></td> 635<td align="center">Indicates the Russian publisher name. Everything else is the same as above.</td> 636<td align="center"></td> 637</tr> 638 639<tr> 640<td align="center">KRPublisher</td> 641<td align="center">Indicates the Korean publisher name. Everything else is the same as above.</td> 642<td align="center">Required for Korean region.</td> 643</tr> 644 645<tr> 646<td align="center">TWPublisher</td> 647<td align="center">Indicates the Chinese publisher name in traditional Chinese. Everything else is the same as above.</td> 648<td align="center">Required for Taiwan/Hong Kong region</td> 649</tr> 650 651<tr> 652<td align="center">CNPublisher</td> 653<td align="center">Indicates the Chinese publisher name in simplified Chinese. Everything else is the same as above.</td> 654<td align="center">Required for Chinese region.</td> 655</tr> 656 657<tr> 658<td align="center"> </td> 659<td align="center"></td> 660<td align="center"></td> 661</tr> 662 663 664<tr> 665<td align="center"><CODE>RatingRequired</CODE></td> 666<td align="center">Specifies whether a rating must be obtained for the application.<br /> Specify <CODE>true</CODE> for almost all applications. If <CODE>false</CODE> is specified, no ratings can be set from any rating organization.<BR> Specify either <CODE>true</CODE> or <CODE>false</CODE>.</td> 667<td align="center">Default: <CODE>true</CODE></td> 668</tr> 669 670<tr> 671<td align="center"><CODE>CERO</CODE></td> 672<td align="center">Sets the CERO rating (Japan). Specify as a numeric value.<BR> <CODE>0</CODE> A (all ages)<br /> <CODE>12</CODE> B (age 12 and up)<br /> <CODE>15</CODE> C (age 15 and up)<br /> <CODE>17</CODE> D (age 17 and up)<br /> <CODE>18</CODE> Z (age 18 and up)<br /><CODE>Pending</CODE> Under review</td> 673<td align="center">For Japanese region.</td> 674</tr> 675 676<tr> 677<td align="center"><CODE>ESRB</CODE></td> 678<td align="center">Sets the ESRB rating (Americas). Specify as a numeric value.<BR> <CODE> 3</CODE> EARLY CHILDHOOD (EC, all ages)<br /> <CODE> 6</CODE> EVERYONE (E, age 6 and up)<br /><CODE> 10</CODE> EVERYONE10+ (E10+, age 10 and up)<br /><CODE> 13</CODE> TEEN (T, age 13 and up)<br /><CODE> 17</CODE> MATURE (M, age 17 and up)<br /><CODE>Pending</CODE> Under review<br /></td> 679<td align="center">For Americas region</td> 680</tr> 681 682<tr> 683<td align="center"><CODE>USK</CODE></td> 684<td align="center">Sets the USK rating (Europe). Specify as a numeric value.<BR> <CODE>0</CODE> No age restriction<br /> <CODE>6</CODE> age 6 and up<br /> <CODE>12</CODE> age 12 and up<br /> <CODE>16</CODE> age 16 and up<br /> <CODE>18</CODE> Inappropriate for minors<br /><CODE>Pending</CODE> Under review<br /></td> 685<td align="center">For European region.</td> 686</tr> 687 688<tr> 689<td align="center"><CODE>PEGI_GEN</CODE></td> 690<td align="center">Sets the PEGI_GEN rating (Europe). Specify as a numeric value.<BR> <CODE>3</CODE> age 3 and up<br /> <CODE>7</CODE> age 7 and up<br /> <CODE>12</CODE> age 12 and up<br /> <CODE>16</CODE> age 16 and up<br /> <CODE>18</CODE> age 18 and up<br /><CODE>Pending</CODE> Under review<br /></td> 691<td align="center">For European region<br /> (Required for titles sold in Europe outside of Portugal and the United Kingdom)<br /></td> 692</tr> 693 694<tr> 695<td align="center"><CODE>PEGI_PRT</CODE></td> 696<td align="center">Sets the PEGI_PRT rating (Europe). Specify as a numeric value.<BR> <CODE>4</CODE> age 4 and up<br /> <CODE>6</CODE> age 6 and up<br /> <CODE>12</CODE> age 12 and up<br /> <CODE>16</CODE> age 16 and up<br /> <CODE>18</CODE> age 18 and up<br /><CODE>Pending</CODE> Under review<br /></td> 697<td align="center">For European region<br /> (Required for titles sold in Portugal)</td> 698</tr> 699 700<tr> 701<td align="center"><CODE>PEGI_BBFC</CODE></td> 702<td align="center">Sets the PEGI_BBFC rating (Europe). Specify as a numeric value.<BR> <CODE>3</CODE> age 3 and up<br /> <CODE>4</CODE> U, Uc (recommended for age 4 and up)<br /> <CODE>7</CODE> age 7 and up<br /> <CODE>8</CODE> PG (recommended for age 8 and up)<br /> <CODE>12</CODE> age 12 and up<br /> <CODE>15</CODE> age 15 and up<br /> <CODE>16</CODE> age 16 and up<br /> <CODE>18</CODE> age 18 and up<br /><CODE>Pending</CODE> Under review<br /></td> 703<td align="center">For European region<br /> (Required for titles sold in United Kingdom)</td> 704</tr> 705 706<tr> 707<td align="center"><CODE>COB</CODE></td> 708<td align="center">Sets the COB rating (Australia). Specify as a numeric value.<BR> <CODE>0</CODE> G (General, no age specified)<br /> <CODE>7</CODE> PG (Parental guidance recommended, no age specified)<br /> <CODE>14</CODE> M (Recommended for adults, no age specified)<br /> <CODE>15</CODE> MA15+ (Unsuitable for 15 years and younger, consent or a parent or guardian required for 15 years or younger)<br /><CODE>Pending</CODE> Under review<br /></td> 709<td align="center">For European region.</td> 710</tr> 711 712<tr> 713<td align="center">GRB</td> 714<td align="center">Sets the GRB rating (Korea). Specify as a numeric value.<BR> 0 All ages<br /> 12 12 years or older<br /> 15 15 years or older<br /> 18 Not for minors<br />Pending Under review</td> 715<td align="center">For Korean region.</td> 716</tr> 717 718<tr> 719<td align="center">CGSRR</td> 720<td align="center">Sets the CGSRR rating (Taiwan). Specify as a numeric value.<BR>0 General (all ages)<br /> 6 Protect (ages 6 and up)<br /> 12 Counsel 12 (ages 12 and up)<br /> 15 Counsel 15 (ages 15 and up)<br />18 Restrict (ages 18 and up)<br />Pending Under review</td> 721<td align="center">For Taiwan/Hong Kong region.</td> 722</tr> 723 724<tr> 725<td align="center">ISBN</td> 726<td align="center">The ISBN number. Maximum 17 characters of ASCII code, hyphens included. (Example: AAA-B-CCCCC-DDD-X).<br /> Use hyphens when entering ISBN numbers. The positions of the hyphens may vary depending on the application.<br /> <B>Note</B>: If you specify <CODE>Pending</CODE> for the ISBN item, then ISBN, HTDJH, XCSZ_L, XCSZ_R are no longer required. Specify <CODE>Pending</CODE> for applications that are still under development, and for special applications that do not require ISBN display.<br /> 727</td> 728<td align="center">Item required for the Chinese region.<br />Cannot be set for other regions.</td> 729</tr> 730 731<tr> 732<td align="center">HTDJH</td> 733<td align="center">The Contract Registration Number. Maximum of 12 characters of ASCII code.</td> 734<td align="center">Item required for the Chinese region.<br />Cannot be set for other regions.</td> 735</tr> 736 737<tr> 738<td align="center">XCSZ_L</td> 739<td align="center">GAPP Number (China-specific information displayed on left side). Maximum of 4 characters of ASCII code.</td> 740<td align="center">Item required for the Chinese region.<br />Cannot be set for other regions.</td> 741</tr> 742 743<tr> 744<td align="center">XCSZ_R</td> 745<td align="center">GAPP Number (China-specific information displayed on right side). Maximum of 4 characters of ASCII code.</td> 746<td align="center">Item required for the Chinese region.<br />Cannot be set for other regions.</td> 747</tr> 748 749</tbody> 750</table> 751</div> 752 753<h4>Recommendations for each region</h4> 754The following table summarizes the languages for each region.<br /> ◎: Required. Must be set to this value.<br /> ○: Standard. If set to this, systems for that region may use it.<br /> Blank: Optional. If set to this, it may be used for StreetPass and friend registration with systems from other regions.<br /> 755 756<B>Note:</B> Revised specifications in the American and European regions so that the English title name is automatically used for languages whose title name is blank.<BR> 757 758 759<div class="table"> 760<table border="1"> 761<thead> 762<tr> 763<th align="center"> </th> 764<th align="center">Japanese</th> 765<th align="center">English</th> 766<th align="center">French</th> 767<th align="center">German</th> 768<th align="center">Italian</th> 769<th align="center">Spanish</th> 770<th align="center">Simplified Chinese</th> 771<th align="center">Korean</th> 772<th align="center">Dutch</th> 773<th align="center">Portuguese</th> 774<th align="center">Russian</th> 775<th align="center">Traditional Chinese</th> 776</tr> 777</thead> 778 779<tr> 780<th align="center">Japanese market</th> 781<td align="center">◎</td> 782<td align="center">◎</td> 783<td align="center"></td> 784<td align="center"></td> 785<td align="center"></td> 786<td align="center"></td> 787<td align="center"></td> 788<td align="center"></td> 789<td align="center"></td> 790<td align="center"></td> 791<td align="center"></td> 792<td align="center"></td> 793</tr> 794 795 796<tr> 797<th align="center">American market</th> 798<td align="center"></td> 799<td align="center">◎</td> 800<td align="center">○</td> 801<td align="center"></td> 802<td align="center"></td> 803<td align="center">○</td> 804<td align="center"></td> 805<td align="center"></td> 806<td align="center"></td> 807<td align="center">○</td> 808<td align="center"></td> 809<td align="center"></td> 810</tr> 811 812 813<tr> 814<th align="center">European and Australian markets</th> 815<td align="center"></td> 816<td align="center">◎</td> 817<td align="center">○</td> 818<td align="center">○</td> 819<td align="center">○</td> 820<td align="center">○</td> 821<td align="center"></td> 822<td align="center"></td> 823<td align="center">○</td> 824<td align="center">○</td> 825<td align="center">○</td> 826<td align="center"></td> 827</tr> 828 829 830<tr> 831<th align="center">Chinese market</th> 832<td align="center"></td> 833<td align="center">◎</td> 834<td align="center"></td> 835<td align="center"></td> 836<td align="center"></td> 837<td align="center"></td> 838<td align="center">◎</td> 839<td align="center"></td> 840<td align="center"></td> 841<td align="center"></td> 842<td align="center"></td> 843<td align="center"></td> 844</tr> 845 846 847<tr> 848<th align="center">Korean market</th> 849<td align="center"></td> 850<td align="center">◎</td> 851<td align="center"></td> 852<td align="center"></td> 853<td align="center"></td> 854<td align="center"></td> 855<td align="center"></td> 856<td align="center">◎</td> 857<td align="center"></td> 858<td align="center"></td> 859<td align="center"></td> 860<td align="center"></td> 861</tr> 862 863 864<tr> 865<th align="center">Taiwan/Hong Kong region</th> 866<td align="center"></td> 867<td align="center">◎</td> 868<td align="center"></td> 869<td align="center"></td> 870<td align="center"></td> 871<td align="center"></td> 872<td align="center"></td> 873<td align="center"></td> 874<td align="center"></td> 875<td align="center"></td> 876<td align="center"></td> 877<td align="center">◎</td> 878</tr> 879 880</table> 881</div> 882 883<h2><a name="sample">Samples</a></h2> 884 885<br /> 886 887<h4><CODE>sample.bsf</CODE></h4> 888<p class="code"> 889#BSF --- Banner Spec File<br /> LittleIconFile: little.ctpk<br /> BigIconFile: big.ctpk<br /> ModelFile: model.cbmd<br /> SoundFile: sound.bcwav<br /> <br /> Region:Japan # Comment<br /> Ulcd:True<br /> AutoSave:False<br /> SaveData:True<br /> ThumbnailFrame:0<br /> <br /> CERO:0<br /> <br /> JPLongName: Long title name<br /> "subtitle:symbol#"<br /> JPShortName: Short title name<br /> JPPublisher: Publisher <br /> 890</p> 891A simple example of a <CODE>.bsf</CODE> file with a CERO rating of all ages and 3D display with save data.<br /> <br /> 892 893 894<h2><a name="character">List of Characters Allowed in Title Names and Publisher Names</a></h2> 895 <p> 896 The usable characters will vary for different regions.<br /> For details, see <A href="AvailableCharacters.html">the lists of charters allowed in different regions.</a> 897 </p> 898 899<h2><a name="restrict">Data Restrictions</a></h2> 900 901<p> 902The following restrictions apply to banner data.<br /> 903</p> 904 905<h3>Restriction on Data Size</h3> 906 907<p>The compressed volume of data after conversion must be no larger than 1MB.<br /> For details, see <a href="ctr_BannerModelConverter.html#restrict"><CODE>ctr_BannerModelConverter</CODE></a>.<br /> <B>Note:</B> Data in violation of these restrictions causes an error during conversion by <CODE>BannerModelConverter</CODE>. 908</p> 909 910 911<h3>Sound File Restrictions</h3> 912 913<p> 914The following restrictions apply to sound files.<br /> <B>Note:</B> Data in violation of these restrictions causes an error during conversion by <CODE>BannerModelConverter</CODE>. (Not implemented.) 915</p> 916 917<ul> 918<li>Data length must be no longer than 3 seconds.</li> 919<li>There are two channels (stereo).</li> 920<li>The file is not configured to loop.</li> 921<li>The compression method is either DSP ADPCM, PCM16, or PCM8.</li> 922</ul> 923 924 925 <h2><a name="omake">Variables Defined in <CODE>OMakefile</CODE></a></h2> 926<p> 927 See <a href="../SDKRules/BuildRules.html">Build Rules</a> for more information about the variables defined in <CODE>OMakefile</CODE>. 928</p> 929 930<h2><a name="history">Revision History</a></h2> 931 <dl class="history"> 932 <dt>2012/06/19</dt> 933<dd>Fixed the program because it would sometimes not work correctly when <CODE>.tga</CODE> files with a format other than ETC were specified in <CODE>BigIconFile</CODE> or <CODE>LittleIconFile</CODE>.</dd> 934 <dt>2012/06/15</dt> 935<dd>Added support for the new ratings in Taiwan.</dd> 936 <dt>2012/02/15</dt> 937 <dd>Corrected errors in criteria for maximum number of characters in title names.</dd> 938 <dt>2012/01/20</dt> 939 <dd>Revised the partial error in string horizontal width determination for the Chinese, Korean, and Taiwanese markets.</dd> 940 <dd>Deleted description of StreetPass ID, which had been scheduled to be eliminated.</dd> 941 <dt>2011/12/14</dt> 942 <dd>Added support for the Chinese, Korean, and Taiwan/Hong Kong regions.</dd> 943 <dt>2011/9/27</dt> 944 <dd>Support for NW4C TGA files.</dd> 945 <dd>Changed the EULA version for the United States market from 1.0 to 1.1.</dd> 946 <dt>2011/9/8</dt> 947 <dd>Revised description of extremely rare bug where conversion does not happen properly and an error occurs.</dd> 948 <dd>Join-in IDs and join-in game mode masks can now be used.</dd> 949 <dt>2011/8/4</dt> 950 <dd>Deleted <CODE>CecId</CODE> item and added <CODE>CecUniqueId</CODE> item.</dd> 951 <dt>2011/6/22</dt> 952 <dd>Added note to descriptions of <CODE>BigIconFile</CODE> and other items that this is the relative path to the BSF file.</dd> 953 <dt>2011/6/17</dt> 954 <dd>Changed the restriction on the number of characters in <CODE>LongName</CODE> to 16 full-width characters plus 3 half-width "i" characters per line.</dd> 955 <dd>Changed <CODE>makebanner</CODE> to output files to a relative path from the current directory instead of a </dd> 956 <dd>relative path calculated from the directory with the BSF file.</dd> 957 <dt>2011/6/9</dt> 958 <dd>In the Americas and European regions, the English-language titles are</dd> 959 <dd>now used automatically for languages with blank titles.</dd> 960 <dt>2011/4/12</dt> 961 <dd>Fixed a bug in the revision from 2011/02/04 that was supposed to show an error message</dd> 962 <dd>when the join-in game ID and join-in game mode bit are set.</dd> 963 <dt>2011/2/4</dt> 964 <dd>When the matchmaking game ID and matchmaking game mode bit have been configured, revisions have been made so that an error occurs.</dd> 965 <dd>Added a description of the <CODE>AgreeEULA</CODE> flag.</dd> 966 <dt>2011/1/18</dt> 967 <dd>When there is no banner model data (<CODE>CBMD</CODE>) or no sound file (<CODE>BCWAV</CODE>),</dd> 968 <dd>an error message now is output.</dd> 969 <dt>2010/12/30</dt> 970 <dd>Fixed a bug related to the BNR file capacity restrictions check.</dd> 971 <dt>2010/12/25</dt> 972 <dd>An error now occurs when the created BNR file violates the restriction on data capacity.</dd> 973 <dt>2010/12/21</dt> 974 <dd>Revised the check of required languages for each market. (Previously this check did not work correctly.)</dd> 975 <dd>Fixed the notation for Korean from <CODE>KR</CODE> to the correct <CODE>KO</CODE>.</dd> 976 <dd>Changed the status of Korean and Chinese to "not yet supported."</dd> 977 <dt>2010/11/24</dt> 978 <dd>Added required language checks for each market.</dd> 979 <dd>Fixed bug where BSF two-line titles would not be properly configured if the second line consisted of only a newline.</dd> 980 <dt>2010/11/19</dt> 981 <dd>Added data restrictions.</dd> 982 <dt>2010/10/20</dt> 983 <dd>Removed the Australia market and integrated it with the Europe market.</dd> 984 <dt>2010/10/15</dt> 985 <dd>Changed the "Matchmake Game code" to the "join-in game ID".</dd> 986 <dd>Changed the Matchmake Game code bit to the matchmaking game mode bit flag.</dd> 987 <dt>2010/10/13</dt> 988 <dd>Added the StreetPass ID item.</dd> 989 <dd>Revised the specifiable market items.</dd> 990 <dt>2010/10/09</dt> 991 <dd>Removed explanation about non-support of banner confirmation.</dd> 992 <dt>2010/09/28</dt> 993 <dd>Initial version.</dd> 994 </dl> 995<hr><p>CONFIDENTIAL</p></body> 996</html>