readme

README_jp.md

@@ -0,0 +1,76 @@
+# MikuSB
+
+Snowbreak: Containment Zone 向けの C# 製プライベートサーバー再実装です。  
+`SdkServer`、`GameServer`、任意のローカル HTTP/HTTPS プロキシを 1 つの `net9.0` アプリとして起動します。
+
+English documentation is available in [README.md](README.md).
+
+## 概要
+
+- `SdkServer`
+  - HTTP API とディスパッチを返します
+  - サーバー一覧、バージョン照会、各種フォールバックレスポンスを返します
+- `GameServer`
+  - TCP ベースのゲーム接続を受けます
+  - `ReqCallGS` と一部の通常パケットを処理します
+- `Proxy`
+  - 有効時のみ `127.0.0.1:8888` で待ち受けます
+  - 一部の Snowbreak 関連ドメインをローカル `SdkServer` へリダイレクトします
+- `Common` / `Proto` / `TcpSharp`
+  - 共通データ、protobuf 定義、通信基盤です
+
+## プロジェクト構成
+
+- [MikuSB](MikuSB): エントリーポイント
+- [SdkServer](SdkServer): HTTP サーバーとディスパッチ
+- [GameServer](GameServer): ゲームサーバー本体
+- [Proxy](Proxy): ローカルプロキシ
+- [Common](Common): 設定、DB、共通処理
+- [Proto](Proto): protobuf 定義
+
+## 要件
+
+- .NET SDK 9.0
+
+## 起動方法
+
+1. 依存を復元してビルドします。
+
+```powershell
+dotnet build
+```
+
+2. 楽しんで
+
+## 機能一覧
+
+- `[x]` ログインと基本的なアカウント入場
+- `[x]` プレイヤーデータの読み込み
+- `[x]` 所持品の読み込み
+- `[x]` キャラクターの読み込み
+- `[x]` スキンの読み込み
+- `[x]` 武器の読み込み
+- `[x]` ロビー表示キャラクターの変更
+- `[x]` キャラクタースキンの変更
+- `[x]` キャラクタースキン形態の変更
+- `[x]` 武器の付け替え
+- `[x]` 武器の強化
+- `[x]` プレイヤー名の変更
+- `[x]` 現在対応済みロビー状態の基本保存
+- `[✓]` メイン章のステージ入場と関連フロー
+- `[✓]` デイリーのステージ入場と関連フロー
+- `[✓]` 基本的なプレイヤー設定同期
+- `[✓]` 基本的なプロフィール同期
+- `[✓]` イベント関連リクエスト
+- `[✓]` 実績関連リクエスト
+- `[✓]` 編成関連リクエスト
+- `[✓]` プレビュー関連リクエスト
+- `[✓]` 一部のショップ関連リクエスト
+- `[ ]` 完全な戦闘フロー
+- `[ ]` ミッション / クエスト進行
+- `[ ]` ガチャ / 募集システム
+- `[ ]` 完全なショップ挙動
+- `[ ]` マルチプレイシステム
+- `[ ]` 基地 / 宿舎システム
+- `[ ]` クライアント API 全体の対応
+