Pigframeは主に Python を使ったゲーム開発プロジェクト向けのミニマムな ECS (Entity Component System) ライブラリです。言語が Python でゲーム開発に ECS を採用したいケースはごく稀だとは思いますが、ECS + ステート管理を1つのライブラリとして提供されている OSS が(開発を始めた時点では) 存在しなかったので、このライブラリを制作しました。
-
コンポーネントベースのアーキテクチャ: Pigframe はコンポーネントベースのアプローチを採用し、モジュラーでスケーラブルなゲーム開発を可能にします。このアーキテクチャは、ゲーム要素の簡単な追加、変更、管理を容易にします。
-
直感的なシーン管理: Pigframe の直感的なシーン遷移と制御システムで、ゲームシーンをシームレスに管理します。この機能により、スムーズな遷移と効率的なシーンの整理が可能になります。
-
効率的なエンティティ-コンポーネントシステム: Pigframe の中心は、機能の分離を促しパフォーマンスを高めるのに効果的なエンティティ-コンポーネントシステム（ECS）です。
-
プログラミング学習者向け: Pigframe はシンプルさと可読性の高い Python で書かれています。Python でゲーム開発を学びたい人、ゲームを作ってみたい人、アクセスしやすいが頑健なツールを求めている個人開発者に最適におすすめのフレームワークです。
-
併用しやすい: Pigframe は、Pyxel や Pygame のような人気のある Python ゲームエンジンライブラリを使って多様で創造的なゲームを開発したいときに使うとピッタリです。
Pigframe を始めるには、PyPI から pigframe をインストールするだけです。
Pigframe に依存するパッケージはありません。
pip install pigframe # pigframe has no dependencies.-
モジュールをインポートする
from pigframe import World, System, Event, Screen, Component
-
専用の world クラスを作成する。world クラスは エンティティー, エンティティーに紐づいたコンポーネント, システム, イベント, 画面処理 を管理するゲームのコアとなるクラスです。
# Implement World class for your own project. class App(World): def __init__(self): super().__init__() self.init() # write initial process which is unique to the game engine and the game you develop. ... # other game engine unique methods. app = App()
-
エンティティーをワールドに追加、削除する
# Create entity to world. entity = app.create_entity() # -> int: entity ID # Remove entity from world. app.remove_entity(entity) # deletes from entites list
-
エンティティーにコンポーネントを追加/削除する
- エンティティーにコンポーネントを追加する
# Add component to entity ID. # Components are recorded as values where entity ID is the key inside dict. # Component instance are created automatically. app.add_component_to_entity(entity, ComponentA, **component_args) # ComponentA is not an instance of Component but type. app.add_component_to_entity(entity, ComponentB(**component_args)) # this is wrong way of use. # getter app.get_component(ComponentA) # Returns the list of tuple: entity id which has ComponentA, component object. -> list((int, ComponentA object)) app.get_components(ComponentA, ComponentB) # Returns the list of tuple: entity id (which has ComponentA and ComponentB), tuple of components objects. -> list((int, (ComponentA obj, ComponentB obj))
- エンティティーに紐づいているコンポーネントを削除する
app.add_component_to_entity(ent, ComponentA, component_argsA) app.add_component_to_entity(ent, ComponentB, component_argsB) app.remove_component_from_entity(ent, ComponentA) # remove single component instance from entity app.add_component_to_entity(ent, ComponentC, component_argsC) app.remove_components_from_entity(ent, ComponentB, ComponentC) # remove components instances from entity
-
コンポーネントの値を syste, event, screen で使う
# Example of using get_components() method. class SystemA(System): def process(self): for ent, (pos, vel) in self.world.get_components(Position, Velocity): """ This method returns ------- list: list of tuple: entity id, list of components """ pos.x += vel.x pos.y += vel.y
-
エンティティーを使う
# Example of using entity object class EventA(Event): def __process(self): player = self.world.get_entity_object(entity = 0) """ This method returns a dict ----------- dict: entity object key: component type value: component """
-
ゲームのシーンをワールドに追加する
# Add scenes to world. app.add_scenes(["launch", "game", "result", "settings"]) app.add_scene("game_over") # scenes getter app.sceneces # -> [["launch", "game", "result", "settings", "game_over"]
-
ゲームのシステムをワールドに追加・削除する
# Add screen to a scene of world. Be sure you have added scenes before adding screens. # System instance are created automatically. app.add_system_to_scenes(SystemA, "launch", priority = 0, **system_args) # system with its lower priority than the other systems is executed in advance., by default 0. # World calls System A then System B. app.add_system_to_scenes(SystemA, "game", priority = 0, **system_args) app.add_system_to_scenes(SystemB, "launch", priority = 1) # Remove system from scene. app.remove_system_from_scene(SystemA, ["launch", "game"])
-
画面処理をワールドに追加・削除する
# Add screen to a scene of world. Be sure you have added scenes before adding screens. # Screen instance are created automatically. app.add_screen_to_scenes(ScreenA, "launch", priority = 0) app.add_screen_to_scenes(ScreenB, "launch", priority = 0) app.add_screen_to_scenes(ScreenC, "game", priority = 0, **screen_args) # Remove screen from scene. app.remove_screen_from_scene(ScreenB, "launch")
-
イベント処理をワールドに追加・削除する
# Add an event, event triger to a scene of world. Be sure you have added scenes before adding events. # Event instance are created automatically. app.add_event_to_scene(EventA, "game", callable_triger, priority = 0) # Remove event from scene. app.remove_event_from_scene(EventA, "game")
-
状態遷移（シーン・ステート遷移に使えるもの）を追加する
app.add_scene_transition(scene_from = "launch", scene_to = "game", triger = callable_triger) # triger has to be callable.
-
システム、イベント、画面処理を実行する
# Pyxel Example class App(World): ... def run(self): pyxel.run(self.update, self.draw) def update(self): self.process() # World class has process method. # process method calls these internal methods below. # 1. process_systems() # 1. process_events() # 1. scene_manager.process() def draw(self): self.process_screens()
In
update()method, of course, you can customize execution order as well.def update(self): self.process_user_actions() self.process_systems() self.proces_events() self.scene_manager.process() # Pigframe implements scene listener and World class use this class to manage scenes.
# Pygame Example class App(World): ... def run(self): while self.running: self.update() self.draw() def update(self): self.process() def draw(self): self.process_screens()
| ゲームエンジン | 例 | 内容 |
|---|---|---|
| Pyxel | Super simple 2D shooting | examples of system, event, component, actions and world implementations. |
| Pygame | Demo of player's controlling a ball | examples of system, event, component and world implementations. |
| Pyxel | Demo of player's controlling a ball | examples of system, event, component and world implementations. |
バグレポート、機能リクエスト、コードの貢献など、Pigframe をより良いライブラリにするためのどんなインプットも貴重だと考えます。どのような形であれ PR, issue を歓迎します。