コマンドラインインターフェイス

Ren'Py にはコマンドラインインターフェイス(CLI)があり、開発タスクの一部自動化や継続的インテグレーション、リリーススクリプトの作成に利用できます。ほとんどの目的ではこれは必要ありません が、これらのタスクはすべてRen'Pyランチャーから実行できます。

このページの例は、Ren'Py SDKのディレクトリ（renpy.py、renpy.sh、renpy.exeが含まれるディレクトリ）からの CLI 実行を前提としています。また、 Linux か macOS での行を前提としています。Windowsの場合は、./renpy.sh を lib\\py3-windows-x86_64\\python.exe renpy.py に置き換える必要があります。

CLIは安定したインターフェースではなく、必要に応じてRen'Pyのリリース間で変更される可能性があります。

<base>

以下のコマンドの説明では、 <base> はプロジェクトのベースディレクトリへのパスです。

ビルドコマンド

注釈

ビルド処理の一環として、 Ren'Py はゲームをロードするための情報を含む .rpyc ファイルを作成します。継続的インテグレーションシステムでは、ビルド後にこれらの .rpyc ファイルを保存し、次のビルドで直接、もしくは old-game ディレクトリから提供するべきです。これを怠ると、セーブをロードできないゲームになるかもしれません。

Android ビルド

./renpy.sh launcher android_build <base> [ options... ]

これは Android 用のゲームのリリースをビルドします。ランチャーは、 Android SDK のインストール、キーの生成、プロジェクトの設定に使用されたことがあるとします。

--destination <directory>

出力を置くディレクトリーです。デフォルトはカレントディレクトリの "name-version-dists" という名前のディレクトリーで、 build.name と build.version から情報を取得します。

--bundle

指定されると、 Ren'Py は .aab バンドルを生成します。指定しない場合、 Ren'Py は .apk ファイルを生成します。

--install

指定されると、 Ren'Py は接続されたデバイスに .apk または .aab ファイルをインストールします。

--launch

指定されると、Ren'Py は接続されたデバイスでゲームを起動します。これは --install を意味します。

From を Call に追加する

./renpy.sh <base> add_from

このコマンドは、from 節を持たない各 call ステートメントに from 節を追加します。一般的にはリリース前に行うべきであり、 Ren'Py が変更後のゲームでの呼び出しから戻り位置を見つけやすくします。

注釈

ゲームのスクリプトファイルを変更し、あなたがその変更をゲームに含めることを前提としています。

スクリプトのチェック (lint)

./renpy.sh <base> lint [ filename ] [ options... ]

これにより、ゲームに関する lint レポートが実行されます。これは、ランチャーの「スクリプトチェック(lint)」ボタンに相当します。

filename

指定すると、 lint レポートは標準出力に出力されるのではなく、このファイルに書き込まれます。

lint には多くのオプションがあり、リリースごとに変更される可能性があります。それらを表示するには、次のコマンドを実行します。 :

./renpy.sh <base> lint --help

コンパイル

./renpy.sh <base> compile [ --keep-orphan-rpyc ]

このコマンドはゲームをコンパイルし、.rpy ファイルから .rpyc ファイルを作成します。Ren'Py ランチャーの "Force Recompile" ボタンに相当します。

--keep-orphan-rpyc

デフォルトでは、Ren'Py は同じ名前の .rpy や _ren.py のファイルに紐付けられていない .rpyc ファイルを削除します。このオプションが指定されると、 Ren'Py はこれらのファイルを削除しません。

配布

./renpy.sh launcher distribute <base> [ options... ]

Windows、macOS、およびLinux用のゲームの配布物がビルドされます。このコマンドが取るオプションには、次のようなものがあります。 :

--destination <directory>

配布物を配置するディレクトリーです。デフォルトは現在のディレクトリーの "'name-version-dists" という名前のディレクトリーで、 build.name と build.version から情報を取得します。

--no-update

指定されると、Ren'Py は更新ファイルをビルドしません。

--package <package>

これにより、ビルドするパッケージの名前が与えられます (パッケージは "pc"、"mac"、"markets" などのパッケージ名です)。このオプションは、複数のパッケージをビルドするために複数回指定できます。デフォルトでは、すべてのパッケージがビルドされます。

(Ren'Py 自体をビルドするのに便利な他のオプションもあります)

iOS での制作

./renpy.sh launcher ios_create <base> <destination>

ゲームの iOS バージョンをビルドするために使用できる Xcode プロジェクトを作成します。ランチャーが一度は iOS のサポートをインストールしたことを前提としています。

destination

Xcode プロジェクトを配置するディレクトリー。

iOS 移植

./renpy.sh launcher ios_populate <base> <destination>

ゲームを ios_create によって作成された Xcode プロジェクトにコピーします。これによって同じバージョンの Ren'Py で作成されたプロジェクトを更新します。

destination

更新するディレクトリ。

古いゲームの更新

./renpy.sh launcher update_old_game <base>

このコマンドは .rpyc ファイルを <base>/game から <base>/old-game にコピーします 。

Web ビルド

./renpy.sh launcher web_build <base> [ options... ]

これは Web 用のゲームのリリースをビルドします。ランチャーは、一度は web サポートをインストールしており、(progressive_download.txt のような)設定ファイルがあることを前提としています。

--destination <directory>

web root を配置するディレクトリーです。

ランチャーコマンド

これらのコマンドは、コマンドラインから Ren'Py ランチャーを制御するために使用されます。

プロジェクトディレクトリーの設定

./renpy.sh launcher set_projects_directory <directory>

これは Ren'Py ランチャーがプロジェクトを保存するディレクトリーを設定します。これは、プロジェクトディレクトリーを選択するためのオプションが使用できない最小限のシステムでの使用を意図しています。

これは、ランチャーが実行されていない場合にのみ実行できます。

プロジェクト設定

./renpy.sh launcher set_project <base>

現在のプロジェクトを指定されたプロジェクトに設定します。この目的を達成するために、プロジェクト・ディレクトリーとランチャーで現在選択されているプロジェクトを変更します。

これは、ランチャーが実行されていない場合にのみ実行できます。