Pulse Phone のドキュメント
インストールの詳細
1. クイックインストール
コピーする前に
下の動作要件を満たすサーバーアーティファクトを使い、OneSync を有効にし、ゲームビルド 2699 以降にしてください。通常のロールプレイサーバーでは、framework、インベントリ、oxmysql、ボイスリソース、screenshot-basic が先に動いている状態にしてください。framework なしの standalone でも動作し、その場合インベントリのアイテムは任意です。
購入を受け取った後、Cfx.re アカウントからリソースをダウンロードします。アセットを所有しているアカウントのサーバーキーを使ってください。Cfx.re が権利(entitlement)のエラーを報告する場合は、アカウントとキーの紐づけを修正してください。スマホの設定を変えても権利は付与されません。
手順1 — リソースをサーバーに置く
パッケージを展開し、phone リソースフォルダー(fxmanifest.lua が入っているもの)を、サーバーの resources ディレクトリにコピーしてください。名前は変えず、外側の ZIP やパッケージのフォルダーを代わりに置かないでください。
ホスティングサーバーでは、Binary モードでアップロードするか、zip をアップロードしてそこで展開してください(理由)。クイックスタート(手順2)に、このビルドの各フォルダーのファイル数とサイズが載っており、欠けているファイルやサイズが違うファイルは起動時チェックが名前を表示します。
Pulse をテストする前に以前のスマホのリソースを停止し、2つのスマホが同じキーとアイテムを取り合わないようにしてください。後でインポートする予定なら、そのデータをバックアップしておいてください。
手順2 — インベントリにアイテムを追加する
今お使いのインベントリを選んでください。置き換える必要はありません。
| お使いのインベントリ | 必要な作業 |
|---|---|
| ox_inventory | 付属の config/items/ox_inventory.lua を開き、その項目を ox_inventory/data/items.lua の既存のテーブル内にマージしてください。インベントリのファイル全体を置き換えないでください。ox_inventory 自身の phone 項目は残してください。使うと Pulse Phone が開き、起動時チェックの Phone item 行で確認できます。その行で別のスクリプトが開くと表示された場合にだけ、表示された項目に置き換えてください。画像は config/items/images/ から ox_inventory/web/images/ にコピーします。編集後はサーバーを再起動してください。 |
| qb-inventory と QBCore | 足りないアイテム定義は起動時に自動で登録されます。config/items/images/ を qb-inventory/html/images/ にコピーしてください。インベントリで恒久的な共有項目が必要な場合は、付属の config/items/qb-core.lua を qb-core/shared/items.lua にそのままマージできます。 |
| ESX 標準インベントリ | 足りないアイテムは自動で追加されます。コンソールが再起動を求めた場合は、ESX が読み込めるよう一度再起動してください。データベースのアカウントで追加できない場合は、config/items/esx.sql を使ってください。 |
| qs-inventory またはその他の対応インベントリ | アイテムとインベントリにある、お使いのインベントリの短い説明に従ってください。そのインベントリのアイテムリストと画像フォルダーを使います。 |
| インベントリなしの standalone | インベントリの項目は不要です。アイテムの必須設定はオフのままにしてください。 |
起動時チェックが足りない項目を特定し、まだ必要な定義だけを表示します。ox_inventory のように起動時にアイテム定義を読み込むインベントリでは、上の項目が必要です。Pulse が他のリソースのファイルを上書きすることはありません。
手順3 — メインの設定を確認する
config/config.lua を開きます。既定値で既存の構成が検出されます:
Config.Framework = 'auto'inventory = 'auto' は既存の Config.Providers テーブル内にそのまま残してください。複数のインベントリリソースを動かしている場合は、その値を使いたいインベントリ(たとえば 'ox_inventory')に設定します。ファイルの末尾に2つ目の Config.Providers や Config.Item テーブルを追加しないでください。
既存の Config.Item テーブルで、スマホの扱い方を選びます:
| 設定 | 内容 |
|---|---|
required = false, unique = false |
各キャラクターはアイテムを持たなくてもスマホを持っています。最初のテストに便利です。 |
required = true, unique = false |
キャラクターが自分のスマホを開くには phone アイテムが必要です。そのアイテムを人に渡しても、データは移りません。 |
unique = true |
スマホアイテムごとに専用の番号とデータを持ちます。アイテムを渡すと、その端末ごと渡ります。ox_inventory、qb-inventory、qs-inventory、core_inventory、codem-inventory のいずれかが必要です。 |
name = 'phone' |
インベントリのアイテム名。付属のアイテム定義も変更する場合以外は、このままにしてください。 |
固有のスマホは、選ばれたインベントリブリッジに従います。Config.Item.inventory = 'auto' のままにしてください。この古い上書き設定は既存の上級者向けインストール専用です。Config.Providers.inventory を明示的に設定した場合は、そちらが優先されます。
既存のサーバーで Config.IdentityScope を変更しないでください。既定の 'character' では、キャラクターごとのスマホが別々に保たれます。
任意:インベントリのスマホと有料の通信サービス
スマホごとに別の端末アイテムを必須にするには、インベントリの項目を追加した後、required = true と unique = true を、Config.Item テーブル(config/config.lua 内の既存のもの)に設定してください。上に挙げた固有のスマホに対応したインベントリのいずれかを使ってください。
通信サービスを販売するには、同じファイルで Config.Carrier.enabled = true を設定します。これで Carrier アプリが有効になり、プレイヤーはそこでプランを購入します。新しいスマホは、通常の通話、メッセージ、モバイルデータを使うアプリの前にプランが必要になります。App Hub はアプリをインストールする場所で、通信サービスの店ではありません。圏外エリアも使いたい場合は Config.Coverage.enabled = true を設定してください。電波エリアと有料プランは別々のオプションなので、不要な機能はオフのままにしてください。
重複したテーブルを追加せず、既存の設定を編集してください。保存後はサーバーを再起動してください。ゲーム内の設定を以前に保存していた場合は、ファイルの値が適用されるよう Settings → Server でその設定をリセットしてください。
手順4 — Pulse より先に依存リソースを起動する
既存のデータベース接続と framework の設定はそのままにしてください。足りない行だけを追加し、依存リソースを2重に起動しないでください。
サーバーにすでにインストールされているリソースで、この順序にしてください:
- データベースリソースと、その既存の接続設定。
- framework と、その必須ライブラリ、ID・キャラクターのリソース。
- インベントリ。お使いの framework 用のそのインベントリの設定で。
- 対応するボイスリソースひとつと
screenshot-basic。 ensure phone.
Pulse のためだけに ESX、QBCore、別のインベントリをインストールしないでください。具体的な起動順の例は、お使いの framework で今の構成を選んでください。Qbox は、他のリソースが QBCore 互換の exports を使っていても Qbox として検出されます。
Pulse の管理者権限には add_ace group.admin phone.admin allow を追加します。この権限を適用するには、管理者アカウントがすでに group.admin に属している必要があります。
手順5 — 初回起動時のチェックを読む
サーバーを再起動してください。Pulse は起動レポートを表示し、SQL 接続が使えるとデータベースのテーブルを自動で作成します。
- FIX / FAIL:必須の部分が動作できません。プレイヤーに使わせる前に、修正の行に従ってください。
- NOTE / WARN:どの機能に影響するかを読んでください。設定していない任意の機能についての警告もあります。
- サーバーコンソールで
phone:healthを実行すると、チェックをもう一度行えます。 phone:diagを実行すると、選ばれた framework、インベントリ、プロバイダーを確認できます。- 管理者として参加し、F8 を開いて
phone:setupを実行すると、既存のガイド付きセットアップが始まります。
ゲーム内の管理者セットアップで保存した設定は、対応するファイルの設定より優先されます。ファイルの変更が無視されているように見える場合は、さらにファイルを変更する前に Settings → Server を確認し、保存された上書きをリセットしてください。
手順6 — プレイヤーとしてテストする
- キャラクターを読み込み、F1 を押してスマホのセットアップを完了してください。アイテムの必須設定がオンの場合は、先にショップでスマホを買うか、設定したスマホアイテムをキャラクターに渡してください。
- 封をした箱を買った場合は、インベントリから箱を使って開封し、セットアップを完了してください。端末は電源が入った状態で届きます。
Config.Device.arrivesOn = falseの場合は、先に End か O を長押ししてください。 - Messages、Contacts、Phone を開きます。ホームに戻り、App Switcher を開いて、各アプリを順番に閉じてください。
- 写真と短い動画を撮ります。両方を Photos で開き、スマホを閉じてもう一度開いて、残っていることを確認してください。
- 再接続して、同じキャラクターが同じスマホを持っていることを確認してください。インストール済みのボイスリソースを使い、2人目のプレイヤーと通話をテストしてください。
変更する場所
| 変更したいもの | ファイルまたは場所 |
|---|---|
| framework、インベントリのプロバイダー、スマホアイテム、ショップ、モデル、キー割り当て | config/config.lua |
| ボイスのプロバイダー | config/config.lua |
| アプリとサービス/ジョブの設定 | config/apps.lua |
| インベントリの項目と画像 | config/items/ |
| データベース接続、リソースの起動順、メディアホストの認証情報 | server.cfg(非公開の認証情報はサーバー側に置いてください) |
| 開発者向け連携 | 高度な連携、任意の Developer Kit(zerodevscripts.com/downloads/PulsePhone-developer-kit.zip)、既存の bridge/ ファイル。通常のインストールではこれらを編集する必要はありません |
| 内蔵ストレージを使うプレイヤーの写真・動画 | media/。アップデート時はこのフォルダーを残してください |
以下のセクションに詳しいリファレンスがあります。最初のインストールを終えるために、すべての機能の設定を読む必要はありません。