PythonとPygameで作るレトロ風RPG 全コード

同人誌について

　この連載は、同人誌『PythonとPygameで作るレトロ風RPG 全コード』を一部抜粋して編集したものです。

　同人誌本編には、ゲーム本体のソースコードや、各種のサンプルコード、Windowsで実行できるEXEファイルが付属しています。PDFで290ページの本になります。ぜひ、こちらもご購入ください。

（2024-03-28：ver1.0.4 に更新、2024-03-10：ver1.0.3 に更新）

5-2　初期化

公開：2024-03-14

init.py

　「init.py」は、「main.py」の補助的なモジュールです。行数が多い初期化処理を、関数にまとめています。

　このファイルでは、次のことをおこなっています。

カレントワーキングディレクトリの初期化
ゲームの初期化
- データの初期化
- シーンの追加
- 最初のシーンのセット

　それでは「src/init.py」を示します。

import os, sys
import mymod as m
from mymod.image import font
from mymod.data import game, audio, scene
from mymod.game.scene import Manager

# CWD（カレント ワーキング ディレクトリ）の初期化
def init_cwd():
    #print(os.getcwd())  # CWDの表示
    app_path = __file__
    if getattr(sys, 'frozen', False): app_path = sys.executable # EXE化時
    app_dir = os.path.dirname(os.path.dirname(app_path))    # 親の親
    os.chdir(app_dir)   # CWDの移動
    #print(os.getcwd())  # CWDの表示

# ゲームの初期化
def init_game():
    # データの初期化
    font.init()     # フォントの初期化
    game.data = game.Game.from_blank()   # データ作成
    audio.load_all()    # 音声のロード

    # シーンの追加
    Manager.add_scene(m.SceneTitle)
    Manager.add_scene(m.SceneMap)
    Manager.add_scene(m.SceneBattle)

    # 最初のシーンのセット
    Manager.set_next(scene.TITLE)
    #Manager.set_next(scene.MAP)
    #Manager.set_next(scene.BATTLE)

インポート部分

　まずは、インポート部分です。多くのものを読み込んでいます。

import os, sys
import mymod as m
from mymod.image import font
from mymod.data import game, audio, scene
from mymod.game.scene import Manager

　標準ライブラリのosとsysを読み込みます。また、mymodパッケージをmとして読み込みます。

　その他にfont game audio sceneといったモジュールを読み込みます。

　また、mymod.game.sceneモジュールのManagerクラスも読み込みます。

カレントワーキングディレクトリの初期化

　init_cwd()関数では、カレントワーキングディレクトリ（CWD）の調整をおこないます。

# CWD（カレント ワーキング ディレクトリ）の初期化
def init_cwd():
    #print(os.getcwd())  # CWDの表示
    app_path = __file__
    if getattr(sys, 'frozen', False): app_path = sys.executable # EXE化時
    app_dir = os.path.dirname(os.path.dirname(app_path))    # 親の親
    os.chdir(app_dir)   # CWDの移動
    #print(os.getcwd())  # CWDの表示

　「main.py」から実行したときと、『PyInstaller』で作ったEXEファイルから実行したときでは、パスの得方が違うので、その分岐をします。そして、次の図の「root/」のところをカレントワーキングディレクトリに変更します。

root/ …… ここをカレントワーキングディレクトリにする。
- src/
  - main.py
  - init.py …… 「main.py」から実行したとき。
- dist/
  - main.exe …… EXE化したとき。
- audio
- font
- image

　「main.py」から実行したときは、__file__を使って「init.py」の絶対パスを得ます。

　「main.exe」から実行したときは、sys.executableを使ってEXEファイルのパスを得ます。

　分岐は次の行でおこないます。

    app_path = __file__
    if getattr(sys, 'frozen', False): app_path = sys.executable # EXE化時

　getattr()関数は、オブジェクトの属性の値を得る関数です。第1引数がオブジェクト、第2引数が属性名、第3引数は属性が存在しなかったときのデフォルト値です。

　第3引数がなく、属性がなかったときはAttributeErrorが発生します。ここでは第3引数にFalseを設定しているのでエラーは発生しません。

　上のプログラムでは、sysオブジェクトにfrozenの値があり、かつTrueだったときに、app_path = sys.executableの処理を実行します。

　「root/」を、カレントワーキングディレクトリに変更しているのは、次の部分です。

    app_dir = os.path.dirname(os.path.dirname(app_path))    # 親の親
    os.chdir(app_dir)   # CWDの移動

　os.path.dirname()関数を2回使い、親ディレクトリの親ディレクトリを得ます。そしてos.chdir()関数で、カレントワーキングディレクトリを設定します。

　init_cwd()関数で使用している関数と、その説明をまとめておきます。

関数の説明

関数	説明
`getattr(o, k, d)`	オブジェクト`o`の、属性名`k`の値を取得。不在時のデフォルト値は`d`。
`os.getcwd()`	CWDを取得
`os.path.dirname(p)`	パス`p`のディレクトリを取得
`os.chdir(p)`	CWDをパス`p`に変更

ゲームの初期化

　ゲームの初期化をおこなうinit_game()関数の処理は、3つのブロックに分かれます。「データの初期化」「シーンの追加」「最初のシーンのセット」です。

# ゲームの初期化
def init_game():
    # データの初期化
    font.init()     # フォントの初期化
    game.data = game.Game.from_blank()   # データ作成
    audio.load_all()    # 音声のロード

    # シーンの追加
    Manager.add_scene(m.SceneTitle)
    Manager.add_scene(m.SceneMap)
    Manager.add_scene(m.SceneBattle)

    # 最初のシーンのセット
    Manager.set_next(scene.TITLE)
    #Manager.set_next(scene.MAP)
    #Manager.set_next(scene.BATTLE)