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=utf-8">
5<META name="GENERATOR" content="IBM WebSphere Studio Homepage Builder Version 7.0.0.0 for Windows">
6<META http-equiv="Content-Style-Type" content="text/css">
7<TITLE>TWL Nmenu</TITLE>
8<LINK rel="stylesheet" href="../css/nitro.css" type="text/css">
9<STYLE type="text/css">
10<!--
11.sample_source{
12  background-color : #e8e8e8;
13}
14H3{
15  color : teal;
16}
17pre
18{
19  display: compact;
20  font-family	: "Courier New", monospace;
21  font-weight	: normal;
22  font-size     : normal;
23
24/*  margin		: 0pt 0pt 6pt 50pt;*/
25  padding		: 2pt 8pt 2pt 8pt;
26  background-color	: #eee;
27
28  border-style		: solid;
29  border-width		: 1px;
30}
31.command_list{
32  margin-bottom : 16pt;
33}
34.command_desc{
35  }
36.command_item{
37  margin-top : 16pt;
38  background-color : #e8e8e8;
39}
40.blockquoted_table {
41  border : 1px;
42  width : 80%;
43}
44TD,TH{
45  border-color	: #c0d8d8;
46  padding       : 1pt 4pt 1pt 4pt;
47  border-width  : 1px;
48  border-style  : solid;
49}
50div.screen
51{
52    float: left;
53    padding: 2px;
54    background-color: black;
55    margin: 0 0.5em 1em 1em;
56}
57ol, ul
58{
59    padding-left: 4em;
60    margin-left: 0pt;
61}
62
63div.screen img.main
64{
65    margin-bottom: 10px;
66}
67.warning
68{
69    color: red;
70}
71table
72{
73    left: 0;
74}
75table.plain td
76{
77    border: none;
78    background-color: transparent;
79}
80-->
81</STYLE>
82</HEAD>
83<BODY>
84
85<H1 align="left">TWL Nmenu</H1>
86
87
88<H2>Overview</H2>
89<P>
90 <CODE>TwlNmenu</CODE> is a TWL application that manages NAND applications in the TWL system. It can install NAND applications from TAD files on SD Cards or DS cards in the TWL system. It can start or delete NAND applications stored in the TWL system.
91</P>
92
93
94<H2>Execution</H2>
95<H3></H3>
96<P>
97It can be run in the following ways:
98</P>
99<ul>
100<li>Use the IS-TWL-DEBUGGER software to run <CODE>TwlNmenu.srl</CODE>.
101<li>Use the IS-TWL-DEBUGGER software to import and then run <CODE>TwlNmenu.tad</CODE>.
102<li>Write <CODE>TwlNmenu.srl</CODE> to a DS Game Card and then run it.
103<li>Use TWL Nmenu to import and then run <CODE>TwlNmenu.tad</CODE>.
104</ul>
105<P>
106If running the TWL Nmenu using the IS-TWL-DEBUGGER software, a &quot;Please wait a moment&quot; dialog box will be displayed, and you'll no longer be able to perform operations within the IS-TWL-DEBUGGER software. To exit, click <B>Force Quit</B> in the dialog box.
107</P>
108
109<H2>Storing TAD Files on a DS Card</h2>
110<p>
111NAND applications can be imported from a TAD file stored on a DS card when in <B>Card</B> mode. This is a description of how to prepare the DS card to be used at this time.
112</p>
113<p>
114There are two methods.
115</p>
116
117<h5>Using the <CODE>-n</CODE> Option with <CODE>maketad</CODE></h5>
118<p>
119Although the <a href="../tools/maketad.html"><CODE>maketad</CODE></a> tool creates TAD files, using the <CODE>-n</CODE> option creates an SRL file that contains a TAD file instead of creating just a TAD file. Access the TAD file contained in the SRL file in <B>Card</B> mode by writing the SRL created with this option to a DS card.
120</p>
121
122<h5>Creating an Original SRL File</h5>
123<p>
124Access a TAD file included in the ROM-FS of an SRL file in <B>Card</B> mode by creating an SRL file that meets the following conditions and then writing it to a DS card.
125</p>
126<ul>
127<li>It must be NITRO ROM.
128<li>The company code must be &quot;YZ&quot;.
129</ul>
130
131
132<H2>Using the Tool</H2>
133<p>
134Once you are in TWL Nmenu, the upper screen will display some basic instructions and information about the currently selected file. The lower screen is used for displaying and selecting items in the list. Although display is usually in English, if the system language is Japanese (that is, if the market is Japan), some messages may appear in Japanese.<br>The TWL Nmenu is divided into three modes: <B>NAND</B>, <B>SD</B>, and <B>Card</B>. However, the <B>Card</B> mode is not available when Twl Nmenu is started as a card application. You can switch to the inactive mode either by touching the gray area at the top of the lower screen, or by pressing ← or → on the +Control Pad.
135</p>
136
137<h4>NAND Mode</h4>
138<div class="screen"><img class="main" src="TwlNmenu/NAND_main_0.png"><br><img src="TwlNmenu/NAND_sub_0.png"></div>
139<div class="screen"><img class="main" src="TwlNmenu/NAND_main_1.png"><br><img src="TwlNmenu/NAND_sub_1.png"></div>
140<p>
141In NAND mode, a list of NAND applications that are installed on the TWL system is displayed. In this mode, you can start or delete the selected NAND application.
142</p>
143<p>
144Each item in the list displayed on the lower screen shows information about a NAND application in the following format:
145</p>
146<table class="plain" style="width:0"><tr><td>
147<pre>
14803. 01 4BNA (3031 34424e41) Ver.1.0
149    -- ----  ---- --------      ---
150    1  2     3    4             5
151</pre>
152</td></tr></table>
153<table class="plain" style="width:25em"><tr><td>
154<ol>
155<li>Company Code (ASCII)
156<li>Game Code (ASCII)
157<li>Company Code (Hexadecimal)
158<li>Game Code (Hexadecimal)
159<li>NAND application version number
160</ol>
161</td></tr></table>
162<p>
163Light blue items in the list, for which &quot;deleted&quot; appears to the right, indicate NAND applications that have been deleted. Red items in the list, for which &quot;error&quot; appears to the right, indicate NAND applications that are invalid. You should delete and then reimport these items.
164</p>
165
166<br clear="left">
167
168<p>
169The controls for this mode are shown in the table below.
170</p>
171
172<table class="table">
173<tbody>
174<tr><th>Button<th>Operations
175<tr><td>←→  <td>Mode Switching
176<tr><td>↑↓  <td>Selects NAND applications.
177<tr><td>START<td>Starts the selected NAND application.
178<tr><td>Y<td>Clears the private save data of the selected NAND application.
179<tr><td>X<td>Deletes the selected NAND application.
180<tr><td>R + X<td>Deletes all NAND applications of the same type as the selected one.
181<tr><td>L<td>Moves to the next page on the upper screen.
182<tr><td>SELECT<td>Toggles between showing and hiding the description of the controls.
183</tbody>
184</table>
185
186<p>
187The following information is shown on the upper screen:
188</p>
189
190<p>
191Page 1
192</p>
193<table class="table">
194<tbody>
195<tr><th colspan="2">Item<th>Description
196<tr><th colspan="2">Hardware<td>Displays information related to the TWL system.
197<tr><th>  
198<td>BoxCount<td>• <CODE>used</CODE> indicates the number of installed NAND applications.<br>• <CODE>free</CODE> indicates the remaining number of NAND applications that can be installed.
199<tr><th colspan="2">Media<td>Displays information related to the system memory.
200<tr><th rowspan="2">  
201<td>Free<td>Displays the available space in blocks and KB.
202<tr><td>Total<td>Displays the total space in blocks and KB.
203</tbody>
204</table>
205
206<p>
207Page 2
208</p>
209<table class="table">
210<tbody>
211<tr><th colspan="2">Item<th>Description
212<tr><th colspan="2">Title<td>Displays information related to the selected NAND application.
213<tr><th rowspan="8">  
214<td>CompanyCode<td>Displays the Company Code in ASCII and hexadecimal.
215<tr><td>InitialCode<td>Displays the Game Code in ASCII and hexadecimal.
216<tr><td>GameVersion<td>Displays the game version.
217<tr><td>TitleSize<td>Displays the space occupied by the NAND application in units of blocks and kilobytes.
218<tr><td>AppSize<td>Displays the size of the SRL in blocks and KB.
219<tr><td>PublicSave<td>Displays the size of the public save data in blocks and KB.
220<tr><td>PrivateSave<td>Displays the size of the private save data in blocks and KB.
221<tr><td>SubBanner<td>Displays the size of the sub-banner in blocks and in KB. When a sub-banner is configured, a fixed size of 16 KB is displayed. Otherwise, 0 KB is displayed.
222</tbody>
223</table>
224<p>
225The size occupied by the NAND application, <CODE>TitleSize</CODE>, is calculated using the following formula. This is not the sum of the displayed block counts, but rather the sum of the byte counts which is then converted into a block count.
226</p>
227<table class="plain" style="width:0"><tr><td>
228<pre>
229Size (in KB) occupied by a NAND application = SRL size (in KB) rounded up to 16 KB +
230                           the public save data size (in KB) +
231                           the private save data size (in KB) +
232                           the sub-banner size (in KB) +
233                           16 KB
234Size (in blocks) occupied by a NAND application = Size (in KB) occupied by the NAND application rounded up to 128 KB
235</pre>
236</td></tr></table>
237
238<h5>Starting NAND Applications</h5>
239<p>
240Press START to run the selected NAND application. Once the NAND application is started, TWL Nmenu will give up all control. To return to TWL Nmenu, you must run TWL Nmenu again.
241</p>
242
243<h5>Deleting NAND Applications</h5>
244<p>
245Press the X Button to uninstall the selected NAND application from NAND. Even if a NAND application is deleted, information about the fact that it used to be installed remains within the TWL system. For applications in this state, only the Game Code will be displayed in light blue within the list on the lower screen. Furthermore, performing a <I>delete</I> operation on applications in this state will remove all traces of them.
246</p>
247
248<h5>Clearing the Private Save Data of NAND Applications</h5>
249<p>
250All private save data of the selected NAND application is deleted. The TWL system provides a feature that allows the user to back up NAND applications to SD Cards. However, the private save data region will not be backed up by this feature. Because the private save data is not backed up, it will be cleared when the system memory is restored from a backup. For this reason, NAND applications must consider the case in which only the private save data is cleared. This situation can be recreated by using TWL Nmenu to clear the private save data.
251</p>
252
253<h5>Deleting NAND Applications of the Same Type</h5>
254<p>
255When deleting NAND applications of the same type, delete all NAND applications that are the same as the selected NAND application from the perspective of whether the NAND applications have been deleted. For example, if an undeleted NAND application has been selected, all undeleted NAND applications will be deleted.
256</p>
257
258
259<br clear="all">
260
261<h4>SD Mode<br>Card Mode</h4>
262<div class="screen"><img class="main" src="TwlNmenu/SD_main_0.png"><br><img src="TwlNmenu/SD_sub_0.png"></div>
263<div class="screen"><img class="main" src="TwlNmenu/SD_main_1.png"><br><img src="TwlNmenu/SD_sub_1.png"></div>
264<p>
265In <B>SD</B> mode and <B>Card</B> mode, the files on the SD Card or DS Card will be displayed on the lower screen.<br> In this mode, you can import TAD files.<FONT color=#ff0000> File and directory names are not displayed if they use characters that cannot be converted to Shift_JIS.</FONT>
266</p>
267<p>
268<B>Card</B> mode can be used only when Twl Nmenu has been started as a NAND application. Furthermore, a DS card must be inserted into the card slot before Twl Nmenu is started. A DS card inserted after starting Twl Nmenu will not be recognized.
269</p>
270<p>
271Each item in the list displayed on the lower screen shows information about a NAND application in the following format:
272</p>
273<table class="plain" style="width:0"><tr><td>
274<pre>
27505. 866,240  backupSample.tad
276    -------  ----------------
277    1        2
278</pre>
279</tr></td></table>
280<table class="plain" style="width:30em"><tr><td>
281<ol>
282<li>File size or TAD file size in the directory
283<li>File name or directory name
284</ol>
285</tr></td></table>
286
287<br clear="left">
288
289<p>
290The controls for this mode are shown in the table below.
291</p>
292
293<table class="table">
294<tbody>
295<tr><th>Button<th>Operation
296<tr><td>←→  <td>Switches modes.
297<tr><td>↑↓  <td>Selects a file or directory.
298<tr><td>A<td>Imports a TAD file when a TAD file is selected.<br>Moves to the given directory when a directory is selected.
299<tr><td>B<td>Moves up one directory.
300<tr><td>X<td>Moves to the root directory.
301<tr><td>R + A<td>Imports all .tad files within the directory.
302<tr><td>L<td>Moves to the next page on the upper screen.
303<tr><td>SELECT<td>Toggles between showing and hiding the description of the controls.
304</tbody>
305</table>
306
307<p>
308The following information is shown on the upper screen:
309</p>
310
311<p>
312Page 1
313</p>
314<table class="table">
315<tbody>
316<tr><th colspan="2">Item<th>Description
317<tr><th colspan="2">Hardware<td>Displays information related to the TWL system.
318<tr><th>  
319<td>BoxCount<td>• <CODE>used</CODE> indicates the number of installed NAND applications.<br>• <CODE>free</CODE> indicates the remaining number of NAND applications that can be installed.
320<tr><th colspan="2">Media<td>Displays media-related information. This is always 0 in <B>Card</B> mode.
321<tr><th rowspan="2">  
322<td>Free<td>Displays the available space in blocks and KB.
323<tr><td>Total<td>Displays the total space in blocks and KB.
324</tbody>
325</table>
326
327<p>
328Page 2
329</p>
330<table class="table">
331<tbody>
332<tr><th colspan="2">File<td>Displays information related to the selected file.
333<tr><th rowspan="6">  
334<td>CompanyCode<td>Displays the Company Code in ASCII and hexadecimal.
335<tr><td>InitialCode<td>Displays the Game Code in ASCII and hexadecimal.
336<tr><td>GameVersion<td>Displays the game version and the version that has been imported in the system memory.
337<tr><td>FileName<td>Displays the file name.
338<tr><td>LastUpdate<td>Displays the date last modified on the SD Card. This is always 0 in <B>Card</B> mode.
339</tbody>
340</table>
341
342<h5>Importing TAD Files</h5>
343<p>
344Install a TAD file created with <a href="../tools/maketad.html"><CODE>maketad</CODE></a> in the TWL system. If a NAND application having the same game code is already installed, it will be overwritten.<br>Save data is initialized if any of the following are changed: the size of the public save data region, the size of the private save data region, or the presence of a sub-banner.
345</p>
346
347<h5>Importing TwlNmenu and NandFiler</h5>
348<p>
349When <CODE>TwlNmenu.tad</CODE> or <CODE>NandFiler.tad</CODE> is imported from the <CODE>$TwlSDK/bin/ARM9-TS/Rom</CODE> directory, the following error may be displayed.
350</p>
351<table class="plain" style="width:0"><tr><td>
352<pre>
353Failed to import ****.tad.
354The data may be corrupt. (-1022)
355</pre>
356</tr></td></table>
357<p>
358In this case, you can normally install it by re-importing it.
359</p>
360<H2>Location</H2>
361<P>
362<CODE>$TwlSDK/bin/ARM9-TS/Rom/TwlNmenu.srl</CODE><br> <CODE>$TwlSDK/bin/ARM9-TS/Rom/TwlNmenu.tad</CODE><br>
363</P>
364
365
366<H2>See Also</H2>
367
368
369<H2>Revision History</H2>
370<P>
3712009/08/20 Added a note regarding initialization of save data.<br>2009/05/27 Added a note about importing <CODE>TwlNmenu.tad</CODE> and <CODE>NandFiler.tad</CODE> files.<br>2009/05/22 Added SubBanner in NAND mode. Explained how <CODE>TitleSize</CODE> is calculated. <br>2009/04/30 Added a cautionary note about file and directory names in SD mode. <br>2008/10/16 Added information related to Card mode and displaying Japanese. <br>2008/07/11 Added support for a <CODE>TwlNmenu</CODE> update. <br>2008/04/25 Deleted ROM mode, Backup, and Restore. <br>2008/03/19 Made descriptions compliant with the terminology. Adjusted phrasing.<br>2007/12/20 Initial version.
372</P>
373
374
375<hr><p>CONFIDENTIAL</p></body>
376</HTML>
377