マスタエディタの全ドキュメントをTwlIPLから移動してきた。

git-svn-id: file:///Users/lillianskinner/Downloads/platinum/twl/TwlToolsRED@180 7061adef-622a-194b-ae81-725974e89856

docs/MasterEditorTWL/Readme.txt

@@ -0,0 +1,63 @@
+=============================================================================
+ NINTENDO TWL Master Editor
+      Jan 30, 2009
+=============================================================================
+
+* 目次
+- はじめに
+- パッケージ構成
+- 必要な環境
+- 使用方法
+- 変更履歴
+
+=======================================================================
+はじめに
+=======================================================================
+
+このパッケージには、TWLマスターエディタとよばれる、
+TWL提出用マスターデータを作成するためのツールが含まれています。
+
+=======================================================================
+パッケージ構成
+=======================================================================
+
+MasterEditorTWLSetup.msi          : インストーラ
+MasterEditorTWL_Manual_Jp.pdf     : 使用方法の解説書
+TWL_SubmissionSheet_Sample_Jp.pdf : マスターROM提出確認書のサンプル
+
+=======================================================================
+必要な環境
+=======================================================================
+Microsoft WindowsXP SP2
+Microsoft .NET Framework 2.0
+
+=======================================================================
+使用方法
+=======================================================================
+「MasterEditorTWL_Manual_Jp.pdf」をご参照ください。
+
+=======================================================================
+変更履歴
+=======================================================================
+■ver.1.3 (2009/01/30)
+  ・DSiウェアのNANDメモリ使用量を表示する機能を追加。
+  ・コマンドラインからの起動に対応。
+  ・マスターROM提出確認書の書式を変更。
+
+■ver.1.2 (2008/12/18)
+  ・TAD形式ファイルの入力に対応。
+  ・アプリ起動を制限するためのフラグ(EULAなど)を設定不可にした。
+  ・レーティング設定で「レーティング表示不要」を選択可能にした。
+  ・不要な項目の表示を削除。
+  ・提出書類の出力ファイル名を自動で設定する仕様に変更。
+  ・入力ROMファイルのドラッグ&ドロップを受け付ける領域をウインドウ全体に変更。
+  ・マスターROM提出確認書の書式を変更。
+
+■ver.1.1 (2008/10/20)
+  ・ROMチェック機能のリマスターバージョンのチェックを変更。
+  ・提出バージョンの範囲を変更。
+  ・マスターROM提出確認書の書式を変更。
+
+■ver.1.0 (2008/10/09)
+  ・初版
+

docs/MasterEditorTWL/マスターエディタ設定ファイル解説.txt

@@ -0,0 +1,105 @@
+=============================================================================
+ TWLマスターエディタ 設定ファイルの解説
+=============================================================================
+
+* 目次
+- はじめに
+- 追加設定ファイルの置き場所
+- 設定項目の解説
+- 変更履歴
+
+
+=======================================================================
+はじめに
+=======================================================================
+
+TWLマスターエディタには、動作を変更するための設定ファイルが存在します。
+DEA-SUPなどで公開されているパッケージには、基本の設定ファイルのみが含まれますが、
+それとは別に、追加動作を設定できる追加設定ファイルが存在します。(ver.1.2以降)
+追加設定ファイルは非公開であり、インストールパッケージには含まれません。
+
+追加設定ファイルを読み込ませることで、以下の追加動作が可能となります。
+
+ ・非公開情報の項目(Shared2ファイルサイズなど)の表示。
+ ・Shared2ファイルサイズが正しいかどうかのチェック。
+ ・SDKバージョンのチェック。
+
+ver.1.1 では、追加設定ファイルは存在しませんでしたが、
+ver.1.2 以降は、追加動作に関する設定を追加設定ファイルとして分離しました。
+
+
+=======================================================================
+追加設定ファイルの置き場所
+=======================================================================
+
+ファイル名は、append_ini.xml です。
+マスターエディタのインストールフォルダ以下に置く必要があります。
+インストールフォルダを C:\Nintendo\MasterEditorTWL とすると、
+append_ini.xml を C:\Nintendo\MasterEditorTWL\resource\ に置いてください。
+(基本設定ファイル ini.xml が置かれているフォルダのことです。)
+
+マスターエディタを起動すると、自動的に追加設定ファイルが読み込まれます。
+
+*** 注意 ***
+追加設定ファイルのファイル名を appned_ini.xml から変更しないでください。
+
+
+=======================================================================
+設定項目の解説
+=======================================================================
+
+追加設定ファイルはXML形式で記述されており、各タグの値を変更することで、
+設定を変更することができます。
+間違った指定をした場合には、正しい動作をしませんのでご注意ください。
+
+・<visible>タグ
+  非公開情報を表示するかどうかを指定します。表示する場合には"ON"を指定してください。
+
+・<spcheck>タグ
+  通常のマスターエディタのROMチェックに加えて、追加チェックをするかどうかを指定します。
+  追加チェックでは、ROMをスキャンして得られたSDKバージョンとShared2ファイルサイズが、
+  追加設定ファイル中で指定した値と一致するかどうかをチェックし、
+  一致しない場合には、マスターエディタの"エラー情報(確認用)"タブに警告が表示されます。
+  追加チェックをする場合には"ON"、しない場合には"OFF"を指定してください。
+
+・<sdk>タグ
+  追加チェックにおいて、SRL中のSDKバージョンと比較される値を指定します。
+  以下の子タグを設定してください。
+  <spcheck>タグを"OFF"にしている場合には、これらの値は無視されます。
+
+    <major> : SDKのメジャーバージョンを指定してください。
+    <minor> : SDKのマイナーバージョンを指定してください。
+    <relstep> : SDKのリリースバージョンをSDKの規則にしたがって指定してください。
+                (SDKの規則を以下に抜粋します。)
+                relstepの大小判定はSRL中のSDKバージョンがRELEASE版のときのみに行なわれますので、
+                30000以上の値を指定してください。
+
+                PR1=10100 PR2=10200 ...
+                RC1=20100 RC2=20200 ...
+                RELEASE=30000
+
+                (注)patch が当てられた場合には、10100 → 10101 といったように、
+                    下位の値がインクリメントされます。
+
+  なお、SDKバージョンのチェックでは、DSダウンロードプレイ子機プログラムなど、
+  プログラム本体ではないバイナリのSDKバージョンもチェックします。
+
+・<shared2>タグ
+  追加チェックにおいて、SRL中のShared2ファイルサイズと比較される値を指定します。
+  子タグ<file0>～<file5>にファイル0～ファイル5のサイズを単位を「バイト」として指定してください。
+  <spcheck>タグを"OFF"にしている場合には、これらの値は無視されます。
+
+  例えば、ファイル0が2MBの場合には、<file0>子タグに 2097152 を指定してください。
+
+
+=======================================================================
+変更履歴
+=======================================================================
+
+■ 2008/12/10
+  ・MasterEditorTWL ver.1.2 で削除されたタグについての記述を削除。
+  ・MasterEditorTWL ver.1.2 の追加設定ファイルについて記述。
+
+■ 2008/11/27
+  ・公開中の MasterEditorTWL ver.1.1 の設定ファイルについて記述。
+

docs/MasterEditorTWL/提出確認書チェッカ/README.txt

@@ -0,0 +1,234 @@
+=============================================================================
+ TWL提出確認書チェッカー
+=============================================================================
+
+* 目次
+- 提出確認書チェッカーとは?
+- パッケージ内容
+- 動作環境
+- 実行方法
+- 出力
+- エラーコード
+- オプション
+- 変更履歴
+
+* --------------------------------------------------------------------
+* 提出確認書チェッカーとは?
+* --------------------------------------------------------------------
+
+マスターROM提出確認書とSRLが一致するかを照合するツールです。
+WindowsXPで動作し、オプションによって、
+GUIでの操作とコンソール画面(コマンドプロンプト)上での操作を切り替えることができます。
+コンソール画面上での操作は、バッチファイルやスクリプトに
+組み込むことを考慮して用意しています。
+
+また、提出確認書から提出バージョンを抜き出して表示したり、
+リマスターバージョンと提出バージョンからTADバージョンの計算もできます。
+
+
+* --------------------------------------------------------------------
+* パッケージ内容
+* --------------------------------------------------------------------
+
+SheetCheckerTWL.exe
+  実行バイナリです。
+
+extract_sheet.xsl
+  SheetCheckerTWL.exe の内部で使用されるファイルです。
+  SheetCheckerTWL.exe と同じフォルダに置いてください。
+
+
+* --------------------------------------------------------------------
+* 動作環境
+* --------------------------------------------------------------------
+
+Windows XP SP2 と .NET Framework 2.0 が必要です。
+MasterEditorTWL(TWL用マスターエディタ)がインストールされた環境であれば動作可能です。
+
+
+* --------------------------------------------------------------------
+* 実行方法
+* --------------------------------------------------------------------
+
+GUIで操作するか、コンソール画面上で操作するかによって、起動方法が異なります。
+
+(1)GUI操作の場合
+
+  SheetCheckerTWL.exe のアイコンをダブルクリックするか、
+  コンソール(コマンドプロンプト)上で引数を指定せずに、
+  SheetCheckerTWL.exe を実行してください。
+
+  GUIが起動したら、ボタンを押して、
+  SRLファイルと提出確認書ファイルを選択してください。
+  テキストボックスへのドラッグアンドドロップでも選択可能です。
+  SRLと提出確認書が選択されたら、判定結果が出力されます。
+
+(2)コンソール画面上での操作の場合
+
+  コンソール上で以下の引数をつけて実行してください。
+
+  $ SheetCheckerTWL.exe (SRL) (提出確認書) [オプション]
+
+  たとえば、SRLのファイル名が TNTRJ01.SRL であり、
+  提出確認書のファイル名が SHEET.XML の場合、以下の指定となります。
+
+  $ SheetCheckerTWL.exe  TNTRJ01.SRL  SHEET.XML
+
+  オプションについては後述します。
+  (オプションの指定位置は、引数の先頭や途中でもかまいません。)
+  なお、オプションによっては、引数にSRLを指定せずとも、
+  提出確認書のみの指定で動作するものもあります。
+
+  $ SheetCheckerTWL.exe (提出確認書) (オプション)
+
+
+* --------------------------------------------------------------------
+* プログラムの返り値
+* --------------------------------------------------------------------
+
+  コンソール画面上での操作の場合にのみ、プログラムの返り値があります。
+  判定結果が「OK」の場合には、「0」が返されます。
+  「NG」の場合には、エラーコードが返されます。
+  この返り値は、%ERRORLEVEL%環境変数に格納されますので、
+  バッチファイルなどの分岐に利用することができます。
+  (GUI操作の場合には格納されません。)
+
+  また、cygwinのシェルを使用した場合には、返り値の格納先は、
+  %ERRORLEVEL%環境変数ではなく、シェル変数 $? となります。
+  ただし、「NG」の場合の返り値 -1, -2, ... は 255, 254, ... と解釈されます。
+
+
+* --------------------------------------------------------------------
+* 出力
+* --------------------------------------------------------------------
+
+(1)GUIの場合
+
+  SRLと提出確認書の両方が選択されたら、両者のファイルから、
+  本ツールは、以下の情報を抜き出して比較します。
+
+    ・イニシャルコード
+    ・リマスターバージョン
+    ・ファイルのCRC
+
+  これらがすべて一致した場合には「判定結果」の項目に「OK」が表示されます。
+  一致しない場合には、「NG」とエラーコードが表示されます。
+  また、比較でエラーとなった箇所が赤色で表示されます。
+  (ただし、上記の項目で最初に一致しなかった箇所のみが赤色となります。)
+  エラーコードについては後述します。
+
+  また、以下の情報も表示されます。
+
+    ・提出バージョン
+      -  提出確認書から抜き出されます。
+
+    ・TADバージョン
+      - メジャーバージョンを提出確認書から抜き出されたリマスターバージョンとし
+        マイナーバージョンを提出バージョンとしたときの16bitのTADバージョンです。
+
+(2)CUIの場合
+
+  GUIの場合と同様の情報がコンソール画面に出力されます。
+  以下に例示します。
+
+	SRL:   T0CZA21.SRL
+	Sheet: T0CZA21_SHEET.XML
+
+	                 SRL       Sheet
+	---------------------------------------
+	InitialCode:     0CZA      0CZA
+	RemasterVersion: 02        02
+	File CRC:        39A9      39A9
+	---------------------------------------
+	SubmitVersion:   -         1 (01)
+	TAD Version:     -         513 (0201)
+	---------------------------------------
+	TITLE_TYPE:      -         TWL_GAME
+	---------------------------------------
+	Result:          OK
+
+  NGの場合には、Result の項目に「NG」と表示され、括弧内にエラーコードが出力されます。
+  以下に例示します。
+
+    Result:          NG (-1)
+
+  後述のオプションをつけて実行することによって、出力を変えることができます。
+
+
+* --------------------------------------------------------------------
+* エラーコード
+* --------------------------------------------------------------------
+
+  以下は、「NG」とともに表示されるエラーコードです。
+  (プログラムの返り値ではありません。)
+
+   0  : エラーなし
+  -1  : イニシャルコードが一致しない
+  -2  : リマスターバージョンが一致しない
+  -3  : ファイルCRCが一致しない
+  -4 ～ -7 : 予約
+  -8  : SRLの読み込みに失敗した
+  -9  : 提出確認書の読み込みに失敗した
+  -10 : 引数、あるいはオプションの指定に間違いがある
+
+
+* --------------------------------------------------------------------
+* オプション
+* --------------------------------------------------------------------
+
+コンソール画面上での操作の場合、オプションによって出力を変えることができます。
+スクリプトなどに組み込む場合にご利用ください。
+
+(1) -r オプション
+
+  判定結果のみを出力します。スクリプトなどに組み込む場合にご利用ください。
+  エラーがない場合には「0」が出力されます。
+  エラーの場合には、エラーコードが出力されます。
+  引数には、SRLと提出確認書の2つを指定してください。
+
+(2) -s オプション
+
+  提出バージョンのみを出力します。
+  エラーがない場合には、提出バージョンが10進数で出力されます。
+  maketad でマイナーバージョンを指定する場合には、10進数で指定する必要があるためです。
+  エラーの場合には、エラーコード(-1～)が出力されます。
+  引数には、SRLと提出確認書の2つを指定するか、あるいは、提出確認書のみを指定してください。
+  前者の場合には、SRLと提出確認書が照合され、一致しなかった場合には、エラーコードが出力されますが、
+  後者の場合には、照合はスキップされます。
+
+(3) -t オプション
+
+  TADバージョンのみを出力します。
+  メジャーバージョンを提出確認書から抜き出されたリマスターバージョンとし
+  マイナーバージョンを提出バージョンとしたときの16bitの値が10進数で出力されます。
+  (リマスターバージョンが 01h、提出バージョンが 02h の場合には、258 が出力されます。)
+  エラーの場合には、エラーコード(-1～)が出力されます。
+  CLS処理の場合には、ディレクトリ名を10進数で出力する必要があるためです。
+  引数には、SRLと提出確認書の2つを指定するか、あるいは、提出確認書のみを指定してください。
+  前者の場合には、SRLと提出確認書が照合され、一致しなかった場合には、エラーコードが出力されますが、
+  後者の場合には、照合はスキップされます。
+
+(4) -a オプション
+
+  レーティング表示が不要かどうか(すなわちTYTLE_TYPEがTWL_APPかどうか)のみを出力します。
+  レーティング表示が不要(TWL_APP)のとき「1」が出力されます。
+  それ以外(TWL_GAME)のとき「0」が出力されます。
+  引数には、SRLと提出確認書の2つを指定するか、あるいは、提出確認書のみを指定してください。
+  前者の場合には、SRLと提出確認書が照合され、一致しなかった場合には、エラーコードが出力されますが、
+  後者の場合には、照合はスキップされます。
+
+
+* --------------------------------------------------------------------
+* 変更履歴
+* --------------------------------------------------------------------
+
+○ver.1.1 (2008/12/26)
+  ・オプションによっては引数にSRLを指定せずとも(提出確認書の指定のみで)動作する仕様に変更。
+  ・表示項目に「メディア」と「TITLE_TYPE」の項目を追加。
+  ・-aオプションを追加。
+  ・エラーのときの返り値が-1となっていた間違いを修正し、エラーコードを返り値とした。
+
+○ver.1.0 (2008/11/14)
+  初版
+
+