設定変数 link

設定変数は Ren'Py の実装の振る舞いを制御し、 Ren'Py 自体を柔軟にカスタマイズ可能にします。その範囲には ( 画面のサイズを変更するなど ) 基本的なことから知られていないもの ( 新しい種類のアーカイブファイルの追加 ) まであります。

Ren'Py の実装では一旦 GUI が初期化されたら設定変数は変更されないものと規定しています。 init ブロック外で設定変数を変更すると未定義の動作を引き起こします。設定変数はセーブデータ含にまれません。

設定変数はしばしば init python ブロックで変更されます。

init python:

    # Use a widescreen resolution.
    config.screen_width = 1024
    config.screen_height = 600

よく使用されるもの link

define config.name = "" link

これはゲーム名の文字列です。tracebacks やその他のログファイルの一部に含まれているため、使用されているゲームのバージョンを特定するのに役立ちます。

define config.save_directory = "..." link

これはゲームデータや永続データを保存するディレクトリーを生成するために使われます。生成される名前はプラットフォームに依存します:

Windows
%APPDATA%/RenPy/save_directory
Mac OS X
~/Library/RenPy/save_directory
Linux/Other
~/.renpy/save_directory

None に設定すると、「 saves 」ディレクトリーをゲームディレクトリーの直下に生成します。これは同じシステム上で複数ユーザーがゲームを共有する妨げになるので、非推奨です。また、管理者権限でゲームをインストールし、ユーザーとして実行した場合に問題を引き起こします

これは define ステートメントか python early ブロックで設定される必要があります。どちらの場合でも他のどんなコードよりも前に実行され、式ではなく文字列に設定されるべきです。

永続データは init コードが実行される前にロードされるので、これは python early ブロックで設定しなければなりません。

セーブディレクトリーを知る必要のあるコードは、この変数の代わりに config.savedir を読み込むべきです。

define config.version = "" link

これはゲームのバージョンです。これは tracebacks やその他のログの一部として含まれ、使用されているゲ―ムのバージョンを特定するのに役立ちます。

define config.window = None link

これは台詞ウィンドウのデフォルトの管理方法を設定します。None か "show", "hide", "auto" の内ひとつにしてください。

"show" に設定すると、台詞ウィンドウは常に表示されます。 "hide" に設定すると、台詞ウィンドウは say ステーションや台詞ウィンドウを表示する他のステートメント以外では台詞ウィンドウを非表示にします。 "auto" に設定すると、台詞ウィンドウは scene ステートメント前で非表示され、台詞の前に表示されます。

これはデフォルトの動作を設定します。設定は window showwindow hide, window auto ステートメントから変更出来ます。詳細は テキストウィンドウの管理 を参考してください。

トランジション link

これらは様々な画面間のトランジションを制御します。

define config.adv_nvl_transition = None link

ADVモードテキストからNVLモードテキストを表示するときに使用するトランジションです。

define config.after_load_transition = None link

ロード後、ロードしたゲームが開始した時に使用されるトランジションです。

define config.end_game_transition = None link

ゲームが通常通り終了するか、戻り先がない状態で return を実行するか、または renpy.full_restart() を呼び出してメインメニューを表示するときに使用するトランジションです。

define config.end_splash_transition = None link

スプラッシュ画面の後にメインメニューを表示するときに使用するトランジションです。

define config.enter_replay_transition = None link

None を指定するか、リプレイ開始時に使用するトランジションを指定します。

define config.enter_transition = None link

None を指定するか、ゲームメニューに入る時に使用するトランジションを指定します。

define config.enter_yesno_transition = None link

None を指定するか、 yes/no プロンプト表示時に使用するトランジションを指定します。

define config.exit_replay_transition = None link

None を指定するか、リプレイ終了時に使用するトランジションを指定します。

define config.exit_transition = None link

None を指定するか、ゲームメニューを閉じる時に実行されるトランジションを指定します。

define config.exit_yesno_transition = None link

None を指定するか、 yes/no プロンプトを閉じる時に使用するトランジションを指定します。

define config.game_main_transition = None link

ゲームメニューを出た後、メインメニューを表示する時に使用するトランジションです。これはメインメニューからロードや設定画面が実行されたり、ユーザーがゲームメニューから 「Main Menu」 を選択した時も使用されます。

define config.main_game_transition = None link

メインメニューからゲームメニューに入る時に使用するトランジションで、 「Load Game」 や 「Preferences」 をクリックすると実行されます。

define config.nvl_adv_transition = None link

NVLモードのテキストからADVモードのテキストを表示する時に使用するトランジションです。

define config.say_attribute_transition = None link

None を指定するか、画像タグ付きの say ステートメントでキャラクターの画像が変化する時に使用するトランジションを指定します。

define config.window_hide_transition = None link

トランジションが明示的に指定されなければ、window hide ステートメントで使用されるトランジションです。

define config.window_show_transition = None link

トランジションが明示的に指定されなければ、window show ステートメントで使用されるトランジションです。

設定のデフォルト値 link

これらは様々な設定のデフォルト値です。デフォルト値は Ren'Py の初回起動時か永続データが削除された時のみ影響します。

define config.default_afm_time = None link

None を指定するか、デフォルトの自動進行に掛ける時間を設定します。これは 250 文字を表示するのにかかる秒数です。 0 は特別な場合で、無限の時間に設定して自動進行を無効化します。

define config.default_afm_enable = None link

afm_enable 設定のデフォルト値を決定します。 False なら自動進行モードはデフォルトで無効化され、 True ならデフォルトで有効化されます。 None なら afm_enable 設定は無視されます。 ( 自動進行は自動進行スピードが 0 でないと実行されます。 )

define config.default_emphasize_audio = False link

「 emphasize audio 」設定のデフォルト値を制御します。

define config.default_fullscreen = None link

これはフルスクリーン設定のデフォルト値を設定します。これは True か False であるべきです。( 普通は options.rpy で False に設定されます。 )

define config.default_language = None link

これは言語設定のデフォルト値を決定します。これは初回起動時にのみ使用されます。

define config.default_show_empty_window = True link

say ステートメント以外の間、Ren'Py が空のウィンドウを表示するかどうかを決定します。True の場合、Ren'Py は「 window show 」、「 window hide 」、「 window auto 」 ステートメントに従います。False の場合は、Ren'Py は空のウィンドウを表示しません。

define config.default_text_cps = None link

None を指定するか、1秒毎に表示される文字数のデフォルト値を設定します。 0は特殊な場合で、1秒毎に無限の個数の文字を表示します。 ( 普通は options.rpy で False に設定されます。)

define config.default_voice_sustain = False link

ボイス再生を続けるかどうかのデフォルト値です。True なら次のインタラクションに移ってもボイスは再生を続けます。 False ならボイスは次のインタラクション開始時に停止します。

define config.default_wait_for_voice = True link

ボイス再生を待つかどうかのデフォルト値です。 Ren'Py が、ボイスが終了してから自動進行を開始するかどうかを決定します。

define config.default_music_volume = 1.0 link

music ミキサーのデフォルト音量で、music と movie チャンネルに使用されます。これは 0.0から 1.0 の数字でなければいけならず、1.0 が最大音量です。

define config.default_sfx_volume = 1.0 link

sfx ミキサーのデフォルト音量で、sound チャンネルに使用されます。これは 0.0から 1.0 の数字でなければいけならず、1.0 が最大音量です。

define config.default_voice_volume = 1.0 link

voice ミキサーのデフォルト音量で、voice チャンネルに使用されます。これは 0.0から 1.0 の数字でなければいけならず、1.0 が最大音量です。

時々使用されるもの link

define config.after_load_callbacks = [ ... ] link

ロード時に(引数なしで)呼び出される関数のリストです。

define config.after_replay_callback = None link

None を指定するか、リプレイ終了後に引数なしで呼び出される関数を指定します。

define config.auto_channels = { "audio" : ( "sfx", "", "" ) } link

自動的にオーディオチャンネルを決定するために使用されます。チャンネル名と 3 要素のタプルの辞書です。:

  • そのチャンネルが使用するミキサーです。

  • そのチャンネルで再生するファイルに与えられる接頭辞です。

  • そのチャンネルで再生するファイルに与えられる接尾辞です。

define config.auto_load = None link

None を指定するか、 Ren'Py 起動時に自動的にロードされるセーブファイルの名前を指定します。これはエンドユーザーというより開発者向けです。

define config.auto_voice = None link

ここには、文字列、関数、None のいずれかを指定し、None の場合は自動ボイスは無効化されます。

文字列の場合、現在の行の台詞を識別する id のフォーマットを指定します。その文字列が存在するファイルであれば、そのファイルがボイスとして再生されます。

関数の場合、その関数は現在の行の台詞の識別子を引数として1つ与えられて呼び出されます。この関数は文字列を返すことが期待されます。その文字列が存在するファイルであれば、そのファイルがボイスとして再生されます。

詳細は Automatic Voice を参照してください。

define config.automatic_images = None link

None でなければ Ren'Py に自動的に画像を定義させます。

None を指定するか、区切り文字のリストを指定します。 (例えば [ ' ', '_', '/' ])

Ren'Pyはディスクとアーカイブのファイルリストをスキャンします。 .png や .jpg で終わるファイルが見つかると、拡張子を取り除いて区切り文字で名前を分割し、画像名を作成します。名前が少なくとも二つの要素で構成され、その名前の画像がすでに定義されていなければ Ren'Py はその画像をファイル名から定義します。

この区切り文字のリストの例では、 game ディレクトリーが以下のファイルを持つなら :

  • eileen_happy.png ならRen'Pyは画像「 eileen happy 」を定義します。

  • lucy/mad.png なら Ren'Py は画像「 lucy mad 」を定義します。

  • mary.png なら Ren'Py は何もしません。 (画像が2つの要素を持たないため)

define config.automatic_images_strip = [ ] link

自動的に画像を定義するときに取り除かれる、接頭辞の文字列のリストです。これは画像を含むディレクトリーの名前を取り除くために使用されます。

define config.autosave_slots = 10 link

オートセーブで使用するスロット数

define config.debug = False link

デバッグ機能を有効化する。(ほとんどは、見つからないファイルをエラーにすることです) これはリリース時に常にオフにされるべきです。

define config.debug_image_cache = False link

True ならRen'Pyは 画像キャッシュ の内容を、それが変更される度に標準出力に出力します。

define config.debug_sound = False link

サウンドのデバッグ機能を有効化します。これはサウンド生成時のエラーの抑制を無効化します。サウンドカードに欠点があったり失敗しても、そのようなエラーはよくあることで Ren'Py の動作を妨げません。これはゲームのリリース時には常に False であるべきです。

define config.debug_text_overflow = False link

True だと Ren'Py はテキストオーバーフローを text_overflow.txt に記録します。テキストオーバーフローは Text displayable がその許可された領域よりも大きくレンダリングされると起こります。これを True にして 台詞用ウィンドウの xmaximumymaximum スタイルプロパティーをウィンドウのサイズに設定すると、台詞がウィンドウより大きい場合は報告するように出来ます。

define config.default_tag_layer = "master" link

config.tag_layerにタグがなければ画像を表示するレイヤーです。

define config.default_transform = ... link

show または scene ステートメントを使用して displayable が表示されるとき、変換プロパティーはこの変換から受け取られ、 displayable の変換の値を初期化するために使用されます。

デフォルトの変換は center です。

define config.defer_styles = False link

True なら、style ステートメントの実行はすべての "translate python" ブロックが実行されるまで延期されます。これでtranslate python ブロックで style ステートメントで使用される変数を更新出来ます。

これはデフォルトで False で、 gui.init() が呼び出されるとこれは True に設定されます。

define config.developer = "auto" link

True の場合、開発者モードが有効化されます。開発者モードは Shift+D での開発者メニューや、Shift+R でのリロードなどエンドユーザー向けではないその他様々な機能を提供します。

True または False, "auto" です。 "auto" なら Ren'Py はゲームが配布物にパッケージされたかを確認して、 config.developer を適切に定義します。

define config.emphasize_audio_channels = [ 'voice' ] link

オーディオチャンネル名の文字列のリストです。

「 emphasize audio 」設定が有効なら、リストにあるオーディオチャンネルの 1 つが再生を開始すると、このリストにないすべてのチャンネルそのセカンダリーボリュームを config.emphasize_audio_time 秒かけて config.emphasize_audio_volume まで減少させますg。

このリストにないチャンネルがオーディオを再生すると、リストにないすべてのチャンネルはそのセカンダリーボリュームを config.emphasize_audio_time 秒かけて 1.0 に上げます。

例えばこれを [ 'voice' ]] に設定すると、ボイス再生中はボイス以外のチャンネルのボリュームを下げるでしょう。

define config.emphasize_audio_time = 0.5 link

上記参照。

define config.emphasize_audio_volume = 0.5 link

上記参照。

define config.empty_window = ... link

これは _window が True で、画面には何もウィンドウが表示されていない時に呼び出されます。 ( renpy.shown_window() の呼び出しは起こりません。 ) 空のウィンドウが画面に表示され、インタラクションを起こさずに処理を返すことが期待されます。 )

デフォルトの実装ではこれを narrator キャラクターでインタラクションなしで空白を表示するために使用します。

define config.enter_sound = None link

None を指定するか、ゲームメニューに入るときに再生される音楽ファイルを指定します。

define config.exit_sound = None link

None を指定するか、ゲームメニューを出るときに再生される音楽ファイルを指定します。

define config.fix_rollback_without_choice = False link

このオプションは組み込みのメニューやイメージマップの固定ロールバック中の振る舞いを決定します。デフォルトの値は False で、これはメニューでは以前選択された選択肢のみがクリック可能であることであることを意味します。True に設定されると選択された選択肢は目印が付きますが、クリック可能な選択肢はありません。

define config.font_replacement_map = { } link

これは (font, bold, italics) から (font, bold, italics) への辞書で、あるフォントをボールドとイタリック、またはそのどちらかを持つフォントで置き換えるために使用されます。例えば「Vera.ttf」のイタリックを使用するものすべてに、代わりに「VeraIt.ttf」を使用して欲しいなら次のようにコードを書きます。 :

init python:
    config.font_replacement_map["Vera.ttf", False, True] = ("VeraIt.ttf", False, False).

これらの辞書はフォントの特定の種類に適用されるだけで、 Vera のボールドイタリックを要求されると VeraIt のボールドではなく Vera のボールドイタリックが使用されます。

define config.framerate = 100 link

None を指定するか、Ren'Py が 1秒毎に表示しようとするフレーム数の上限を指定します。これはソフトウェアレンダリングでのみ参照され、GL レンダリングでは代わりに垂直同期をします。

define config.game_menu = [ ... ] link

これはゲームメニューの選択肢をカスタマイズするために使用されます。詳細はこの変数の内容のメインメニューやゲームメニューを読んでくさい。

これはゲームメニューがスクリーンを使用して定義されていると使用されません。

define config.game_menu_music = None link

None を指定するか、ゲームメニューで再生される音楽ファイルを指定します。

define config.gl_test_image = "black" link

OpenGL のパフォーマンステスト実行時に使用される画像の名前です。この画像は 5 フレームか 0.25 秒起動時に表示され、その後自動的に hide されます。

define config.has_autosave = True link

True ならゲームはオートセーブを使用し、 False ならオートセーブは起こりません。

define config.history_callbacks = [ ... ] link

Ren'Py が新しいオブジェクトを _history_list に追加する前に呼び出されるコールバックリストが含まれます。コールバックは新しい HistoryEntry オブジェクトを第一引数に呼び出され、そのオブジェクトに新しい field を加えられます。

Ren'Py は内部で history コールバックを使用するため、開発者は完全な置き換えではなく、自身のコールバックをこのリストに杖加えてください。

define config.history_length = None link

Ren'PY が保有するテキスト履歴の数です。これはデフォルト gui では 250 に設定されます。

define config.hw_video = False link

True ならハードウェアでのビデオ再生がモバイルプラットフォームで使用されます。これはより高速ですが、いくつかのフォーマットとフルスクリーンでのみ利用可能です。False ならソフトウェア再生が使用されますが、使用には遅すぎるでしょう。

define config.image_cache_size = 8 link

これは画面サイズの倍数で 画像キャッシュ のサイズを設定するために使用されます。この数はピクセル数での画面サイズの倍数で、ピクセル数での画像キャッシュのサイズを取得するためのものです。

大きく設定し過ぎるとこれはメモリーを浪費しかねません。小さすぎると画像は繰り返しロードされ、パフォーマンスを悪化させます。

define config.key_repeat = (.3, .03) link

キーリピートの割合を制御します。キーリピート有効時はタプルであるべきです。タプルの最初の要素は最初のリピートまでの時間、2つ目の要素はリピート間の時間で、共に秒数です。 None ならキーリピートは無効化されます。

define config.language = None link

None を指定するか、翻訳フレームワークでゲームが翻訳されるデフォルトの言語の文字列を指定します。

define config.main_menu = [ ... ] link

スクリーンを使用しない時のデフォルトのメインメニューです。詳細は Main and Game Menus を参照してください。

define config.main_menu_music = None link

None を指定するか、メインメニューで再生される音楽ファイルを指定します。

define config.menu_clear_layers = [] link

ゲームメニューに入るときに非表示されるレイヤー名 ( 文字列 ) のリストです。

define config.menu_window_subtitle = "" link

_window_subtitle 変数はメインメニューまたはゲームメニューに入った時にこの値に設定されます。

define config.minimum_presplash_time = 0.0 link

PC, Android, iOS のプレスプラッシュが表示される最小時間の秒数です。この時間に到達する前に Ren'Py が初期化すると、スリープして少なくともこの時間画像が表示されることを保証します。Ren'Py の起動に時間がかかると画像はより長く表示されます。

define config.missing_background = "black" link

これは config.developer が True で未定義の画像が scene ステートメント で使用されると使われる背景画像です。これは displayable ではなく画像名の文字列であるべきです。

define config.mode_callbacks = [ ... ] link

あるモードに入るときに呼び出されるコールバックのリストです。より詳しくは モード の章を参照してください。

デフォルトの値は config.adv_nvl_transitionconfig.nvl_adv_transition を実装するコールバックを含んでいます。

define config.mouse = None link

この変数はユーザー定義マウスカーソルの使用を制御します。 None ならシステムマウスが使用され、それは通常白と黒のマウスカーソルです。

そうでなければこれは様々な種類のマウスに対するマウスアニメーションを与える辞書であるべきです。デフォルトで使用されるキーは 「 default 」, 「 say 」, 「 with 」, 「 menu 」, 「 prompt 」, 「 imagemap 」, 「 pause 」, 「 mainmenu 」, 「 gamemenu 」 を含みます。 「 default 」 キーはより特別なキーが存在しないときに使用されるので常に存在するべきです。

辞書の各値はフレームを表す (image, xoffset, offset) のタプルのリストであるべきです。

image

マウスカーソルの画像です。

xoffset

カーソルの左端からのピクセル数でのホットスポットのオフセットです。

yoffset

カーソルの上端からのピクセル数でのホットスポットのオフセットです。

フレームは 20hz で再生され、アニメーションはすべてのフレームが表示されたらループします。

define config.narrator_menu = False link

( これはデフォルトのscreen.rpy で True に設定されます。 ) True なら選択肢でのナレーションは narator キャラクターを使用して表示されます。そうでなければナレーションは選択肢自体の見出しに表示されます。

define config.nearest_neighbor = False link

デフォルトで最近傍補間を使用して、ピクセルアートのサポートや、プレイヤーの目になじませんます。

define config.overlay_functions = [ ] link

関数のリストです。呼び出されると各関数は ui 関数を使用して displayable を overlay レイヤーに追加することが期待されます。

define config.overlay_screens = [ ... ] link

オーバーレイが有効なとき表示され、停止すると非表示されるスクリーンのリスト。(スクリーンは overlay レイヤーではなく screens レイヤーに表示されます。)

define config.python_callbacks = [ ] link

関数のリストです。このリストの関数は初期化時以外で python ブロックが実行されるすべての場所で引数なしで呼び出されます。

考えられるこれの使用法の一つは、変数をそれが調整されるたびにある範囲内に制限する関数を所有することです。

関数は完全にゲームが開始する前や、もしかすると関数が依存する変数が初期化される前に Ren'Py 内部のコードで呼び出されるかもしれません。関数はおそらく 変数が定義されているかチェックするために hasattr(store, 'varname') を使用してこのことを扱います。

define config.quicksave_slots = 10 link

クイックセーブで使用するスロット数

define config.quit_action = ... link

ユーザーがウィンドウの閉じるボタンを押した時に呼び出されるアクションです。デフォルトのアクションではユーザーにゲームを終了するか確認します。

define config.replace_text = None link

None または、ユーザーに表示されるテキストを引数に呼び出される関数です。関数は渡されたものと同じテキストか、代わりに表示される代替テキストを返します。

関数は代替処理が終了し、テキストがタグに分割された後で呼び出されるため、引数は実際のテキストを含みません。表示されるすべてのテキストはこの関数を通過します。(ダイアログテキストだけでなくユーザーインターフェーステキストも含みます。)

以下のコードで示すように、これを使用して特定の ASCII 番号を対応するユニコード文字で置き換えられます。

def replace_text(s):
    s = s.replace("'", u'\u2019') # apostrophe
    s = s.replace('--', u'\u2014') # em dash
    s = s.replace('...', u'\u2026') # ellipsis
    return s
config.replace_text = replace_text
define config.replay_scope = { "_game_menu_screen" : "preferences" } link

デフォルト store とリプレイ内で指定される変数の値の辞書です。

define config.save_json_callbacks = [ ] link

各セーブに保存される json オブジェクトを作成し、 FileJson(), renpy.slot_json() を利用してアクセス可能にするために使用されるコールバック関数のリストです。

各コールバックは最終的に保存される python の辞書を引数に呼び出されます。コールバックはその辞書に数字、文字列、リストや辞書のような json 互換の python 型を追加して変更するべきです。辞書は最後のコールバックが終わるとセーブスロットにセーブされます。

コールバックに渡される辞書は多分すでにアンダースコア (_) で始まるキーを持っています。これらのキーは Ren'Py が使用するので変更するべきではありません。

define config.screen_height = 600 link

スクリーンの高さで、通常 gui.init() で設定します。

define config.screen_width = 800 link

スクリーンの幅です。通常 gui.init() から設定されます。

define config.speaking_attribute = None link

None または画像属性の文字列を指定します。画像属性はキャラクターが話すと追加され、止めると除かれます。

define config.tag_layer = { } link

画像タグとレイヤー名の文字列の辞書です。レイヤー名の指定なしに画像が表示されると、この辞書からタグを探し、表示するレイヤーを所得します。タグが見付からなければ、 config.default_tag_name が使用されます。

define config.tag_transform = { } link

画像タグの文字列と変換または変換のリストの辞書です。 at 説なしに画像が表示されると、この辞書からタグを探し、使用する変換または変換のリストを見付けます。

define config.tag_zorder = { } link

画像タグの文字列と zorder の辞書です。 zorder 説の指定なしに画像が表示されると、この辞書からタグを探し、使用する zorder を見付けます。 zorder が見付からなければ 0 が使用されます。

define config.thumbnail_height = 75 link

ゲームがセーブされるときに撮られるサムネイルの高さです。これらのサムネイルはゲームがロードされるときに表示されます。サムネイルはユーザーに表示される時点でのこの設定の値ではなく、それが撮られたサイズで表示されることに注意してください。

これはデフォルトのGUIによって変更されます。

define config.thumbnail_width = 100 link

ゲームがセーブされるときに撮られるサムネイルの幅です。これらのサムネイルはゲームがロードされるときに表示されます。サムネイルはユーザーに表示される時点でのこの設定の値ではなく、それが撮られたサイズで表示されることに注意してください。

これはデフォルトのGUIによって変更されます。

define config.tts_voice = None link

None または自己発話でテキスト再生に使用する非デフォルトボイスの文字列です.選択可能なものはプラットフォームに依存するので、プラットフォームごとに設定するべきです(翻訳においても同様に変更してください)。

define config.window_auto_hide = [ 'scene', 'call screen' ] link

window auto によって空の会話ウィンドウを非表示にするステートメントのリスト。

define config.window_auto_show = [ 'say' ] link

window auto によって空の会話ウィンドウを表示するステートメントのリスト。

define config.window_icon = None link

None を指定するか、ゲームのメインウィンドウで使用されるアイコン画像のファイル名を指定します。これはwindows の実行ファイルや mac app で使用されるアイコンを設定しません。それらは 特別なファイル によって制御されます。

define config.window_overlay_functions = [] link

ウィンドウが表示されるときにのみ呼び出されるオーバーレイ関数のリストです。

define config.window_title = None link

Ren'Py のゲームウィンドウのタイトルに常に表示される文字列です。 _window_subtitle がこれに追加されてウィンドウの完全なタイトルになります。

None なら config.name の値になります。

滅多に使われないか内部で使用されているもの link

define config.adjust_view_size = None link

None か、物理ウィンドウの幅と高さの 2 つを引数にとる関数です。 OpenGL の viewport , Ren'Py が画像を描画する画面の領域の幅と高さを指定するタプルを返してください。

これを使用して、特定の画面サイズのみを許可するよう Ren'Py を設定出来ます。例えば次のコードは元の画面サイズの整数倍のみ許可します。

init python:

    def force_integer_multiplier(width, height):
        multiplier = min(width / config.screen_width, height / config.screen_height)
        multiplier = max(int(multiplier), 1)
        return (multiplier * config.screen_width, multiplier * config.screen_height)

    config.adjust_view_size = force_integer_multiplier
define config.afm_bonus = 25 link

オートモードが有効の時にすべての文字列に対して追加される特別な文字数です。

define config.afm_callback = None link

None を指定するか、自動読み進めしてよいかを決定するために呼び出される Python 関数を指定します。これはボイスシステムによるボイス再生中に、自動読み進めを無効化するために使用されています。

define config.afm_characters = 250 link

自動進行の設定で指定された、自動進行が開始するまでの時間を算出するための文字列の文字数です。この文字数ごとに設定された時間自動進行の開始を待ちます。

define config.afm_voice_delay = .5 link

ボイスファイルが再生を終了後、 AFM がテキストを読み進めるまでの秒数です。

define config.all_character_callbacks = [ ] link

すべてのキャラクターから呼び出されるコールバックのリストです。このリストはキャラクター指定コールバックリストの先頭に追加されます。

define config.allow_skipping = True link

False に設定されるなら、ユーザーはゲームのテキストをスキップ出来ません。

define config.archives = [ ] link

画像やその他のデータを探索するアーカイブファイルのリストです。この要素は、 .rpa 拡張子を取り除いたアーカイブファイルのベース名で構成されるはずです。

このリストで見つかった順にアーカイブが探索され、ファイルは最初に見つかったアーカイブから受け取ります。

起動時 Ren'Py は自動的にこの変数に ゲームディレクトリーで見つかったすべてのアーカイブの名前を、ASCII コードと逆の順に並べ替えて加えます。例えば Ren'Py がファイル data.rpa, patch01.rpa, patch02.rpa を見つけると、この変数には ['patch02', 'patch01', 'data'] が加えられます。

define config.auto_choice_delay = None link

None を指定するか、Ren'Py が選択肢で選択肢からランダムに選択するまでの秒数を与えます。この変数はリリースされたゲームでは常に None に設定されると良いですが、数字に設定することで人の手のいらない自動的なゲームのデモが出来ます。

define config.autoreload = True link

True なら shift+R で自動リロードの有効無効がトグルします。自動リロードが有効なら、 Ren'Py は使用するファイルが変更されるたびにゲームをリロードします。

False なら Ren'Py は shift+R を押すたびにゲームをリロードします。

define config.autosave_frequency = 200 link

大雑把なオートセーブが実行されるまでのインタラクションの数です。オートセーブを無効化するためには config.has_autosave を False に設定して、この変数を変更しないでください。

define config.autosave_on_choice = True link

True なら Ren'Py はゲーム中の選択肢に入ると自動セーブします。 ( renpy.choice_for_skipping() 呼び出し時 )

define config.autosave_on_quit = True link

True なら、ユーザーが終了やメインメニューに戻る、現在のゲームを破棄して別のゲームをロードすると Ren'Pyが自動セーブをします。 (時間を節約するため、ユーザーにプロントが表示されている間に自動セーブは行なわれます。)

define config.character_callback = None link

Character クラスの callback 引数のデフォルト値になります。

define config.choice_layer = "screens" link

( menu ステートメントで使用される ) choice スクリーンが表示されるレイヤーです。

define config.clear_layers = [] link

メインメニューまたはゲームメニューに入るとき非表示されるレイヤー名のリストです。

define config.context_clear_layers = [ 'screens' ] link

新しいコンテキストに入るとき非表示されるレイヤーのリストです。

define config.fade_music = 0.0 link

これは新しい曲が開始する前に古い曲をフェードアウトするのにかかる秒数です。これは多分かなり短いはずで、長すぎると曲が再生されません。

define config.fast_skipping = False link

開発者モード以外でもファストスキップを許可したい場合これを True に設定してください。

define config.file_open_callback = None link

None を指定するか、ファイルが開かれる必要がある時にファイル名を引数に呼び出される関数を指定します。通常の Ren'Py の仕組みを使用してファイルをロードするために、 file-like オブジェクトか None を返すべきです。

define config.focus_crossrange_penalty = 1024 link

これはキーボードでフォーカスを移動するときに、選択された方向に対して垂直な移動に適用される曖昧さの値です。

define config.gl_enable = True link

OpenGL 高速化を無効化するなら False に設定してください。 OpenGL 高速化はシステムがサポート出来ていなければ自動的に無効化されるでしょうから、通常これを設定する必要はありません。

OpenGL は開始時に Shift を押しっぱなしにしても無効化されます。

define config.gl_resize = True link

ユーザーが OpenGL が描画したウィンドウのサイズを変更できるか決定します。

define config.hard_rollback_limit = 100 link

これは Ren'Py がユーザーにインタラクションにロールバックさせるステップ数です。これを 0 に設定するとロールバックは完全に無効化されますが、ロールバックはユーザーが間違えてスキップしたテキストを見るために便利ですのでこれはお勧めしません。

define config.help = "README.html" link

これはメインメニュー、ゲームメニュー、または F1 や command + ? を押すことで実行されるヘルプシステムを制御します。

None の場合、ヘルプシステムは無効化され、メニューには表示されません。スクリプト内で見つけられるラベルに対応する文字列の場合、そのラベルを新しいコンテキストで実行します。これでゲーム内のヘルプ画面を定義できます。それ以外の場合はこの文字列はブラウザーで開かれるベースディレクトリーに対する相対パスのファイル名として解釈されます。

define config.hide = renpy.hide link

hide ステートメント が実行されるときに呼び出される関数です。これは renpy.hide と同じ引数をとるべきです。

define config.imagemap_auto_function = ... link

スクリーン言語 imagebuttonimagemap ステートメントの auto プロパティーを displayable に拡張する関数です。 これは auto プロパティーの値を受け取って : 「 insensitive 」, 「 idle 」, 「 hover 」, 「 selected_idle 」, 「 selected_hover 」, 「 ground 」 のいずれかの画像を探します。これは displayable か None を返すはずです。

デフォルトの実装では auto プロパティーを要求した画像でフォーマットし、その結果のファイル名が存在するかを確認します。

define config.imagemap_cache = True link

True ならイメージマップのホットスポットは PNG ファイルにキャッシュされ、時間とメモリーを節約しますが、ディスク上のゲームサイズを増大させます。この振る舞いを無効化するにはこれを False に設定してください。

define config.implicit_with_none = True link

デフォルトは True で、 with None ステートメントの評価は台詞、選択肢、入力、イメージマップによって起きるインタラクションの後に処理されます。これはトランジション中に以前の画面が表示されないことを保証します。

define config.interact_callbacks = ... link

インタラクションが開始または再開されるときに ( 引数なしで ) 呼び出される関数のリストです。

define config.keep_running_transform = True link

True なら変換や ATL ブロックを与えられなかった画像の表示では、そのタグを持つ画像が以前使用していた変換を、それが何であっても維持するようにします。 False なら変換は停止されます。

define config.keymap = dict(...) link

この変数は可能な各処理に代入されたキーボードとマウスのボタンを与えるキーマップを含みます。より詳しくはキーマップの章を参照してください。

define config.label_callback = None link

None を指定するか、どのラベルに到達しても呼び出される関数を指定します。2つの引数で呼び出され、最初はラベル名、2つ目はラベルがジャンプまたは呼び出し、あるいは新しいコンテキストから到達したなら True 、そうでないなら False です。

define config.label_overrides = { } link

この変数は Ren'Py のコードでラベルのジャンプや呼び出しを他のラベルにリダイレクトさせる方法を提供します。例えば「 start 」から「 mystart 」へのマッピングを追加すると、「 start 」へのすべてのジャンプと呼び出しは代わりに「 mystart 」へ向かいます。

define config.layer_clipping = { } link

レイヤーのクリッピングを制御します。この関数はレイヤー名に対するタプル (x, y, height, width) の辞書で、x,y はレイヤーサイズを与える height と width を持つレイヤーの左上端からの座標です。

レイヤーが config.layer_clipping で述べられないと、フルスクリーンを取ると推測されます。

define config.layers = [ 'master', 'transient', 'screens', 'overlay' ] link

この変数は Ren'Py がそれらが画面に表示される順番について分かっているレイヤーすべてのリストです。 ( 最も遠いレイヤーはこのリストの一番最初にあります。 ) Ren'Py はレイヤー 「master」, 「transient」, 「screens」, 「overlay」 を内部で使用するので、常にこのリスト内にあるべきです。

define config.lint_hooks = ... link

これは lint が実行されると引数なしで呼び出される関数のリストです。関数はエラー確認のためにスクリプトのデータをチェックすることが期待され、標準出力に発見したものを表示します。 ( この場合 python print ステートメントの使用が適切です。 )

define config.load_before_transition = True link

True の場合、すべての画像がロードされるまで入力を受け付けません。 (はい、これは変な名前ですね。)

define config.log_width = 78 link

config.log 使用時の記録される行の幅です。

define config.longpress_duration = 0.5 link

プレイヤーがタッチデバイスで、長押しとして認識されるためにスクリーンを押さなければならない時間です。

define config.longpress_radius = 15 link

長押しと認識するために、押している間とどまる必要のあるピクセル数です。

define config.longpress_vibrate = .1 link

長押し後にデバイスがバイブする時間です。

define config.log = None link

None を指定するか、ファイル名を指定します。 saymenu ステートメントによって表示されるテキストの多くはこのファイルに保存されます。

define config.missing_image_callback = None link

None を指定するか、画像ファイルの呼び出しの試みが失敗するときに呼び出される関数を指定します。それは None を返すか、画像マニュピレーターを返すでしょう。画像マニュピレーターが返されるとその画像マニュピレーターは失敗した画像の代わりにロードされます。

define config.missing_label_callback = None link

None か、存在しないラベルに Ren'Py がアクセスしようとすると呼出される関数です。存在しないラベルの代わりに使用されるラベル名を返すか、Noneを返して Ren'Py に例外を投げるべきです。

define config.mouse_hide_time = 30 link

この秒数がマウス入力なしで経過したらマウスが非表示になります。これは一つのスクリーンを読むのにかかるだろう時間より長めに設定して、ユーザーがクリックのたびにマウスが出たり消えたりするのを経験しないようにしましょう。

None ならマウスは非表示になりません。

define config.movie_mixer = "music" link

The mixer that is used when a Movie() automatically defines a channel for video playback.

define config.new_translate_order = True link

Ren'Py 6.99.11 で述べられた新しい style と translate ステートメントの順番を有効化します。

define config.new_substitutions = True link

True なら Ren'Py はすべての表示されるテキストに新しいスタイル ( 角括弧 ) の代入を適用します。

define config.old_substitutions = False link

True なら Ren'Py は saymenu ステートメントで表示されるテキストに旧スタイル ( % ) の代入を適用します。

define config.overlay_during_with = True link

with ステートメント の間にオーバーレイが表示されていて欲しいなら True 、with ステートメントの間はそれらが非表示になる方が好みなら、 False に設定してください。

define config.overlay_layers = [ 'overlay' ] link

これはすべてのオーバーレイレイヤーのリストです。オーバーレイレイヤーはオーバーレイ関数が呼び出される前にクリアされます。「 overlay 」は常にこのリスト内にあるべきです。

define config.periodic_callback = None link

None を指定するか、関数を指定します。関数は引数なしで、 20hz 毎に呼び出されます。

define config.play_channel = "audio" link

The name of the audio channel used by renpy.play(), hover_sound, and activate_sound.

define config.predict_statements = 10 link

これは現在のものを含むステートメントの数で、予測画像をロードするタイミングを考慮するために使用されます。現在のステートメントが実行されてからこの数のステートメントまでが幅優先探索で考慮され、それらのステートメントで参照される画像がバックグラウンドで予測ロードされます。これを 0 に設定すると画像の予測ロードは無効化されます。

define config.profile = False link

True ならプロファイル情報が標準出力に出力されます。

define config.quit_on_mobile_background = False link

True ならモバイル app ではフォーカスを失なうと停止します。

define config.rollback_enabled = True link

ユーザーはゲーム中にロールバック出来るべきですよね? False の場合、ユーザーはインタラクションにロールバック出来ません。

define config.rollback_length = 128 link

ロールバックログにこれ以上のステートメントがあれば Ren'Py はログをカットします。

define config.rollback_side_size = .2 link

rollback side が有効のとき、クリックまたはタッチでロールバックする側の画面の割合です。

define config.say_allow_dismiss = None link

None を指定するか、関数を指定します。関数はユーザーが say ステートメント を省略しようとすると引数なしで呼び出されます。この関数が True を返すと、省略は許可され、そうでなければ無視されます。

define config.say_layer = "screens" link

say スクリーンが表示されるレイヤーです。

define config.say_menu_text_filter = None link

None を指定するか、 saymenu ステートメントの文字列からテキストを与えられる関数を指定します。これは新しい ( または同じ ) 文字列を返して、それらで置き換えることが期待されます。

define config.say_sustain_callbacks = ... link

ポーズを含む台詞による二番目以降のインタラクションの前に、引数なしで呼び出される関数のリストです。 ポーズ越しでもボイスを再生し続けるために使用されています。

define config.save_dump = False link

True に設定されると Ren'Py はゲームをセーブするときは常に新しい save_dump.txt ファイルを作成します。このファイルはセーブファイルに含まれるオブジェクトの情報を含みます。各行は相対的なサイズの見積もり、オブジェクトへのパス、オブジェクトがエイリアスかどうかの情報、オブジェクトの説明で構成されています。

define config.save_on_mobile_background = True link

True ならモバイル app ではフォーカスを失うと状態を保存します。この方法で状態が保存されると、その app が再び起動されたときに自動的にロードされ、ゲームが再開されます。

define config.save_physical_size = True link

True ならウィンドウの実際のサイズは設定に保存され、ゲーム再開時に再現されます。

define config.savedir = ... link

ゲームがセーブされるディレクトリーの絶対パスです。これは python early ブロックでのみ設定されるべきです。 python early ブロック内で設定されなかったらこれのデフォルト値を生成する config.save_directory も参照しましょう。

define config.scene = renpy.scene link

scene ステートメント で renpy.scene の代わりに使用される関数です。 これを使用して画面をクリアし、 config.show を使用して新しい画像を表示することに注意しましょう。これは renpy.scene と同じ引数、返り値を持つべきです。

define config.screenshot_callback = ... link

スクリーンショットを撮るときに呼び出される関数です。関数はスクリーンショットがセーブしたファイル名をひとつの引数にして呼び出されます。

define config.screenshot_crop = None link

None を指定するか、 (x, y, height, width) のタプルを指定します。スクリーンショットはセーブされる前にこの長方形にクロッピングされます。

define config.screenshot_pattern = "screenshot%04d.png" link

スクリーンショットファイルを作成するために使用されるパターンです。このパターンは ( python の文字列フォーマットの規則を持ちいて ) 自然数に適用され、ファイル名を生成します。ファイル名は絶対座標か config.renpy_base からの相対座標です。存在していない最初のファイル名がスクリーンショットの名前として使用されます。

define config.script_version = None link

None を指定するかスクリプトのバージョンを指定します。必要ならライブラリーはこのスクリプトバージョンをいくつかの互換性機能を有効化するために使用します。 None ならこれは最新バージョンのスクリプトと推測されます。

これは通常 Ren'Py ランチャーにより配布物のビルド時に追加されるファイルで設定されます。

define config.searchpath = [ 'common', 'game' ] link

画像や音楽、アーカイブやその他のメディアを検索するディレクトリーのリストで、スクリプトではありません。これはリストが 「 common 」とゲームディレクトリーを含むように初期化されます。

define config.search_prefixes = [ "", "images/" ] link

検索時にファイル名の先頭に追加される接頭辞のリストです。

define config.show = renpy.show link

renpy.show の代わりに showscene ステートメントで使用される関数です。これは renpy.show と同じ引数、返り値の構造を持つべきです。

define config.skip_delay = 75 link

ctrl キーを使用してスキップしている時に台詞が表示されているミリ秒単位の時間です。 ( 実際はそれほど正確ではないが )

define config.skip_indicator = True link

True ならライブラリーはスクリプトをスキップするときにスキップインディケーターを表示します。

define config.sound = True link

True なら効果音が動作します。 False なら sound/mixere サブシステムは完全に無効化されます。

define config.sound_sample_rate = 48000 link

サウンド力ード実行時のサンプルレートです。あなたの wav ファイルの全てが比較的低いレートであるなら、これをそのレートに変更すると処理が効率的になるかもしれません。

define config.start_callbacks = [ ... ] link

初期化後、ゲーム開始前 ( スプラッシュ画面を含む ) に引数なしで呼び出される関数のリストです。これは保存される変数を初期化すためにフレームワークによって使用されることを意図しています。

この変数のデフォルトの値は Ren'Py が内部で nvl-mode などのような機能を実装するために使用しているコールバックを含みます。新しいコールバックはこのリストに追加できますが、すでにあるコールバックは除去してはいけません。

define config.start_interact_callbacks = ... link

インタラクションの開始時に ( 引数なしで ) 呼び出される関数のリストです。これらのコールバックはインタラクションの再開時には呼び出されません。

define config.top_layers = [ ] link

これはすべての他のレイヤーの上に表示されるレイヤー名のリストで、すべてのレイヤーに適用されるトランジションには参加しません。レイヤー名がここにリストアップされるなら、 config.layers にはリストアップされるべきではありません。

define config.transient_layers = [ 'transient' ] link

この変数はすべての一時的なレイヤーのリストを与えます。一時的なレイヤーは各インタラクションの後にクリアされるレイヤーです。「 transient 」は常にこのリスト内にあるべきです。

define config.transform_uses_child_position = True link

True なら変換はその子から position properties を引き継ぎます。そうでないなら引き継ぎません。

define config.transition_screens = True link

True なら、スクリーンはディゾルブのような以前のスクリーンの状態から新しいスクリーンの状態へのトランジションに参加します。False ならただ最新のスクリーン状態が表示されます。

define config.translate_clean_stores = [ "gui" ] link

翻訳言語変更時に初期化の最後で状態が初期化される名前付き store のリストです。

define config.variants = [ ... ] link

ユーザーに表示するスクリーンを選択する時に検索されるスクリーンバージョンのリストです。デフォルトのスクリーンが選択されることを保証するために、これは常に None で終わるべきです。 スクリーンバージョン 参照してください。

define config.voice_filename_format = "{filename}" link

再生されるファイル名を生成するために、voice ステートメントに渡される引数の文字列でフォーマットされる文字列です。例えばこれが "{filename}.ogg" なら voice "test" ステートメントは test.oggを再生します。

define config.with_callback = None link

None を指定するか with ステートメント が実行される時に呼び出される関数を指定します。この関数は画面に一時的に何かするために使用できます ( 例えばトランジション中はウィンドウを表示しないなど ) 。関数は一つの引数で呼ばれ、それは実行されているトランジションです。トランジションを返すことが期待され、それが実際のトランジションに使用されますが、引数と同じでもそうでなくてもかまいません。