ドキュメントのメニュー
はじめに
EdgeWorks のドキュメント
できること
EdgeGuard
検知の記録・スコア、接続中のプレイヤー、手動の警告・退出・BAN、スクリーンショットと配信開始。スコアの段に応じた自動の退出・一時 BAN と証拠の自動撮影は、設定で選んだときだけ行います(既定は切。永久 BAN は自動では張りません)。
ダッシュボードで開くEdgeMap
接続中のプレイヤーのいまの位置を地図に出します(FiveM / RedM。座標は EdgeGuard のテレメトリ経由)。地図の背景は昼と夜の 2 つを配っています。人を選ぶと、その人の位置の記録(軌跡)を点で重ねます(記録と記録のあいだは線でつなぎません)。API では GET /guard/track で読み出せます。
ダッシュボードで開くはじめかた(FiveM / RedM)
- 1
- 2
- 3
- 4
API キーを書く
server.cfg に set edgeworks_api_key "…" と書きます(または config_server.lua)。config.lua は全プレイヤーの端末へ配られるので、キーはそちらに書きません。
手順を詳しく見る - 5
動作を確かめる
サーバーのコンソールで edgeworks-status を打ち、ゲーム内で /screenshot を撮って、ダッシュボードの EdgeVault に出るか見ます。
対応している環境
FiveM / RedM
提供中Lua の SDK を配っています。edgeworks リソースを 1 つ置き、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 ヘッダーで認証します)。
基本の考えかた
アカウント
野澤組のアカウント 1 つに、EdgeWorks の保存容量・配信の時間・API キーが紐づきます。以前の EdgeWorks のアカウントは引き継ぎ済みです。
組織
チームで使うときの単位です。メンバーを招待し、サービスごとに閲覧・編集の権限を分けられます。組織のデータを FiveM サーバーから読み書きするには、組織用の API キーを使います。
API キー
サーバーやアプリから呼ぶときの鍵です。ダッシュボードで発行し、いつでも失効できます。キーはこちらでは元に戻せない形にして保存するので、発行したときに一度しか表示されません。
アップロード用の一時 URL(presigned URL)
先に置き場所を決めて、そこへ直接送るための URL です。FiveM の screenshot-basic のように「撮った画像を指定の URL へ送る」ことしかできない仕組みでも、API キーを渡さずにアップロードできます。有効期限は 1 時間です。URL を作ったまま送られなかったファイル(一覧に大きさ 0 で出るもの)は、期限が切れてから 1〜2 時間のうちに自動で消えます。