ドキュメント
EdgeWorksプラットフォームの導入・活用ガイド
はじめに
EdgeWorksアカウントの作成からSDKの導入まで、基本的なセットアップ手順を解説します。
- 1
野澤組のアカウントを作る
nozawatec.com で登録します。EdgeWorks 専用の登録はありません。
- 2
API キーを発行する
ダッシュボード(/edgeworks/dashboard)で発行します。平文はこのときだけ表示されます。
- 3
SDK を置く
FiveM なら edgeworks リソースをサーバーに置きます。ほかのプラットフォームは REST API を直接呼びます。
- 4
送り先と鍵を書く
config_server.lua の Config.ApiBaseUrl と Config.ApiKey を設定します。config.lua は全プレイヤーの端末へ配られるので、鍵はそちらに書きません。
- 5
動作を確かめる
サーバーを起動し、/screenshot を撮ってダッシュボードに出るか見ます。
基本コンセプト
アカウント
野澤組のアカウント 1 つに対して、EdgeWorks の保存容量と API キーが紐づきます。旧 EdgeWorks のアカウントは統合時に引き継がれます。
API キー
サーバーやアプリから呼ぶときの鍵です。ダッシュボードで発行し、いつでも失効できます。鍵は sha256 にしてから保存されるので、発行時に一度しか表示されません。
アップロード用の一時 URL(presigned URL)
先に置き場所を決めて、そこへ直接送るための URL を渡す仕組みです。FiveM の screenshot-basic は「撮った画像を指定の URL へ送る」ことしかできないので、これが要ります。有効期限は 1 時間です。
Webhook
未提供検知やアップロードの完了を外部に通知する仕組みです。現在は未提供です。
対応プラットフォーム
EdgeWorksの機能は REST API を通じて任意のプラットフォームから利用可能です。専用SDKの提供状況は以下の通りです。
FiveM / RedM
提供中Lua の SDK を配っています。edgeworks リソースを 1 つ置き、config_server.lua に送り先と API キーを書きます(このファイルはサーバーだけが読みます)。
詳しく見るREST API
提供中プラットフォームに依存しません。X-API-Key ヘッダーで認証し、任意の言語から呼べます。
詳しく見るMinecraft(Java)
未着手Bukkit / Spigot / Paper のプラグインを作る予定です。いまは REST API を直接呼んでください。
Rust(ゲーム)/ Oxide
未着手Oxide / uMod のプラグインを作る予定です。いまは REST API を直接呼んでください。
Node.js / Bun
無し専用の SDK はありません。REST API を直接呼んでください(X-API-Key ヘッダーで認証します)。
サービスガイド
EdgeVault
ゲーム内から上げた画像と動画の置き場。フォルダでの整理、公開 URL、アップロード用の一時 URL(Presigned URL)でのアップロード。
EdgeStream
サーバーが始めた配信の一覧と、録画の再生。停止・保存期間・1 本の長さの設定。配信を始めるのはサーバー側です。
EdgeGuard
サーバーからの不正の報告を受けて、規則どおりに BAN します。規則ごとの切り替え、BAN の一覧と解除、接続中のプレイヤー。
EdgeShift
組織のシフトを役割ごとに組みます。割り当ては組織の会員から選びます。
EdgeSite
部品を並べてページを作り、公開します。書いた HTML・CSS・JavaScript はそのまま出ますが、公開ページは別のオリジンとして配られます。
EdgeMap
移行中プレイヤーの位置を地図に出します。いま在るのは座標を受け取る経路(FiveM / RedM)と世界の定義までで、画面はこれから作ります。
よくある質問
無料プランの制限は?
10 GiB の保存容量、1 ファイル 100 MiB まで。レート制限はエンドポイントごとで、プランでは変わりません(API リファレンスに実際の値を載せています)。
SDK があるのはどのプラットフォーム?
FiveM / RedM だけです。ほかのプラットフォームは REST API を直接呼んでください。
データの保存場所は?
アップロードされたファイルは、これまでと同じくお名前ドットコムのサーバー(日本国内)に置かれます。目録(どのファイルが誰のものか)は野澤組の基盤に移ります。
旧サブドメインはいつ止まりますか?
移行から約 1 か月です。止まる日は事前にお知らせします。FiveM サーバーはそれまでに SDK を更新してください。
プランの変更は?
オンラインでのプラン変更は現在は未提供です。お問い合わせから承ります。