Mods Overview

EOS エコシステムで mod を配布および管理するための API の概要です

2 分で読めます

概要

Mod Interface は、高度なユースケースのために Mod Marketplace と相互作用するためのインターフェースをゲーム デベロッパーに提供する Epic Online Services のコンポーネントです。このページでは、Mod インターフェースの機能、潜在的なユースケースの概要を説明し、API インターフェースの記述を付けます。

現時点で この機能は、デスクトップ プラットフォームでのみ利用できます。

Mod インターフェースの機能

Mod をインストールする

ゲームは Mod Marketplace から特定の mod を インストールするように Mod Interface にリクエストすることができます。アクションは Epic Games Launcher によって実行されます。プレイヤーのライブラリに mod がない場合、mod は自動的に追加されます。これは非同期操作です。mod がインストールされて準備が完了すると、コールバック関数によってゲームに通知されます。

Mod をアンインストールする

Mod uninstallation はユーザーのローカル ハード ドライブからインストールされた mod を取り除きますが、プレイヤーのライブラリからは mod を取り除きません。これは非同期操作です。mod ファイルが取り除かれると、コールバック関数によってゲームに通知されます。

Mod を更新する

更新関数は mod を最新バージョンに更新するように Mod SDK にリクエストします。これは非同期操作です。更新が完了すると、コールバック関数によってゲームに通知されます。

Mod を列挙する

Mod Interface は Mod Marketplace でゲームに利用することができる mod のリストおよび現在ユーザーによってインストールされている mod のリストを提供することができます。1 つの Mod Interface API 関数が両方のリストを返します。ゲームは関数の引数を使用して、リクエストされたリストを指定します。これは非同期操作です。データが取得可能になりると、コールバック関数によってゲームに通知されます。

潜在的なユースケース

以下は、Mod Interface を使用することができる機能の例です。

マルチプレイヤー ゲームの mod 調整

クライアント ゲーム インスタンスがサーバー実行 mod に接続すると、クライアントとサーバーの両方が Mod Interface を使って、クライアントとサーバーの両方のマシンにインストールされている mod を調整して、不足している mod のリストを特定します。

サーバーは mod 列挙関数を呼び出して、インストールされている mod のリストを取得し、インストールされている mod の ID をシリアライズして、それらをクライアントに送信します。

クライアントはサーバーの mod リストをローカルにインストールされている mod と比較します。必要な mod がない場合、クライアントは mod インストールを呼び出して不足している mod をインストールします。

インゲーム Mod マネージャ

mod の列挙、インストール、アンインストール、更新用の関数を使って、ゲーム デベロッパーはインゲーム mod マネージャを使用することができます。

列挙関数を使ってタイトルとバージョンで利用可能でインストールされている mod のリストを取得し、インストール関数およびアンインストール関数を使ってゲームへの追加またはゲームからの削除を行い、更新関数を使って mod を最新バージョンの状態にします。

Mod SDK API

Mod SDK API の詳細については、以下の Epic Online Services (EOS) リソースを確認してください。