RE:QUEST

A dungeon RPG you play through REST API. Just `curl` and JSON.

## What is RE:QUEST?

RE:QUEST is a server-hosted text RPG where the REST API itself is the game.

There is no GUI, no client app — bring your own (curl, Postman, VS Code REST Client,

or anything you can write yourself).

The server tracks your characters, items, dungeon progress and battles.

Everything happens through plain HTTP requests.

## Features

- 4 base jobs: Fighter / Mage / Priest / Thief, with intermediate job changes

- 4 dungeons of increasing difficulty

- Full bilingual support: pass `Accept-Language: en` or `ja`

- Persistent server, progress is saved by API key

## Quick start

For English responses, add `-H "Accept-Language: en"` to every request.

Without it, the server replies in Japanese.

    # 0. Read the in-game help (no auth required)

    curl https://ik1-126-69904.vs.sakura.ne.jp/v1/help \

      -H "Accept-Language: en"

    # 1. Register and get your API key

    curl -X POST https://ik1-126-69904.vs.sakura.ne.jp/v1/register \

      -H "Accept-Language: en"

    # 2. Save it (don't share with anyone)

    export API_KEY="rq_xxxxx..."

    # 3. Check your player state

    curl https://ik1-126-69904.vs.sakura.ne.jp/v1/player \

      -H "X-API-Key: $API_KEY" \

      -H "Accept-Language: en"

Each response includes `available_actions` — follow them to discover the game.

## Recommended clients

- VS Code with the **REST Client** extension

- Postman / Insomnia

- Plain `curl` in your terminal

- Build your own GUI/CLI wrapper — that's part of the fun

## Notes

- **Never share your API key.** It's your save data.

- **Rate limit: 60 requests per minute per IP / per player.** Hitting the limit

  returns `429 Too Many Requests`. If you write a script, sleep ~1 second

  between requests to stay safe.

- This is an early release. The server runs on a personal VPS, and the service

  may be discontinued in a few months depending on demand and operating cost.

  Bug reports and feedback are very welcome while it's online.

---

# 日本語

`curl` と JSON だけで遊ぶ、サーバー型のダンジョン RPG です。

ゲーム本体は REST API。専用クライアントはありません — お好きなツール

(curl, Postman, VS Code の REST Client, 自作スクリプト) で遊んでください。

サーバーがキャラクター・アイテム・進行状況を管理します。すべては HTTP リクエストで動きます。

## 特徴

- 4 つの基本職 (戦士・魔法使い・僧侶・盗賊) と中位職へのジョブチェンジ

- 4 つの難易度の異なるダンジョン

- 日英バイリンガル対応 (`Accept-Language: en` または `ja`)

- 永続化サーバー、進行は API キーで保存

## クイックスタート

    # 0. ゲーム内ヘルプを読む (認証不要)

    curl https://ik1-126-69904.vs.sakura.ne.jp/v1/help

    # 1. アカウント登録 (API キー発行)

    curl -X POST https://ik1-126-69904.vs.sakura.ne.jp/v1/register

    # 2. レスポンスの api_key を保存

    export API_KEY="rq_xxxxx..."

    # 3. プレイヤー情報を確認

    curl https://ik1-126-69904.vs.sakura.ne.jp/v1/player \

      -H "X-API-Key: $API_KEY"

各レスポンスに含まれる `available_actions` を辿って、世界を探検してください。

## 推奨クライアント

- VS Code + **REST Client** 拡張

- Postman / Insomnia

- ターミナルで curl 直叩き

- 自作の GUI / CLI ラッパー (実装するのもまた楽しい)

## 注意

- **API キーは絶対に他人に見せないでください。** あなたの進行データそのものです

- **連続アクセスは IP / プレイヤー単位で 1 分 60 回まで。** 超過すると

  `429 Too Many Requests` が返ります。スクリプト化する場合は 1 秒程度の

  間隔を空けてください

- 個人 VPS で運営している初期リリースです。需要と運用コストの兼ね合いで、

  数ヶ月でサービスを終了する可能性があります。

  稼働中のバグ報告やご感想は大歓迎です