Skip to content

kakomimasu/server

Repository files navigation

囲みマス Server

概要

Kakomimasu Coreを使用した、囲みマスをオンラインで対戦するためのサーバです。

https://api.kakomimasu.com

環境変数

変数 説明 デフォルト
PORT リクエストを受信するポート "8880"
BOARDNAME フリーマッチで使われるボード
指定なしでランダムに選ばれる
DISCORD_WEBHOOK_URL 予期しないエラー発生時のDiscordチャンネルWebHook URL
VERSION 現在のバージョン名
/versionアクセス時に使用される
"local"
DENO_KV_ACCESS_TOKEN 本番環境用に使用するKVのトークン
指定なしでローカルのKVストアを使用
GITHUB_CLIENT_ID GitHub OAuthログイン用
詳細はこちらを参照
GITHUB_CLIENT_SECRET GitHub OAuthログイン用
詳細はこちらを参照
TEST テスト時のフラグ true

.envファイルが使用できます。(dotenv)
GITHUB_CLIENT_*が未指定の場合、アカウントに関連する機能(BearerTokenを用いたAPI)は利用できません。ゲストモードによるゲーム参加は可能です。

開発者向け

サーバ起動

deno task start

API定義

OpenAPIにて定義されています。

API Version OpenAPI file Document
miyakonojo openapi.ts https://kakomimasu.com/docs/api/miyakonojo
tomakomai openapi.ts https://kakomimasu.com/docs/api/tomakomai
v1 openapi.ts https://kakomimasu.com/docs/api/v1

使用フィールド

#procon30の公開フィールド他、独自フィールドが搭載されています。

テスト

deno task test