MikuSB/README_jp.md

# MikuSB

<strong>MikuSB</strong>は、あるダンジョンアニメゲームのサーバーエミュレーターです。  
`SdkServer`、`GameServer`、任意のローカル HTTP/HTTPS プロキシを 1 つの `net9.0` アプリとして起動します。  

[Discord](https://discord.gg/aMwCu9JyUR)

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](https://dotnet.microsoft.com/ja-jp/download/dotnet/9.0)

## 起動方法

1. 依存を復元してビルドします。

```powershell
dotnet build
```

2. 楽しんで

## 機能一覧

* [x] ログインと基本的なアカウント入場
* [x] プレイヤーデータの読み込み
* [x] 所持品の読み込み
* [x] キャラクターの読み込み
* [x] スキンの読み込み
* [x] 武器の読み込み
* [x] ロビー表示キャラクターの変更
* [x] キャラクタースキンの変更
* [x] キャラクタースキン形態の変更
* [x] 武器の付け替え
* [x] 武器の強化
* [x] プレイヤー名の変更
* [x] 現在対応済みロビー状態の基本保存
* [✓] メイン章のステージ入場と関連フロー
* [✓] デイリーのステージ入場と関連フロー
* [✓] 基本的なプレイヤー設定同期
* [✓] 基本的なプロフィール同期
* [✓] イベント関連リクエスト
* [✓] 実績関連リクエスト
* [✓] 編成関連リクエスト
* [✓] プレビュー関連リクエスト
* [✓] 一部のショップ関連リクエスト
* [ ] 完全な戦闘フロー
* [ ] ミッション / クエスト進行
* [ ] ガチャ / 募集システム
* [ ] 完全なショップ挙動
* [ ] マルチプレイシステム
* [ ] 基地 / 宿舎システム
* [ ] クライアント API 全体の対応

## 貢献者  
- [Naruse](https://github.com/DevilProMT)
- [Kei-Luna](https://github.com/Kei-Luna)


## 利用上の注意
本ソフトウェアはローカル環境での研究・検証用途を想定しています。  
公式サービスへの不正な接続、妨害、または商用利用を意図したものではありません。

## 法的免責事項
MikuSBは教育および研究目的で開発されました｡  
- 元のゲーム及び関連フランチャイズに関するすべての商標､著作権知的財産権はそれぞれの所有者に帰属します｡  
- このリポジトリには､著作権で保護されたゲームアセット､バイナリ､マスターデータは一切含まれていません｡  
- 自己責任でご利用下さい｡ 著者は､本ソフトウェアによって生じるいかなる損害または法的結果についても一切責任を負いません｡  

本ソフトウェアに関して懸念事項をお持ちの権利保有者は`devilpromt`または`kei_luna`にDiscordでご連絡下さい｡