docs: 프로젝트 설명(README) 최신화

Author: devhwan0421

.gitignore

@@ -14,4 +14,7 @@ packages/
 db.config
 
 ## [ 로그 ]
-*.log
+*.log
+/Manager/QuestManager.cs
+/C#_GameServer.csproj
+/GameObject/Quest.cs

C#_GameServer.csproj

@@ -36,6 +36,7 @@
   </PropertyGroup>
   <ItemGroup>
     <Compile Include="Common\Packet.cs" />
+    <None Include="CsharpGameServer-Doc\doc\networking.md" />
     <Compile Include="DataManage\ItemData.cs" />
     <Compile Include="DataManage\MapData.cs" />
     <Compile Include="DataManage\NpcData.cs" />
@@ -54,7 +55,6 @@
     <Compile Include="GameObject\Map.cs" />
     <Compile Include="GameObject\Monster.cs" />
     <Compile Include="GameObject\Player.cs" />
-    <Compile Include="GameObject\Quest.cs" />
     <Compile Include="DataManage\DataManager.cs" />
     <Compile Include="Game\Dialogue\DialogueAcceptDecline.cs" />
     <Compile Include="Game\Dialogue\DialogueBase.cs" />
@@ -69,7 +69,6 @@
     <Compile Include="Manager\LoginManager.cs" />
     <Compile Include="DataManage\MonsterData.cs" />
     <Compile Include="Manager\NpcManager.cs" />
-    <Compile Include="Manager\QuestManager.cs" />
     <Compile Include="Manager\MapManager.cs" />
     <Compile Include="Network\PacketHandler.cs" />
     <Compile Include="Network\PacketMaker.cs" />
@@ -197,8 +196,16 @@
   </ItemGroup>
   <ItemGroup>
     <None Include="App.config" />
+    <None Include="CsharpGameServer-Doc\doc\architecture.md" />
+    <None Include="CsharpGameServer-Doc\README.md" />
     <None Include="packages.config" />
     <None Include="protocol.proto" />
+    <None Include="README.md" />
+  </ItemGroup>
+  <ItemGroup>
+    <Content Include="classDiagram.png" />
+    <Content Include="image01.PNG" />
+    <Content Include="sequenceDiagram.png" />
   </ItemGroup>
   <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
   <Import Project="packages\System.ValueTuple.4.6.1\build\net471\System.ValueTuple.targets" Condition="Exists('packages\System.ValueTuple.4.6.1\build\net471\System.ValueTuple.targets')" />

CsharpGameServer-Doc/README.md

@@ -0,0 +1,24 @@
+# C# GameServer
+
+## 아키텍처
+- [클래스 구성](./doc/architecture.md)
+
+## 네트워킹
+- 네트워킹 개요
+- [메모리 단편화](./doc/networking.md)
+- 세션 파이버
+- 로그인 과정
+- 메시지 송수신
+- 메시지 핸들링
+
+## 3. 주요 기능 구현 목록
+* IOCP
+* 싱글 스레드 게임 로직 처리
+* 로그인
+* 세션 관리
+* 플레이어 상태 관리
+* 몬스터 AI
+* 맵
+* 인벤토리
+* 퀘스트 시스템
+* JSON 기반 리소스 로드 시스템

CsharpGameServer-Doc/doc/architecture.md

@@ -0,0 +1,60 @@
+# 시스템 아키텍처 및 클래스 구성
+- 프로그램 메인
+	- Program.cs: 서버 초기화 및 실행 진입점
+
+- 게임 로직 스레드
+	- GameLogicThread.cs: 게임 로직 처리 및 일정한 틱 레이트 유지
+
+- 게임 데이터 관리
+	- DataManager.cs: 게임 데이터 관리 [싱글톤]
+	- MonsterData.cs: 몬스터 데이터 로드 및 관리
+	  - MonsterTemplate.cs: 몬스터 템플릿 정의
+	- ItemData.cs: 아이템 데이터 로드 및 관리
+	  - ItemTemplate.cs: 아이템 템플릿 정의
+	- MapData.cs: 맵 데이터 로드 및 관리
+	  - MapTemplate.cs: 맵 템플릿 정의
+	- QuestData.cs: 퀘스트 데이터 로드 및 관리
+	  - QuestTemplate.cs: 퀘스트 템플릿 정의
+		
+- 패킷 처리
+	- Packet.cs: 패킷 정의 및 직렬화/역직렬화 구현
+	- PacketHandler.cs: 패킷 처리 로직 구현
+	- PacketMaker.cs: 패킷 생성
+	- PacketSerializer.cs: 패킷 직렬화
+	- RecvBuffer.cs: 수신 버퍼 관리
+	- ~~PacketParser.cs: 패킷 역직렬화~~ (미리 역직렬화하여 게임로직스레드의 부하를 줄이려고 테스트 해봤으나 효과가 크지 않았음)
+	- ~~Protocol.cs: 패킷 정의~~ Google Protocol Buffers를 활용하여 JSON Serializition 비용을 줄이려고 테스트 해봤으나 효과가 크지 않았음)
+
+- 네트워크 및 세션
+	- SessionManager.cs: 세션 관리 및 연결/해제 처리
+	- UserSession.cs: 네트워크 처리(IOCP)를 담당하는 세션 객체
+	
+- 로그인
+	- LoginManager.cs: 로그인 처리 및 세션 관리
+	
+- DB 제어
+	- DbTransactionWorker.cs: 큐에 들어오는 DB 작업을 처리하는 워커 스레드 생성 및 처리 [싱글톤]
+	- DbManager.cs: CRUD 함수가 구현된 곳
+	- DbJob.cs: DB 작업 정보를 담는 클래스 (나중에 추가확장 가능. 예: 작업 우선순위, 재시도 횟수 등)
+	- RequestDto.cs: DTO 정의 클래스
+
+- 게임 시스템
+	- 플레이어 
+		- PlayerManager.cs: 플레이어 관리 [싱글톤]
+		- Player.cs: 플레이어 정보 및 상태 관리
+			- 인벤토리
+				- Inventory.cs: 인벤토리 관리 (플레이어에 붙는 컴포넌트)
+			- 퀘스트
+				- QuestComponent.cs: 퀘스트 진행 상태 관리 (플레이어에 붙는 컴포넌트)
+					- QuestProgress.cs: 퀘스트 진행 상태 정보
+					- QuestCondition.cs: 퀘스트 조건 정보
+	- 맵
+		- MapManager.cs: 맵 관리 [싱글톤]
+		- Map.cs: 맵 정보 및 해당 맵에서 발생하는 모든 이벤트 처리
+
+	- 몬스터
+		- Monster.cs: 몬스터 정보 및 상태 관리
+	- NPC
+		- NpcManager.cs: NPC 대화 처리 및 퀘스트 수락/진행/완료 처리 [싱글톤]
+	 - 아이템
+		- ItemManager.cs: 퀘스트 컴포넌트에서 보상지급 시 사용되는 아이템 생성 DB 요청 로직을 따로 분리함

CsharpGameServer-Doc/doc/networking.md

@@ -0,0 +1,19 @@
+# 네트워킹
+- IO 스레드 개수 8개로 설정
+- IO스레드는 CLR의 스레드풀을 활용
+- 물리가 아닌 논리프로세스 개수 만큼 설정하는 이유는 레지스터가 논리프로세스 수 만큼 있기 때문에 컨텍스트 스위칭이 발생하지 않기 때문
+- 캐시는 물리 개수 만큼 있지만 두 스레드가 같은 데이터를 읽고 있다면 성능상 이점이 생긴다(캐시히트라고 함. 반대의 경우는 캐시오염)
+- 특정 논리 프로세서에 붙이는 방법은 ProcessThread.ProcessorAffinity 설정
+- IOCP는 자체적으로 캐시히트율을 높이기 위해 가장 최근에 일을 마친 스레드를 먼저 깨우고 있음
+
+## 메모리 단편화
+- 85KB 이하는 SOH(Small Object Heap)에 할당됨
+- GC가 압축을 할 때 Pinning(고정)된 객체 때문에 단편화가 발생
+- Pinning은 IO작업 중일 때 발생
+- 그래서 버퍼를 85KB 이상으로 할당하여 LOH(Large Object Heap)에 할당되도록 함
+- LOH는 GC가 압축을 기본적으로 하지 않음 (2세대 GC에서는 압축)
+- LOH의 단편화도 문제가 되지만 ArrayPool을 사용하여 단편화 문제를 완화했음
+
+## SocketAsyncEventArgs
+- 기존방식: BeginReceive를 호출할 때마다 내부적으로 IAsyncResult 객체가 생성되고 소멸됨. 매우 비효율적
+- SocketAsyncEventArgs는 미리 만들어두고 재사용이 가능함. 현재 풀링방식으로 구현해놓지 않았음. 세션 내에서만 재사용 중

GameObject/Quest.cs

@@ -1,2 +1,136 @@
-# C-_GameServer
-마비노기 모바일 실버바인 서버엔진2 따라 구현하기
+# 🚀 C# Game Server
+> **NDC2018 [실버바인 서버 엔진 2] 설계 리뷰를 바탕으로 재구성한 C# IOCP & Stackless Fiber 서버**
+
+---
+
+## 1. 프로젝트 소개
+- 프로젝트 명: C# GameServer (Silvervine Engine 2 Reference)
+- 설명: 마비노기 모바일에서 사용된 실버바인 서버 엔진의 구조를 학습하고 IOCP 기반의 비동기 소켓 통신과 싱글 스레드 게임 로직 처리를 C#으로 구현한 프로젝트
+
+## 2. 핵심 기술 스택
+- 언어: C#
+- 네트워크: IOCP
+- 데이터 형식: JSON[리소스 로드, 패킷 직렬화(일부는 ProtoBuf 테스트 사용)]
+- 데이터베이스: MySQL, Dapper(ORM)
+- 로깅: Serilog(Seq 연동)
+
+## 3. 아키텍처
+
+### 🏗️데이터 흐름도
+> 클라이언트의 요청이 IOCP를 통해 수신되어 싱글 스레드 게임 로직에서 처리되고, 비동기 DB 작업으로 이어지는 전체 파이프라인
+
+![sequenceDiagram](./sequenceDiagram.png)
+
+### 🧱서버 컴포넌트 구조
+> 서버의 주요 도메인 간의 관계와 구조
+
+![classDiagram](./classDiagram.png)
+
+### ⚡실버바인 서버엔진2 아키텍처 따라하기
+- **Stackless Fiber 기반 로직 처리**
+	- 실버바인의 Stackful Fiber 구조를 분석하여 C#의 `async/await`와 Task를 활용하여 `Stackless` 방식으로 구현
+	- 비동기 IO 대기 구간이 포함된 로직을 동기식 순차 코드처럼 작성할 수 있게 하여 생산성을 높이는 구조로 설계
+- **Single-Thread Game Loop**
+	- 모든 게임 로직을 `싱글 스레드` 루프에서 순차적으로 처리하여 `데이터 일관성`을 보장
+	- 멀티스레드 환경의 `경쟁상태`와 `데드락` 문제를 근본적으로 제거하여 로직 설계 난이도를 낮춤
+- **Job Queue 시스템**
+	- `네트워크 IO` 와 `DB` 작업을 `게임 로직 스레드`와 분리하여 병목 현상 없는 구조로 설계
+
+### 📈 성능 지표
+- **처리량:** 동시 접속자 500명, 초당 10만 패킷(이동 패킷 200/s) 무난하게 처리 가능
+- **안정성:** 대규모 브로드캐스팅 상황에서도 **평균 루프 타임 8ms** 미만 유지(루프는 몬스터, 플레이어 브로드 캐스트 로직도 처리 중인 상태)
+	
+### 🌐 네트워크
+- **IOCP 기반 비동기 네트워크**
+	- 적은 수의 스레드로 여러 접속자를 효율적으로 처리
+	- 세션마다 버퍼풀과 SocketAsyncEventArgs를 활용하여 GC 부담을 최소화
+	- ArraySegment를 활용하는 RecvBuffer 클래스를 통해 메모리 절약
+
+### 💾 데이터베이스
+- **비동기 DB 워커**
+	- 별도의 DB 전용 스레드로 분리하여 게임 로직의 중단(Blocking) 없이 안전하게 데이터를 저장하고 불러올 수 있도록 설계
+
+### 🎮 MMORPG 게임 콘텐츠 시스템 구성
+| 시스템 명칭 | 주요 역할 및 상세 기능 |
+| :--- | :--- |
+| **인증 시스템** | 클라이언트 접속 제어, DB 연동을 통한 사용자 인증 및 캐릭터 정보 로딩 |
+| **엔티티 관리** | **플레이어** 및 **몬스터** 객체의 생명주기 및 상태 관리 |
+| **월드 시스템** | 게임 내 **맵** 데이터 관리 및 구역별 엔티티 동기화 |
+| **상호작용 시스템** | **NPC** 대화, **퀘스트** 수락/완료 로직 및 보상 처리 |
+| **아이템 시스템** | **인벤토리** 관리, 아이템 획득 및 사용 로직 처리 |
+| **리소스 로드 시스템** | **JSON 기반 리소스 관리 클래스**를 통해 코드 수정없이 콘텐츠 확장 가능 |
+
+### 📂 프로젝트 구조
+```text
+Root/
+├── GameLogicThread.cs
+├── Program.cs
+├── Protocol.cs
+├── protocol.proto
+├── Common/
+│   └── Packet.cs
+├── DataManage/
+│   ├── DataManager.cs
+│   ├── ItemData.cs
+│   ├── MapData.cs
+│   ├── MonsterData.cs
+│   ├── NpcData.cs
+│   ├── QuestData.cs
+│   └── DataManage/Template/
+│       ├── ItemTemplate.cs
+│       ├── MapTemplate.cs
+│       ├── MonsterTemplate.cs
+│       ├── NpcTemplate.cs
+│       └── QuestTemplate.cs
+├── DB/
+│   ├── DbManager.cs
+│   ├── DbJob.cs
+│   ├── DbTransactionWorker.cs
+│   └── Dto/
+│       └── RequestDto.cs
+├── Game/
+│   ├── Game/Dialogue/
+│   │   ├── DialogueBase.cs
+│   │   ├── DialogueSimple.cs
+│   │   ├── DialogueOk.cs
+│   │   ├── DialogueNext.cs
+│   │   ├── DialogueAcceptDecline.cs
+│   │   └── DialogueSelection.cs
+│   └── Game/Quest/
+│       ├── QuestComponent.cs
+│       ├── QuestCondition.cs
+│       └── QuestProgress.cs
+├── GameData/
+│   ├── Item/ (Item01.json ~ Item04.json)
+│   ├── Map/ (Map01.json)
+│   └── Monster/ (monster01.json ~ monster03.json)
+├── GameObject/
+│   ├── Player.cs
+│   ├── Monster.cs
+│   ├── Map.cs
+│   └── Inventory.cs
+├── Manager/
+│   ├── PlayerManager.cs
+│   ├── MapManager.cs
+│   ├── SessionManager.cs
+│   ├── LoginManager.cs
+│   ├── NpcManager.cs
+│   └── ItemManager.cs
+└── Network/
+    ├── UserSession.cs
+    ├── PacketHandler.cs
+    ├── PacketMaker.cs
+    ├── PacketSerializer.cs
+    ├── RecvBuffer.cs
+    └── PacketParser.cs
+```
+
+## 4. 설계 상세 및 문서
+- **[C# GameServer 문서](./CsharpGameServer-Doc/README.md)**
+
+## 5. 구동 이미지
+![ServerScreen](./image01.PNG)
+
+## 🔗 관련 링크
+- [실버바인 서버 엔진 2 설계 리뷰 (NDC2018)](http://ndcreplay.nexon.com/NDC2018/sessions/NDC2018_0075.html)
+- [C# GameServer 클라이언트](https://github.com/devhwan0421/MiniRPG)