詳細な仕様

TWELITE STAGE APP の詳細な仕様

1: コマンドライン引数とiniファイルによる詳細設定

2: 環境変数

3: 000desc.txt によるプロジェクト説明の追加

1 - コマンドライン引数とiniファイルによる詳細設定

コマンドライン引数とiniファイルによる TWELITE STAGE APP の詳細設定

コマンドライン引数

コマンドライン引数は、TWELITE STAGE APPのいくつかの細かい設定を行います。

コマンドライン引数	内容
-E 0	フェードアウトのようなグラフィカルな効果を無効にする。
-R {type}	{type} 値でレンダリングタイプを設定します。 0: デフォルト 1: OpenGL 2: DirectX(Windows) Metal(macOS) 3: ソフトウェア
-J	ゲームコントローラーを有効にします。
-x {x_pos}, -y {y_pos}	起動時のTWELITE STAGE Appのグラフィカルウィンドウの位置を設定します。 {x_pos}と{y_pos}はウィンドウの左上のスクリーン座標です。

iniファイル

iniファイルはTWELITE STAGE APPの基本的な設定(MWSDKのフォルダを参照するなど)を行うために使用されます。

iniファイル名は{TWELITE STAGE APPの実行ファイルのベース名} + .ini です。通常は TWELITE_Stage.ini となります。

;;; MWSDKの参照を変更します。
; MWSDK=MWSDK
mwsdk=mwsdk2020_10

;;; インターフェース言語
; LANG=en

;;; ウィンドウのジオメトリ
GEOM_X=200
GEOM_Y=100

シンタックス

ini ファイルはプレーンテキストファイルとして記述される。
キーと値は = で区切られた1行に格納される (例: KEY=value)。
キーと値の文字列は行頭から始まる(キーの前に空白や他の文字は許されない)。
キーと値の間にスペースを入れてはならない。
コメント行は ; または # を行頭に追加する。

設定

キー	値
MWSDK	MWSDKのフォルダを変更する。デフォルトのフォルダは、TWELITE STAGE APPの実行ファイルが置かれているのと同じフォルダにある MWSDK です。古いMWSDKやカスタムMWSDKを使用する必要がある場合は、そのフォルダの名前を指定することができます。
LANG	LANG=en は、ユーザーインターフェースの言語をデフォルト(日本語)から英語に変更します。
GEOM_X, GEOM_Y	TWELITE STAGEアプリのウィンドウが表示される場所を変更する。

異なる設定の TWELITE STAGE APP を実行する

異なる設定の TWELITE STAGE APP が必要な場合は、TWELITE STAGE APPと同じフォルダに実行ファイルをコピーして、同じ名前の .ini ファイルを作成します。

例えば、英語のインターフェースを使用する場合、TWELITE_Stage.exe(注: .exe はWindowsの実行ファイルの拡張子)を TWELITE_Stage_en.exe にコピーして、 LANG=en の設定を TWELITE_Stage_en.ini に書き込むことで、英語のインターフェースを有効化した実行ファイルを作成できます。

  TWELITE_Stage.exe
  TWELITE_Stage.ini | 特別な設定なし

  TWELITE_Stage_ja.exe | TWELITE_Stage.exe のコピー
  TWELITE_Stage_en.ini | LANG=en が設定されている。

2 - 環境変数

TWELITE STAGE APP が使用する環境変数

TWELITE STAGE APP では、内部的に環境変数を設定して make などのビルドプログラムの動作を行います。事前に環境変数の設定は不要です。

内部的に設定される環境変数

環境変数	解説
`MWSDK_ROOT`	標準では TWELITE STAGE APP の実行形式が格納されるフォルダにある `MWSDK` フォルダ(つまり`../MWSTAGE/MWSDK`)が指定されます。 `MWSDK.ini`が指定される場合は、指定されたフォルダ名を採用します。
`MWSDK_TWENET_LIBSRC`	サンプルコードやTWELITE APPSのソースコードフォルダには、Microsoft社の Visual Studio Code (VS Code) 用の定義ファイルを予め作成しています。この定義ファイル中にVS Codeエディタ中でコード解釈を行う目的でライブラリソースコードの参照先を指定しますが、この環境変数を用いています。 `MWSDK_TWENET_LIBSRC`環境変数が適切に指定されると、`MWSDK`以下ではないプロジェクトフォルダでもコード解釈が行われ、ライブラリ関数名の補完などが機能します。（参考）
`LANG=C`	ツールチェインのメッセージを規定の言語(英語)にするため、明示的に設定しています。
`PATH`	Windowsでは、SDK添付のmsysユーティリティへのPATHを追加します。
`MWSDK_MAKE_JOBS` `MWSDK_MAKE_DISABLE_LTO`	VS Codeの設定定義で利用します。 `JOBS` : STAGE APPで設定された並列ビルド数を渡します `DISABLE_LTO` : LTOを無効化します( Windows )

参考

.vscode/settings.json の設定例（抜粋）

    "C_Cpp.default.includePath": [
        "${env:MWSDK_TWENET_LIBSRC}/include/**",
        "${env:MWSDK_TWENET_LIBSRC}/src/**"
    ],
    "C_Cpp.default.browse.path": [
        "${env:MWSDK_TWENET_LIBSRC}/include/**",
        "${env:MWSDK_TWENET_LIBSRC}/src/**"
    ],

"../../"で始まる定義は、TWELITE STAGEアプリからプロジェクトを開く場合は不要です。環境変数MWSDK_TWENET_LIBSRCを設定しない場合に、既定のフォルダ構成の時にソース参照先を指定しています。

3 - 000desc.txt によるプロジェクト説明の追加

000desc.txt によるプロジェクト説明の追加方法について

プロジェクトフォルダに000desc.txtを作成した場合には、TWELITE STAGE APP が、プロジェクトフォルダの一覧にその内容を表示します。

ファイルは UTF-8 形式のプレーンテキストで記述します。書式は以下の２種類があります。

書式1

スイッチを押した時にLEDを点灯
act4はTWELITE DIPに接続されたスイッチを押した時にLEDを点灯させるactを動作させます。
https://mono-wireless.com/jp/products/act/index.html

1行目はタイトル行です。
2行目以降は詳細の記述です。
最終行が http で始まる場合は、ウェブサイトへのリンクになります。

書式2

[JAPANESE]
TITLE=actのテンプレート
DESC=中身が何もない setup(), loop() のみのファイルです。
新しく act を記述するのに利用してください。
URL=jp/MWX/content/Act_samples/README.html
[ENGLISH]
TITLE=act empty template
DESC=This act file only contains empty setup() and loop(),
which is intended to write a new act.
URL=en/MWX/content/Act_samples/README.html

iniファイルのような書式です。行頭から始まる項目名と=文字までを項目の定義として=以降が項目の内容です。

項目定義	詳細
`[JAPANESE]`, `[ENGLISH]`	ブロックの区切り
`TITLE=`	タイトル行
`DESC=`	詳細の記述。改行を含めて複数行にすることもできます。
`URL=`	ウェブサイトまたはファイルへのリンク

URL 指定について

URL=	詳細
`https:`, `http:` で始まる	そのアドレスを開きます
それ以外	`{MWSDK_ROOT}/docs/` を起点とした相対フォルダを指定します。 `a/b/c.html` とした場合は `{MWSDK_ROOT}/docs/a/b/c.html` に変換されます。