Batocera.linuxのWebフロントエンドはあまり手を入れられていない分野ではありますが、
ソースがEmulationStationに組み込まれていて書き換え(というかビルド)の敷居が高いため
手を入れることすら困難といった問題があります。
むかーしはHTMLだけローカルに拾ってくれば済む話だったんだけど、最近のブラウザって
セキュリティに過敏でどーでもいーとこまでいぢわるなんだもん。
というわけで、BatoceraのWebAPIを呼び出すだけのプロクシを組んでみました。
NullPopPoCustom用に機能整備されたものですが、本家Batoceraでも互換性のある部分は
だいたい動作確認できてます。ただしジャンル選択については本家でもいろいろと
挙動怪しげな部分あるので完全対応というわけにもいかないんだこれ。
で、NullPopPoCustomではとりあえず思い付きの機能入れるだけ入れてみたですが、
いろいろとイケてないところもありまして、改善いただけたら嬉しいなっと。
- fe/*: フロントエンドで扱うファイル群
- lib/*: バックエンドライブラリ
- config.template.json: 設定類テンプレート
- esncbe.cjs: EmulationStation Webバックエンドソース
- package.json: Node.js依存パッケージ
- README.md: 今読んでるやつ
- restart.bat: プロクシ再起動用bat
- setpath.template.bat: path設定バッチテンプレート
- shell.bat: シェルだけ起動したいときのbat
- start.bat: プロクシ起動用bat
- stop.bat: プロクシ終了用bat
まずNode.jsを調達よろし。
対応バージョンは知らんけど、とりあえずウチは18.16.1で動作確認した。
で、Windowsでは start.bat のある階層に setpath.bat を作成して、そこで
path C:\NodeJS;%PATH%
な感じでNode.jsのインストールpathを追加定義しときます。
Windows以外ではこれも含め、 *.bat に相当するスクリプトを移植して
これを代替手順とします。
なお、既定ではWeb APIが無効になっているので
EmulationStationのMAIN MENU > SYSTEM SETTINGS > DEVELOPER > ENABLE PUBLIC WEB ACCESS
をonにすると有効になりますが、ここで要注意点としてWeb APIは認証もなく
脆弱性度外視な仕様なので、Batoceraが稼働している端末のTCPポート1234は
絶っっっっっっっっ対にインターネット公開にしてはいけません。
遠隔操作され放題になりますよっと。
さて、プロクシの設定に戻るとしまして、
config.json のAPIBaseに http://Batocera端末のローカルIP:1234
な形で接続先を設定します。
(このURLを普通にwebブラウザで覗くとビルドされたフロントエンドが始まるはず)
ListeningPortにはプロクシで使うTCPポート番号を決めます。
準備できたら、Windowsでは start.bat で起動、stop.batで終了。
Windows以外では代替手順で。
そして proxy.js が実行されたところで、webブラウザから
http://localhost:さっき設定したポート番号
でプロクシ側のフロントエンドが起動されたら成功。
プロクシ側フロントエンドのソースは
fe/resources/services/index.html
にあります。
ちょっと変則的ですが、プロクシはEmulationStationの仕様に合わせ
/resources/* へのアクセスが fe/resources/* を参照し
/* へのアクセスが fe/resources/services/* を参照し
該当ファイルがどちらにもないときBatocera側へのアクセスを試みます。
というわけで、フロントエンドで使うファイルは fe/ 内の
所定の位置に置いていきます。
(本家互換)
拡張機能の対応状況をJSONにて取得します。
このため、フロントエンドでは最初に呼ぶべきAPIとなります。
本家Batocera37までにはない機能なので、ステータス404が返ってきたときは
古い本家版であることを前提として既定値を設定しておきます。
- Version: バージョン文字列
- SortName: ソート用名称に対応
- StrictTitle: 厳密なタイトル名称を別途保持
- Documentation: ゲーム毎のドキュメント情報に対応
- GetScraperMedia: scraperディレクトリ内参照可 (旧NullPopPoCustom仕様残骸)
- GetMediaResource: mediaディレクトリ内参照可
- GetScreenshot: スクリーンショット取得可
- JukeBox: ジュークボックス機能に対応
- RemoveMedia: メディアファイルの削除に対応
- SaveGenreByIDs: ジャンル情報をジャンルIDで保存する
- SlideShow: スライドショー機能に対応
- PartialGameList: ゲームリストの部分取得に対応
- DeleteMethod: HTTP DELETE対応
- CanGetMusic: musicディレクトリ内参照可
- CanGetSplash: splashディレクトリ内参照可
- CanGetSaves: savesディレクトリ内参照可
- GameSorts: EmulationStationでのソート条件テーブル
- GenreLanguages: ジャンル表示に対応する言語コードと表示名の辞書
- Flags: 対応するフラグ系MetaDataのキー名と表示名の辞書
- Texts: 対応するスクロール文書系MetaDataのキー名と表示名の辞書
- Books: 対応するブック文書系MetaDataのキー名と表示名の辞書
- Videos: 対応する動画系MetaDataのキー名と表示名の辞書
- Images: 対応する静止画系MetaDataのキー名と表示名の辞書
(本家互換)
Batocera Linuxを再起動します。
ゲーム実行中のときは、ゲーム終了後に処理されます。
(本家互換)
EmulationStationを再起動します。
ゲーム実行中のときは、ゲーム終了後に処理されます。
本来はEmulationStation終了を想定したものみたいですが、
Batoceraでは結局再起動されます。
(本家互換)
実行中のゲームを強制終了します。
(本家互換)
ゲーム一覧を現状に更新します。
(本家互換)
POST bodyにUTF-8文字列を添え、EmulationStationにポップアップ通知を表示します。
こちらは改行不可。
ゲーム実行中のときは、ゲーム終了後に処理されます。
(本家互換)
POST bodyにUTF-8文字列を添え、EmulationStationにダイアログ通知を表示します。
こちらは改行可。
ゲーム実行中のときは、ゲーム終了後に処理されます。
(本家互換)
POST bodyにゲームのインストールpathを添え、対象ゲームを実行します。
GAME SETTINGS > CHECK BIOS FILES BEFORE RUNNING A GAME
が有効になっているとダイアログに阻まれることがあるので無効化推奨。
ゲーム実行中のときは、ゲーム終了後に処理されます。
(本家互換)
実行中のゲーム情報をJSONにて取得します。
ゲームが実行されていないとき、 Batocera34まではステータス404、
Batocera35からはステータス201が返ってくるようです。
以下、未設定の項目は含まれないのでそれぞれ既定値として扱う必要があります。
- id: ゲームID
- path: ゲームのインストールpath
- name: ゲームの表示名
- systemName: システムキー名
- title: (NullPopPoCustom拡張) 厳密なタイトル名
- sortname: (NullPopPoCustom拡張) ソート用名称
- family: ゲームシリーズ名
- desc: ゲーム概要
- rating: 1.0を満点とした評価値
- runnable: (NullPopPoCustom拡張) ゲーム開始可能であることを示す
- favorite: お気に入り登録されていることを示す
- hidden: ゲーム一覧から隠されていることを示す
- kidgame: KIDモードUIでのゲーム一覧に含まれることを示す
- region: 頒布国コード
- lang: 対応言語コード
- …らしいけど、DLCでは国コードが設定されていたりする
- releasedate: 発売日 (ISO8601表記)
- developer: 開発元
- publisher: 発売元
- arcadesystem: アーケードシステム名
- NullPopPoCustomではアーケード以外でもこれに準じる何かとして流用想定
- genre: 英語表記でのジャンル群
- 本家では、この値でゲーム一覧に保存される
- しかしフォーマット不定な問題あって合わせようなさげ
- 本家では、この値でゲーム一覧に保存される
- genres: ジャンルIDでのジャンル群
- 複数のジャンルは , 区切りで示す
- NullPopPoCustomでは、この値でゲーム一覧に保存される
- players: プレイヤー人数
- premise: (NullPopPoCustom拡張) 前提事項
- story: (NullPopPoCustom拡張) ストーリー
- rule: (NullPopPoCustom拡張) ゲームルール
- operation: (NullPopPoCustom拡張) 操作説明
- credit: (NullPopPoCustom拡張) クレジット
- tips: (NullPopPoCustom拡張) 有用な情報群
- notes: (NullPopPoCustom拡張) 雑多な情報群
- bugs: (NullPopPoCustom拡張) バグ情報群
- manual: 取扱説明書
- magazine: 雑誌記事
- video: 動画path
- thumbnail: サムネイル画像path
- 本家BatoceraではBox扱いになっている
- image: 雑多な画像path
- EmulationStationでサムネイル扱いになる方
- titleshot: タイトル画像path
- ingame: (NullPopPoCustom拡張) インゲーム画像path
- outgame: (NullPopPoCustom拡張) アウトゲーム画像path
- visual: (NullPopPoCustom拡張) ビジュアルシーン画像path
- bezel: ベゼル画像path
- marquee: ロゴ画像path
- boxart: パッケージ表画像path
- 本家BatoceraではAlt Box扱いになっている
- boxback: パッケージ裏画像path
- cartridge: カートリッジ画像path
- pcb: (NullPopPoCustom拡張) 基板画像path
- flyer: (NullPopPoCustom拡張) 広告画像path
- instcard: 操作カード画像path
- wheel: (用途不明)画像path
- fanart: ファンアート画像path
- mix: 雑多な画像path
- EmulationStationで扱われない方
- map: マップ画像path
- playcount: プレイ回数
- lastplayed: 前回実行日時 (ISO8601表記)
- gametime: 総プレイ秒数
- docsAvailable: (NullPopPoCustom拡張) ゲーム毎scraperディレクトリにdocs.jsonがある
- slideshowAvailable: (NullPopPoCustom拡張) ゲーム毎scraperディレクトリにslideshowディレクトリがある
- jukeboxAvailable: (NullPopPoCustom拡張) ゲーム毎scraperディレクトリにjukeboxディレクトリがある
(本家互換)
ゲームがインストールされている全ての機種やコレクションの情報をJSON配列で取得します。
(本家互換)
ゲームがインストールされている特定の機種やコレクションの情報をJSON配列で取得します。
インストールされていないシステムキー名を指定してもステータス404が返ってきます。
- name: システムキー名
- fullname: システム表示名
- hardwareType: ハードウェア分類名
- 厳密すぎると分類が細かくなりすぎてUIの操作性に悪影響を及ぼすため、NullPopPoCustomでは適当にまとめている。
- manufacturer: 製造元分類名
- 厳密すぎると分類が細かくなりすぎてUIの操作性に悪影響を及ぼすため、NullPopPoCustomでは適当にまとめている。
- releaseYear: 発売年
- theme: テーマ名 (未詳)
- extensions: 認識対象拡張子群配列
- visible: 一覧表示対象とする
- group: グループ統合先
- collection: コレクションであることを示す
- gamesystem: ゲーム群であることを示す
- スクリーンショットも含まれる
- groupsystem: グループであることを示す
- msx,nesなど複数のシステムが統合されたもの
- totalGames: 保持するゲーム本数
- visibleGames: 一覧表示対象のゲーム本数
- favoritedGames: お気に入り登録されたゲーム本数
- playedGames: 起動済ゲーム本数
- hiddenGames: 一覧から隠されたゲーム本数
- mostPlayedGame: 最も遊ばれているゲーム表示名
- logo: ロゴ画像path
(本家互換)
対象システムのロゴ画像を取得します。
(本家互換)
対象システムに属するゲーム群の情報をJSON配列で取得します。
(本家互換)
対象システムに属するゲーム群の情報をJSON配列で取得します。
(本家互換)
対象ゲームの情報をJSONにて取得します。
(内容は /runningGame と同じ)
(本家互換)
POST bodyにJSONを添え、対象ゲームの情報を書き換えます。
(書き換え不可項目は無視されます)
(本家互換)
対象ゲームのメディアデータを取得します。
(本家互換)
POST bodyにデータファイル内容を添え、対象ゲームのメディアデータを書き換えます。
(NullPopPoCustom拡張)
対象ゲームのメディアデータを削除します。
(NullPopPoCustom拡張)
対象ゲームのメディア置き場から相対pathでデータを取得します。
pathがディレクトリであるときは、ディレクトリ内のファイルやディレクトリ群をJSONにて取得します。
(本家互換)
POST bodyにXMLを添え、ゲーム一覧に追加するらしい(未詳)
(本家互換)
POST bodyにXMLを添え、ゲーム一覧から削除するらしい(未詳)
(NullPopPoCustom拡張)
スクリーンショットディレクトリから画像データを取得します。
(NullPopPoCustom拡張)
プリセットミュージックディレクトリからファイルを取得します。
(NullPopPoCustom拡張)
ユーザミュージックディレクトリからファイルを取得します。
(NullPopPoCustom拡張)
プリセットスプラッシュディレクトリからファイルを取得します。
(NullPopPoCustom拡張)
ユーザスプラッシュディレクトリからファイルを取得します。
(NullPopPoCustom拡張)
セーブディレクトリからファイルを取得します。
ゲ－ムのインストール先は /userdata/roms/システムキー名/ 内ですが、
この中にディレクトリを置くとそれがゲームグループとしてまとまった扱いになります。
- 1ゲームが複数のファイルで構成されているのをまとめる
- 複数のゲームに同じ設定をまとめて適用する といった効果があります。
本家Batoceraでは、 /userdata/roms/システムキー名/ 内に置かれます。
NullPopPoCustomでは、 /userdata/media/システムキー名/ゲームグループ名/ 内に置かれます。
(NullPopPoCustom拡張)
メディア置き場直下に docs.json を置くと、表示名とリンク先の辞書からなる
ドキュメントリンク集として扱われます。
リンク先に : が含まれるものはwebリンクとして扱い、
ないものはメディア置き場の相対pathとして扱われます。
(NullPopPoCustom拡張)
メディア置き場直下に jukebox ディレクトリを置くと、
その中の音楽ファイルを再生対象として取得できます。
(NullPopPoCustom拡張)
メディア置き場直下に slideshow ディレクトリを置くと、
その中の画像ファイルを再生対象として取得できます。