1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 2<HTML> 3<HEAD> 4<META http-equiv="Content-Type" content="text/html; charset=windows-1252"> 5<META http-equiv="Content-Style-Type" content="text/css"> 6<TITLE>Letterform Template Specification Manual</TITLE> 7<LINK rel="stylesheet" type="text/css" href="../../CSS/revolution.css"> 8<LINK rel="stylesheet" type="text/css" href="../nwc24.css"> 9</HEAD> 10<BODY> 11<H1>Letterform Template</H1> 12 13<H2>Introduction</H2> 14<P> 15Wii messages can be displayed on the Wii Message Board using its default design. However, it is also possible to use controls and special enhancements specified by an application. The following items represent specifiable content; it is possible to select and use only those items that are necessary. 16</P> 17 18<DL> 19<DT>Letterform</DT> 20<DD><P>You can change the image displayed in the background of the main text of a message when it is opened.</P></DD> 21<DT>Envelope (thumbnail)</DT> 22<DD><P>You can change the envelope image that is displayed immediately after the Wii Message Board is opened.</P></DD> 23<DT>Sounds</DT> 24<DD><P>A sound can be played when a message is opened. Looping play is also supported.</P></DD> 25<DT>Channel Jump Button</DT> 26<DD><P>A button that will directly start an application can be displayed when a message is opened.</P></DD> 27</DL> 28 29<P>These features are collectively called "Letterform Template".</P> 30 31<H2>Preparing the Letterform Template Data Files</H2> 32 33<P> 34To use each of the Letterform Template features, a data file that supports each of these features must be provided.<BR>Although these are independent data files, they must ultimately be combined into a single archive by <CODE>darch.exe</CODE>. With an archive file created this way attached to a Wii message, the letterform template can function properly. 35</P> 36 37<P>Following is an explanation of the data files for using each of a letterform template's features.</P> 38 39<H3>Envelope and Letterform</H3> 40<P>For convenience, envelope and letterform data files are explained together here. If not necessary, using one or the other alone is permissible.</P> 41 42<H4>Image File Construction and Element Placement</H4> 43<P> 44Envelopes and letterforms are constructed as TPL (Texture Palette Library) format image files; each of their parts are laid out on the Wii Message Board as follows. 45</P> 46<DL> 47<DT>Letterform</DT> 48 <DD> 49<P>This is made from 9 images (3 headers, 3 bodies, and 3 footers).</P> 50<P><IMG SRC="images/location2.gif" ALT="location2.gif (12662 bytes)" width="653" height="280"></P> 51 </DD> 52 53<DT>Envelope (thumbnail)</DT> 54 <DD> 55<P>This is made from 1 image.<P> 56<P><IMG SRC="images/location1.gif" ALT="location1.gif (5493 bytes)" width="461" height="216"></P> 57 </DD> 58</DL> 59 60 61<H4>Image File Creation</H4> 62 63<P> 64The only supported format for image files is the TPL format.<BR>You can use <CODE>TexConv.exe</CODE> to create TPL files out of TGA format image files. <BR> 65Be sure to specify <STRONG><CODE>GX_CLAMP</CODE></STRONG> when creating TPL files to prevent texture wrapping.</P> 66<P> 67Make sure that the width and height of the individual image files are the same size or smaller than the sizes shown above under "Image File Construction".<BR>When the width and height sizes are smaller, they are scaled for display in the Wii Message Board. 68</P> 69 70<P> 71The texel format must <B>not</B> be <CODE>GX_TF_RGBA8</CODE> or <CODE>GX_TF_C14X2</CODE>, and it must be a format that is supported by the Layout library.<BR>The usable formats are as follows: 72</P> 73<BLOCKQUOTE> 74<CODE>GX_TF_I4<BR> GX_TF_I8<BR> GX_TF_IA4<BR> GX_TF_IA8<BR> GX_TF_RGB565<BR> GX_TF_RGB5A3<BR> GX_TF_CMPR<BR> GX_TF_C4<BR> GX_TF_C8<BR></CODE> 75</BLOCKQUOTE> 76 77<P> 78Save each of the TPL files with names as shown below, and store them in separate archives for the letterform and envelope using <CODE>darch.exe</CODE>. 79</P> 80 81<DL> 82<DT>Envelope</DT> 83 <DD> 84 <P> 85Archives TPL files that contain only a single envelope texture. The upper limit on data size (after archiving) is 30KB. If this size is exceeded, the image will not display correctly. 86 </P> 87 <CODE> 88 <UL> 89<LI>thumbnail.arc</LI> 90 <UL> 91 <LI>img/my_LetterS_b.tpl</LI> 92 </UL> 93 </UL> 94 </CODE> 95 </DD> 96 97<DT>Letterform</DT> 98 <DD> 99 <P> 100The nine textures that make up the letterform of an open message are saved individually in TPL format files, which are combined in a single archive. The upper limit on data size (after archiving) is 400KB. If this size is exceeded, the image will not display correctly. 101 </P> 102 <CODE> 103 <UL> 104<LI>letter.arc</LI> 105 <UL> 106 <LI>img/my_Letter_a.tpl (header - left)</LI> 107 <LI>img/my_Letter_b.tpl (header - center)</LI> 108 <LI>img/my_Letter_c.tpl (header - right)</LI> 109 <LI>img/my_Letter_d.tpl (body - left)</LI> 110 <LI>img/my_Letter_e.tpl (body - center)</LI> 111 <LI>img/my_Letter_f.tpl (body - right)</LI> 112 <LI>img/my_Letter_g.tpl (footer - left)</LI> 113 <LI>img/my_Letter_h.tpl (footer - center)</LI> 114 <LI>img/my_Letter_i.tpl (footer - right)</LI> 115 </UL> 116 </UL> 117 </CODE> 118 </DD> 119</DL> 120 121<H4>Image Archive Compression</H4> 122<P> 123Each of the archived images must be LZ77-compressed using <CODE>ntcompress.exe</CODE>. Set the letterform name to <CODE>letter_LZ.bin</CODE> and the envelope name to <CODE>thumbnail_LZ.bin</CODE>.<BR>Make sure they are aligned to 4 bytes. 124</P> 125<P> 126Example: 127</P> 128<BLOCKQUOTE class="prompt"> 129<CODE>$ ntcompress -l -A4 -o thumbnail_LZ.bin thumbnail.arc<BR> convert thumbnail.arc(27808byte) to thumbnail_LZ.bin(4580byte)<BR> $ ntcompress -l -A4 -o letter_LZ.bin letter.arc<BR> convert letter.arc(369536byte) to letter_LZ.bin(56816byte)<BR></CODE> 130</BLOCKQUOTE> 131 132<P> 133The letterform and envelope data are created this way. 134</P> 135 136<H3>Sounds</H3> 137 138<P>Banner sound format files can be used by letterform templates. For more details, consult the <I>IconBannerTools</I> man page. The file name is fixed to be <CODE>sound.bns</CODE>.</P> 139 140 141<H3>Channel Jump Button</H3> 142 143<P> 144Channel Jump Button is displayed when a message is opened and will directly start an application. The application that will start when the button is pressed is controlled by data called Channel Jump Data. 145</P> 146<P> 147For methods of creating Channel Jump Data, refer to the <CODE><A href="../tools/makeChjp.html">makeChJp.exe</A></CODE> page. The file name is fixed to be <CODE>chjump.bin</CODE>. 148</P> 149 150 151<H2>Creating the Letterform Template</H2> 152 153<P> 154The data files that were prepared to use each of the features are then archived again using <CODE>darch.exe</CODE>.<BR>When this is done, the filenames and folder structures take the following forms: 155</P> 156<BLOCKQUOTE> 157<CODE>./thumbnail_LZ.bin<BR> ./letter_LZ.bin<BR> ./sound.bns<BR> ./chjump.bin<BR></CODE> 158</BLOCKQUOTE> 159<P> 160 (Not all files need to be included.) 161</P> 162<P> 163The archive file that is ultimately obtained can take any filename. 164</P> 165 166<P> 167The maximum file size for the letterform template is <STRONG>120 KB</STRONG>. The size of the archive file that is ultimately created should be kept to 120 KB. 168</P> 169 170<H2>Sending the Letterform Template</H2> 171<P> 172The letterform template is a feature specifically for the Wii Message Board. The created archive file is attached and sent in a Wii message specified as the message type <A HREF="../Types/NWC24MsgType.html"><CODE>NWC24_MSGTYPE_WII_MENU</CODE></A> or <A HREF="../Types/NWC24MsgType.html"><CODE>NWC24_MSGTYPE_WII_MENU_SHARED</CODE></A>. The binary type is specified as <A HREF="../Types/NWC24MIMEType.html"><CODE>NWC24_APP_WII_MSGBOARD</CODE></A>. 173</P> 174<P> 175This letterform template cannot be sent from a PC or anything other than a Wii application. To learn how to create Wii messages, see the NWC24 Library Function Reference Manual. 176</P> 177 178<H2>Revision History</H2> 179<P> 1802007/11/13 Added note about creating TPL files. 181<BR> 2007/10/15 Added text about size restrictions for archiving envelopes and letterforms. <BR> 2007/8/2 Large-scale revisions in conjunction with addition of descriptions of the Sounds and the Channel Jump Button. <BR> 2007/07/17 Corrected the description of supported texel formats and changed size restriction to 120 KB.<BR>2007/04/19 Corrected line spacing of the message body in the images for enlargement, and added text about the console region setting.<BR>2007/03/23 Corrected footer size for the images for enlargement.<BR>2007/03/13 Initial version.</P> 182 183<hr><p>CONFIDENTIAL</p></body> 184</HTML> 185
