TwlToolsRED/docs/MenuSkipFlagTool/Readme.html
nishikawa_takeshi 09a6931588 使用上の注意を追記。
git-svn-id: file:///Users/lillianskinner/Downloads/platinum/twl/TwlToolsRED@302 7061adef-622a-194b-ae81-725974e89856
2009-06-22 08:47:33 +00:00

621 lines
17 KiB
HTML

<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.5: http://docutils.sourceforge.net/" />
<title>TWLメニュースキップフラグ立てツール</title>
<style type="text/css">
/*
:Author: David Goodger (goodger@python.org)
:Id: $Id$
:Copyright: This stylesheet has been placed in the public domain.
Default cascading style sheet for the HTML output of Docutils.
See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
customize this style sheet.
*/
/* used to remove borders from tables and images */
.borderless, table.borderless td, table.borderless th {
border: 0 }
table.borderless td, table.borderless th {
/* Override padding for "table.docutils td" with "! important".
The right padding separates the table cells. */
padding: 0 0.5em 0 0 ! important }
.first {
/* Override more specific margin styles with "! important". */
margin-top: 0 ! important }
.last, .with-subtitle {
margin-bottom: 0 ! important }
.hidden {
display: none }
a.toc-backref {
text-decoration: none ;
color: black }
blockquote.epigraph {
margin: 2em 5em ; }
dl.docutils dd {
margin-bottom: 0.5em }
/* Uncomment (and remove this text!) to get bold-faced definition list terms
dl.docutils dt {
font-weight: bold }
*/
div.abstract {
margin: 2em 5em }
div.abstract p.topic-title {
font-weight: bold ;
text-align: center }
div.admonition, div.attention, div.caution, div.danger, div.error,
div.hint, div.important, div.note, div.tip, div.warning {
margin: 2em ;
border: medium outset ;
padding: 1em }
div.admonition p.admonition-title, div.hint p.admonition-title,
div.important p.admonition-title, div.note p.admonition-title,
div.tip p.admonition-title {
font-weight: bold ;
font-family: sans-serif }
div.attention p.admonition-title, div.caution p.admonition-title,
div.danger p.admonition-title, div.error p.admonition-title,
div.warning p.admonition-title {
color: red ;
font-weight: bold ;
font-family: sans-serif }
/* Uncomment (and remove this text!) to get reduced vertical space in
compound paragraphs.
div.compound .compound-first, div.compound .compound-middle {
margin-bottom: 0.5em }
div.compound .compound-last, div.compound .compound-middle {
margin-top: 0.5em }
*/
div.dedication {
margin: 2em 5em ;
text-align: center ;
font-style: italic }
div.dedication p.topic-title {
font-weight: bold ;
font-style: normal }
div.figure {
margin-left: 2em ;
margin-right: 2em }
div.footer, div.header {
clear: both;
font-size: smaller }
div.line-block {
display: block ;
margin-top: 1em ;
margin-bottom: 1em }
div.line-block div.line-block {
margin-top: 0 ;
margin-bottom: 0 ;
margin-left: 1.5em }
div.sidebar {
margin: 0 0 0.5em 1em ;
border: medium outset ;
padding: 1em ;
background-color: #ffffee ;
width: 40% ;
float: right ;
clear: right }
div.sidebar p.rubric {
font-family: sans-serif ;
font-size: medium }
div.system-messages {
margin: 5em }
div.system-messages h1 {
color: red }
div.system-message {
border: medium outset ;
padding: 1em }
div.system-message p.system-message-title {
color: red ;
font-weight: bold }
div.topic {
margin: 2em }
h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
margin-top: 0.4em }
h1.title {
color: #ffffff;
background-color: #8dc63f;
padding: 0.5em;
font-size: 24px;
font-weight: bold;
border-style: double;
border-width: 3px 5px;
border-color: #009900;
text-align: center }
h2.subtitle {
text-align: center }
hr.docutils {
width: 75% }
img.align-left {
clear: left }
img.align-right {
clear: right }
ol.simple, ul.simple {
margin-bottom: 1em }
ol.arabic {
list-style: decimal }
ol.loweralpha {
list-style: lower-alpha }
ol.upperalpha {
list-style: upper-alpha }
ol.lowerroman {
list-style: lower-roman }
ol.upperroman {
list-style: upper-roman }
p.attribution {
text-align: right ;
margin-left: 50% }
p.caption {
font-style: italic }
p.credits {
font-style: italic ;
font-size: smaller }
p.label {
white-space: nowrap }
p.rubric {
font-weight: bold ;
font-size: larger ;
color: maroon ;
text-align: center }
p.sidebar-title {
font-family: sans-serif ;
font-weight: bold ;
font-size: larger }
p.sidebar-subtitle {
font-family: sans-serif ;
font-weight: bold }
p.topic-title {
font-weight: bold }
pre.address {
margin-bottom: 0 ;
margin-top: 0 ;
font-family: serif ;
font-size: 100% }
pre.literal-block, pre.doctest-block {
margin-left: 2em ;
margin-right: 2em }
span.classifier {
font-family: sans-serif ;
font-style: oblique }
span.classifier-delimiter {
font-family: sans-serif ;
font-weight: bold }
span.interpreted {
font-family: sans-serif }
span.option {
white-space: nowrap }
span.pre {
white-space: pre }
span.problematic {
color: red }
span.section-subtitle {
/* font-size relative to parent (h1..h6 element) */
font-size: 80% }
table.citation {
border-left: solid 1px gray;
margin-left: 1px }
table.docinfo {
margin: 2em 4em }
table.docutils {
ailgn : center;
margin-top: 0.5em ;
margin-bottom: 0.5em }
table.footnote {
border-left: solid 1px black;
margin-left: 1px }
table.docutils td, table.docutils th,
table.docinfo td, table.docinfo th {
padding-left: 0.5em ;
padding-right: 0.5em ;
vertical-align: top }
table.docutils th.field-name, table.docinfo th.docinfo-name {
font-weight: bold ;
text-align: left ;
white-space: nowrap ;
padding-left: 0 }
h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
font-size: 100% }
ul.auto-toc {
list-style-type: none }
/*** added by seiki ***/
/** common settings *********************************/
body {
font-size : 12px;
text-align : center;
line-height : 140%;
color : #330000;
background-color : #e3e5e6;
}
td, th {
font-size : 12px;
color : #336600;
}
a:link {
text-decoration : none;
color : #339966;
}
a:visited {
text-decoration : none;
color : #666633;
}
a:active {
text-decoration : underline;
color : #ff6600;
}
a:hover {
text-decoration : underline;
color : #ff6600;
}
/** general styles *******************************/
h1 {
color : #009900;
background-color : #ccff66;
padding : 4px;
font-size : 16px;
font-weight : bold;
text-align : left;
margin-top : 1.5em;
border-style : solid;
border-width : 1px 3px;
border-color : #009900;
}
h1 a:hover {
text-decoration : none;
color : #009900;
}
h2 {
color : #336633;
font-size : 16px;
margin-left : 0.5em;
margin-top : 1.5em;
border-style : solid;
border-width : 0 0 1px 5px;
border-color : #339933;
padding-left : 4px;
}
h2 a:hover {
text-decoration : none;
color : #336633;
}
h3 {
color : #339933;
font-size : 12px;
margin-left : 2.0em;
border-style : dotted;
border-width : 0 0 1px 0;
border-color : #66cc66;
}
h3 a:hover {
text-decoration : none;
color : #339933;
}
h4 {
color : #339933;
font-size : 12px;
margin-left : 2.0em;
border-style : dotted;
border-width : 0 0 1px 0;
border-color : #66cc66;
}
h3 a:hover {
text-decoration : none;
color : #339933;
}
p {
margin-left : 3em;
margin-top : 3px;
margin-bottom : 6px;
text-indent : 0em;
line-height : 150%;
}
dt {
font-weight: bold;
margin-top: 0.5em;
margin-left: 2em;
}
dd {
margin-left: 4em;
}
dd p {
margin-left: 0;
text-indent: 0;
line-height: 140%;
}
.author {
font-weight: bold;
text-align: right;
margin-top: 0.5em;
margin-bottom: 0.5em;
}
ul.author li {
list-style-type: none;
}
div.document {
border : solid 1px #666666;
margin : 0pt auto;
padding : 1em 1.5em 1em 1em;
background-color : #ffffff;
text-align : left;
width : 800px;
}
</style>
</head>
<body>
<div class="document" id="twl">
<h1 class="title">TWLメニュースキップフラグ立てツール</h1>
<ul class="simple">
<li>目次<ul>
<li><a class="reference internal" href="#id1">TWLメニュースキップフラグ立てツールとは?</a></li>
<li><a class="reference internal" href="#id2">パッケージ内容</a></li>
<li><a class="reference internal" href="#id4">使用上の注意</a></li>
<li><a class="reference internal" href="#id3">対応タイトル</a></li>
<li><a class="reference internal" href="#id5">動作</a></li>
<li><a class="reference internal" href="#id8">実行方法</a></li>
<li><a class="reference internal" href="#id11">プログラムの返り値</a></li>
<li><a class="reference internal" href="#id12">オプション</a></li>
<li><a class="reference internal" href="#id15">変更履歴</a></li>
</ul>
</li>
</ul>
<div class="section" id="id1">
<h1>TWLメニュースキップフラグ立てツールとは?</h1>
<p>TWL試遊台タイトルでは、
「健康と安全について」の画面およびDSiメニューをスキップする必要があります。</p>
<p>本ツールは、入力されたROMデータに対して、
上記をスキップするためのフラグを立て、別ファイルに出力します。</p>
</div>
<div class="section" id="id2">
<h1>パッケージ内容</h1>
<ul class="simple">
<li>MenuSkipFlagTool.exe : フラグ立てツール</li>
<li>MenuSkipFlagTool_Checker.exe : MenuSkipFlagTool.exe の検査ツール</li>
</ul>
</div>
<div class="section" id="id3">
<h1>対応タイトル</h1>
<ul class="simple">
<li>TWLタイトル<ul>
<li>SRL形式のみに対応しています。TAD形式には対応していませんので、ご注意ください。</li>
</ul>
</li>
<li>NITROタイトル</li>
</ul>
</div>
<div class="section" id="id4">
<h1>使用上の注意</h1>
<p>本ツールは、一般開発者が行なうことができないROM設定を可能にするツールです。</p>
<p>「健康と安全について」の画面をスキップするタイトルがユーザに渡るのは好ましくなく、
さらに、DSiメニューをスキップする方法が知られることが思わぬセキュリティホールにつながる可能性もあるため、
本ツールの部外への配布をしないように注意してください。
部外に配布する必要が生じた場合には、開発技術部にご確認ください。</p>
</div>
<div class="section" id="id5">
<h1>動作</h1>
<div class="section" id="id6">
<h2>概要</h2>
<ul class="simple">
<li>入力<ul>
<li>SRLファイル (TWL-ROM/NITRO-ROM両対応)</li>
<li>&quot;1&quot; もしくは &quot;0&quot; (フラグを立てる場合 &quot;1&quot;、立てない場合 &quot;0&quot;)</li>
</ul>
</li>
<li>出力<ul>
<li>SRLファイル (入力ファイルとは別のファイル名)</li>
</ul>
</li>
<li>処理<ul>
<li>&quot;1&quot; が入力されたとき、フラグを立てたROMファイルを出力する。</li>
<li>&quot;0&quot; が入力されたとき、データを加工しない。(つまり、入力ROMファイルを出力ROMファイルにコピーだけ。)</li>
</ul>
</li>
</ul>
</div>
<div class="section" id="id7">
<h2>フローチャート</h2>
<img alt="tool_flowchart.gif" src="tool_flowchart.gif" />
</div>
</div>
<div class="section" id="id8">
<h1>実行方法</h1>
<div class="section" id="id9">
<h2>フラグ立て処理の実行</h2>
<p>WindowsXP付属のコマンドプロンプト、もしくはcygwinから実行してください。</p>
<blockquote>
<ul class="simple">
<li>MenuSkipFlagTool.exe (入力SRLファイル名) (出力SRLファイル名) (1もしくは0)</li>
</ul>
</blockquote>
<p>1を指定した場合、フラグを立てる処理をします。
0を指定した場合には、何もデータを加工せずに、入力SRLファイルを
出力SRLファイルにコピーするだけの処理をします。</p>
<p>プログラムの途中で、エラーがあった場合、処理を中断します。
このとき、作成途中であった、出力SRLファイルは削除されます。</p>
</div>
<div class="section" id="id10">
<h2>フラグ立て処理の検査</h2>
<p>MenuSkipFlagTool.exe の処理が正しいかどうかを同梱の MenuSkipFlagTool_Checker.exe を用いて
チェックすることができます。</p>
<p>MenuSkipFlagTool_Checker.exe は、MenuSkipFlagTool.exe において、
フラグが立てられたかどうか(もしくは、立てられていないかどうか)、および、余分なデータが書き換えられていないかをチェックします。</p>
<blockquote>
<ul class="simple">
<li>MenuSkipFlagTool_Checker.exe (フラグ立て処理前のSRLファイル名) (フラグ立て処理後のSRLファイル名) (1もしくは0)</li>
</ul>
</blockquote>
<p>(注意)
MenuSkipFlagTool_Checker.exe のコマンドライン引数には、 <strong>MenuSkipFlagTool.exe と同じもの</strong> を指定してください。</p>
</div>
</div>
<div class="section" id="id11">
<h1>プログラムの返り値</h1>
<div class="section" id="menuskipflagtool-exe">
<h2>MenuSkipFlagTool.exe</h2>
<p>コマンドラインから MenuSkipFlagTool.exe を実行したとき、
プログラムの終了後、以下の返り値が設定されます。</p>
<blockquote>
<ul class="simple">
<li>正常終了の場合 : 0 が設定されます。</li>
<li>エラーが発生した場合 : -1 が設定されます。</li>
</ul>
</blockquote>
<p>返り値は、Windowsコマンドプロンプトの場合、
%ERRORLEVEL%環境変数に格納されますので、
バッチファイルなどの分岐に利用することができます。</p>
<p>また、cygwinのシェルを使用した場合には、返り値の格納先は、
%ERRORLEVEL%環境変数ではなく、シェル変数 $? となります。
ただし、cygwinシェルの場合、先述の返り値 -1 は 255 となります。</p>
</div>
<div class="section" id="menuskipflagtool-checker-exe">
<h2>MenuSkipFlagTool_Checker.exe</h2>
<p>一方、MenuSkipFlagTool_Checker.exe では、以下の返り値が設定されます。</p>
<blockquote>
<ul class="simple">
<li>処理が正常であると判断した場合 : 0 が設定されます。</li>
<li>異常を発見した場合 : -1 が設定されます。</li>
</ul>
</blockquote>
</div>
</div>
<div class="section" id="id12">
<h1>オプション</h1>
<div class="section" id="id13">
<h2>MenuSkipFlagTool.exe</h2>
<p>実行の際に、以下のオプションを指定することができます。</p>
<ul class="simple">
<li>-d オプション</li>
</ul>
<p>通常、1が指定されているとき、メニュースキップフラグを立てる処理が実行されますが、
-d オプションを指定した場合、フラグを下ろす処理となります。
フラグがすでに下りている場合、何もしません。</p>
<ul class="simple">
<li>-f オプション</li>
</ul>
<p>通常、出力ファイルがすでに存在する場合、上書き確認を行いますが、-fオプションを指定した場合、
上書き確認をせずに、強制的に上書きします。</p>
<ul class="simple">
<li>-h オプション</li>
</ul>
<p>使用方法を表示して終了します。</p>
</div>
<div class="section" id="id14">
<h2>MenuSkipFlagTool_Checker.exe</h2>
<ul class="simple">
<li>-d オプション</li>
</ul>
<p>通常、1が指定されているとき、メニュースキップフラグが立てられたかどうかが検査されますが、
-d オプションを指定した場合、フラグが下ろされたかどうかが検査されます。
MenuSkipFlagTool.exe において -d オプションを指定した場合に、
MenuSkipFlatTool_Checker.exe においても -d オプションをご指定ください。</p>
<ul class="simple">
<li>-h オプション</li>
</ul>
<p>使用方法を表示して終了します。</p>
</div>
</div>
<div class="section" id="id15">
<h1>変更履歴</h1>
<ul>
<li><p class="first">ver.1.0 (2009/06/22)</p>
<p>初版</p>
</li>
</ul>
</div>
</div>
</body>
</html>