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_make_ex_banner</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_make_ex_banner</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">EBSF</a></li> 145 <li><a href="#sample">Samples</a></li> 146 <li><a href="#character">List of Characters Allowed in Comments</a></li> 147 <li><a href="#othertool">Related Tools</a></li> 148 <li><a href="#bug">Known Problems</a></li> 149 <li><a href="#history">Revision History</a></li> 150</ol> 151 152 153 154<h2><a name="intro">Introduction</a></h2> 155<P>The <CODE>ctr_make_ex_banner</CODE> tool is used to create contextual banner data (ExBanner). You can use contextual banner data to replace the texture of the application's banner whenever you want. It generates BIN files based on the content of EBSF files.</P> 156 157 158<h2><a name="usage">How to Use</a></h2> 159<h3>What's Required</h3> 160<p>You need the following files to create contextual banner data.</p> 161<ul> 162 163<li> An EBSF file that contains the <CODE>ExBanner</CODE> data</li> 164<li> DMP native texture format binary or NW4C TGA file created by NW4C plug-in. 165 </li> 166</ul> 167 168 169<h3>Commands</h3> 170 171 172<p class="code"> 173 % ctr_make_ex_banner32.exe EX_BANNER_SPEC_FILE [OUTPUT_DIRECTORY] 174</p> 175 176 177<p class="first_ja">You must specify the <CODE>EX_BANNER_SPEC_FILE</CODE> (an EBSF file). 178</p> 179 180<h4 >Options</h4> 181 182<p> 183The <CODE>OUTPUT_DIRECTORY</CODE> specification is optional. To specify an output directory, either specify a relative path from the current directory or an absolute path.<br /> When unspecified, the contextual banner data's binary file is output to the current directory.</p> 184 185<h2><a name="bsf">EBSF</a></h2> 186 187<p>This file defines the settings for the binary file of the contextual banner data that this tool creates.<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. Select <B>Unicode</B> from the <B>Encoding</B> drop-down list when saving the file. </p> 188 189<h3>Parameters</h3> 190 191<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> 192 193<h3>Format</h3> 194 195<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>). 196</p> 197 198<h3>Format</h3> 199 200<p>The EBSF file format is shown below.</p> 201 202<p class="code"> 203 FileName: #Specifies the name of the texture to create. The file FileName.bin is created.<br /> TexWidth: #Specifies the width of the texture.<br /> TexHeight: #Specifies the height of the texture.<br /> TexFormat: #Specifies the GL texture format. Use the values defined in NW4C and not numerical values.<br /> LimitYear: #Indicates the expiration date for this contextual banner. The contextual banner becomes invalid when the expiration date has passed.<br /> LimitMonth: #The year can be set in LimitYear, the month in LimitMonth, and the day in LimitDate.<br /> LimitDate: #<br />Text: #Sets the text to display in the banner.<br /> TextureName: #Sets the name of the texture.<br /> TextureDataFileName: #Specifies the filename for the texture binary data.<br /> 204 205</p> 206 207<p> 208 Set the values using the following format: 209</p> 210 211<h3>Specifying Elements</h3> 212 Elements are specified as follows. 213<p class="code"> 214 Key Name: Value 215</p> 216 217<h4>Notes</h4> 218<ul> 219<li>There are restrictions on the names of textures and on the characters that are usable in text. (Described later.)</li> 220</ul> 221 222 Setting descriptions for each of these items are provided below. 223<div class="table"> 224<table border="1"> 225<thead> 226<tr> 227<th align="center">Item</th> 228<th align="center">Description</th> 229<th align="center">Comments</th> 230</tr> 231</thead> 232<tbody> 233 234<tr> 235<td align="center"><CODE>FileName</CODE></td> 236<td align="center"> 237Specifies the name of the file to generate. The following values are valid. <br /><br /> COMMON: # Create a contextual banner that is valid for all regions.<br /> <CODE>EUR_EN</CODE>: # Create a contextual banner that is only valid for <CODE>EUR_EN</CODE>.<br /> <CODE>EUR_FR</CODE>: # Create a contextual banner that is only valid for <CODE>EUR_FR</CODE>.<br /> <CODE>EUR_GE</CODE>: # Create a contextual banner that is only valid for <CODE>EUR_GE</CODE>.<br /> <CODE>EUR_IT</CODE>: # Create a contextual banner that is only valid for <CODE>EUR_IT</CODE>.<br /> <CODE>EUR_SP</CODE>: # Create a contextual banner that is only valid for <CODE>EUR_SP</CODE>.<br /> <CODE>EUR_DU</CODE>: # Create a contextual banner that is only valid for <CODE>EUR_DU</CODE>.<br /> <CODE>EUR_PO</CODE>: # Create a contextual banner that is only valid for <CODE>EUR_PO</CODE>.<br /> <CODE>EUR_RU</CODE>: # Create a contextual banner that is only valid for <CODE>EUR_RU</CODE>.<br /> <CODE>JPN_JP</CODE>: # Create a contextual banner that is only valid for <CODE>JPN_JP</CODE>.<br /> <CODE>USA_EN</CODE>: # Create a contextual banner that is only valid for <CODE>USA_EN</CODE>.<br /> <CODE>USA_FR</CODE>: # Create a contextual banner that is only valid for <CODE>USA_FR</CODE>.<br /> <CODE>USA_SP</CODE>: # Create a contextual banner that is only valid for <CODE>USA_SP</CODE>.<br /> <CODE>USA_PO</CODE>: # Create a contextual banner that is only valid for <CODE>USA_PO</CODE>.<br /> <CODE>CHN_CN:</CODE> #Create a contextual banner that is only valid for <CODE>CHN_CN</CODE>.<br /> <CODE>KOR_KR:</CODE> #Create a contextual banner that is only valid for <CODE>KOR_KR</CODE>.<br /> <CODE>TWN_TW:</CODE> #Create a contextual banner that is only valid for <CODE>TWN_TW</CODE>.<br /> <br /> You must set one of these values.<br /> <br /> 238</td> 239<td align="center"></td> 240</tr> 241 242<tr> 243<td align="center"><CODE>TexWidth</CODE></td> 244<td align="center"> 245The width of the texture. Specify this when using the DMP native texture format (RAW data) with <CODE>TextureDataFileName</CODE>. Set using decimal notated numbers. Can specify values that are multiples of 2 in the range of 8 to 1024. <br /> If textures are not going to be substituted, this value does not need to be set.<br /> 246</td> 247<td align="center"><CODE>TextureDataFileName</CODE> ignores this setting when an NW4C TGA file is specified.</td> 248</tr> 249<tr> 250<td align="center"><CODE>TexHeight</CODE></td> 251<td align="center"> 252The texture height. Specify this element when you use the DMP native texture format (RAW data) with <CODE>TextureDataFileName</CODE>.<br /> Use decimal notated numbers. You can specify values that are multiples of 2 in the range from 8 to 1024. <br /> If textures are not going to be substituted, this value does not need to be set.<br /> 253</td> 254<td align="center"><CODE>TextureDataFileName</CODE> ignores this setting when an NW4C TGA file is specified.</td> 255</tr> 256 257<tr> 258<td align="center"><CODE>TexFormat</CODE></td> 259<td align="center"> 260The texture format. Specify this element when you use the DMP native texture format (RAW data) with <CODE>TextureDataFileName</CODE>.<br /> The following values can be set.<br /> <br /> <CODE>RGBA8</CODE>: 4 bytes per pixel, where each of RGBA is 8 bits.<br /> <CODE>RGB8</CODE>: 3 bytes per pixel, where each of RGB is 8 bits.<br /> <CODE>RGBA5551</CODE>: 2 bytes per pixel, where each of RGB is 5 bits and A is 1 bit.<br /> <CODE>RGB565</CODE>: 2 bytes per pixel, where R, G, and B are 5, 6, and 5 bits, respectively.<br /> <CODE>RGBA4</CODE>: 2 bytes per pixel, where R, G, B, and A are 4 bits each.<br /> <CODE>LA8:</CODE> 2 bytes per pixel, where Alpha and Luminance are 8 bits each.<br /> <CODE>HILO8</CODE>: 2 bytes per pixel, where X and Y are 8 bits each.<br /> <CODE>L8</CODE>: 1 byte per pixel, where Luminance is 8 bits.<br /> <CODE>A8</CODE>: 1 byte per pixel, where Alpha is 8 bits.<br /> <CODE>LA4</CODE>: 1 byte per pixel, where Alpha and Luminance are 4 bits each.<br /> <CODE>L4</CODE>: 4 bits per pixel, where Luminance is 4 bits.<br /> <CODE>A8</CODE>: 4 bits per pixel, where Alpha is 4 bits.<br /> <CODE>ETC1</CODE>: Compressed format corresponding to 4 bits per pixel.<br /> <CODE>ETC1A4</CODE>: Compressed format corresponding to 8 bits per pixel.<br /> <br /> If nothing is specified, then RGBA8 is set by default.<br /> If textures are not going to be substituted, this value does not need to be set.<br /> 261<td align="center"><CODE>TextureDataFileName</CODE> ignores this setting when an NW4C TGA file is specified.</td> 262</td> 263</tr> 264 265 266<tr> 267<td align="center"><CODE>LimitYear</CODE></td> 268<td align="center"> 269The expiration of the contextual banner. Use decimal notated numbers. Specify using the western calendar.<br /> The range of values that can be specified is from <CODE>2000</CODE> to <CODE>2099</CODE>.<br /> If a value is not set then there will be no limit.<br /> <B>Note</B>: <CODE>LimitYear</CODE>, <CODE>Month</CODE>, and <CODE>Date</CODE> are only valid for downloaded contextual banners.<br /> Even if the values are configured, they are ignored for local contextual banners. 270</td> 271<td align="center"></td> 272</tr> 273 274<tr> 275<td align="center"><CODE>LimitMonth</CODE></td> 276<td align="center"> 277The expiration of the contextual banner. Use decimal notated numbers. The range of values that can be specified is from <CODE>1</CODE> to <CODE>12</CODE>.<br /> If you want this to be limitless, then no setting needs to be configured.<br /> 278</td> 279<td align="center"></td> 280</tr> 281<tr> 282<td align="center"><CODE>LimitDate</CODE></td> 283<td align="center"> 284The expiration of the contextual banner. Use decimal notated numbers. The range of values that can be specified is from <CODE>1</CODE> to <CODE>31</CODE>.<br /> However, do not use dates not on the calendar.<br /> If you want this to be limitless, then no setting needs to be configured.<br /> 285</td> 286<td align="center"></td> 287</tr> 288 289<tr> 290<td align="center"><CODE>Text</CODE></td> 291<td align="center"> 292This text is displayed in the bottom of the upper screen when the application is selected in the HOME Menu. Specify this with 255 characters or less.<br /> Text will not display if this value is not set.<br /> When the length fits within the horizontal width of the screen, it is displayed as is. If the length does not fit, a scrolling display appears. 293</td> 294<td align="center"></td> 295</tr> 296 297 298<tr> 299<td align="center"><CODE>TextureName</CODE></td> 300<td align="center"> 301Specifies the name of the texture.<br /> Keep the name to 15 or fewer ASCII characters.<br /> If textures are not going to be substituted, this value does not need to be set.<br /> 302</td> 303<td align="center"></td> 304</tr> 305 306<tr> 307<td align="center"><CODE>TextureDataFileName</CODE></td> 308<td align="center"> 309The texture's data file. Specify either a relative path from the current directory or an absolute path.<br /> If textures are not going to be substituted, this value does not need to be set.<br /> Specify a DMP native texture format binary (raw data) or an NW4C TGA file created by the NW4C plug-in (any size or format; no mipmap).</td> 310<td align="center"></td> 311</tr> 312 313 314 315</tbody> 316</table> 317</div> 318 319 320<h2><a name="sample">Samples</a></h2> 321 322<br /> 323<p class="code">sample.ebsf<br /> ----------------------------------------------------<br /> FileName:COMMON<br /> Text: Sample text<br /> ----------------------------------------------------<br /> 324</p> 325Creates expanded banner data in which only text can be substituted.<br /> <br /> <br /> <br /> 326<p class="code">sample2.ebsf<br /> ----------------------------------------------------<br /> FileName:JPN_JP<br /> TexWidth:64<br /> TexHeight:64<br /> TexFormat:RGBA4<br /> TextureName:sampleTexture<br /> Text: Sample text<br /> TextureDataFileName: (the texture file path)<br /> ----------------------------------------------------<br /> 327</p> 328The texture named <CODE>sampleTexture</CODE> is substituted by the texture in the <CODE>TextureDataFileName</CODE> path.<br /> There is no limit because <CODE>LimitYear</CODE> and the other items are not specified.<br /> 329 330<br /> <br /> <br /> 331<p class="code">template.ebsf<br /> ----------------------------------------------------<br /> FileName:<br />TexWidth:<br />TexHeight:<br />TexFormat:<br />LimitYear:<br />LimitMonth:<br />LimitDate:<br />TextureName:<br />Text:<br />TextureDataFileName:<br /> ----------------------------------------------------<br /> 332</p> 333This is the EBSF file template.<br /> <br /> <br /> 334<h2><a name="character">List of Characters Usable in Comments</a></h2> 335 <p> 336 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> 337 </p> 338<h2><a name="othertool">Related Tools</a></h2> 339 <p> 340 The contextual banner creation tool is a related tool. You can use the BOSS features to change out banner textures. See <A href="ctr_makedlexbanner.html"><CODE>ctr_makedlexbanner</CODE></a> for details. 341 </p> 342 343<h2><a name="bug">Known Problems</a></h2> 344Under certain conditions, the HOME Menu freezes when textures are switched in contextual banners (including DL contextual banners) 345 346<h3>Details</h3> 347<p> 348When textures that are referenced from multiple materials are switched in contextual banners, an internal memory leak occurs when that banner is displayed on the HOME Menu. <br /><br /> If you select another application on the HOME Menu and another banner is displayed, and then you display a banner with a switched texture, and then you repeat this action several times, the HOME Menu can freeze. 349</p> 350 351<h3>Workaround</h3> 352<p> 353Do not switch textures that are referenced from multiple materials in contextual banners. 354</p> 355 356 357<h3>Verification Procedure</h3> 358<p> 359Display a contextual banner on the HOME Menu.<br /> When data that would cause an error is used, an error message is displayed on the bottom portion of the upper screen. 360</p> 361 362<h2><a name="history">Revision History</a></h2> 363 <dl class="history"> 364 <dt>2012/06/19</dt> 365<dd>Fixed a bug where the program sometimes did not work correctly when TGA files with a format other than ETC were specified in <CODE>TextureDataFileName</CODE>.</dd> 366 <dt>2012/04/17</dt> 367 <dd>Removed English from Taiwan/Hong Kong region.</dd> 368 <dt>2012/04/16</dt> 369 <dd>Added Known Problems.</dd> 370 <dt>2012/02/21</dt> 371 <dd>Created the <B>Related Tools</B> section. Added link to download contextual banner creation manual.</dd> 372 <dt>2012/02/15</dt> 373 <dd>Fixed bug causing error when texture data file not found.</dd> 374 <dt>2011/12/02</dt> 375 <dd>Added support for the Chinese, Korean, and Taiwan/Hong Kong regions.</dd> 376 <dt>2011/9/27</dt> 377 <dd>Explained NW4C TGA files.</dd> 378 <dt>2011/1/19</dt> 379 <dd>Explained that <CODE>LimitYear</CODE>, <CODE>Month</CODE>, and <CODE>Date</CODE> are valid only for downloadable contextual banners.</dd> 380 <dd>Revised so that the output directory can be specified.</dd> 381 <dt>2011/1/17</dt> 382 <dd>Revised the content of <CODE>TextureDataFileName</CODE> for settings for each item.</dd> 383 <dt>2011/1/10</dt> 384 <dd>Added information on the text display bug.</dd> 385 <dt>2010/12/22</dt> 386 <dd>Support for substitution of only text.</dd> 387 <dd>Added sample items.</dd> 388 <dt>2010/12/2</dt> 389 <dd>Fixed a bug that prevented errors from occurring when unusable text was used.</dd> 390 <dt>2010/12/1</dt> 391 <dd>A single EBSF file is now required for each region.</dd> 392 <dd>In conjunction with this, added a <CODE>FileName</CODE> parameter to specify which regional BIN file to create.</dd> 393 <dd>Added a <CODE>FileName</CODE> parameter to specify.</dd> 394 <dt>2010/10/13</dt> 395 <dd>Standardized language and region names with <CODE>makebanner</CODE>.</dd> 396 <dt>2010/10/8</dt> 397 <dd>Initial version.</dd> 398 </dl> 399<hr><p>CONFIDENTIAL</p></body> 400</html>