Project Structure (Legacy, Korean) - refracta/NetHack-Webtiles GitHub Wiki

NetHack Webtiles

본 프로젝트의 이상적 목표는 "DCSS Webtiles보다 더 나은 NetHack Webtiles를 만드는 것"입니다. 해당 목표를 달성하기 위한 단계별 목표는 아래와 같습니다.

• 회원 가입 및 로그인 구현
• 기초적인 수준의 웹 플레이 구현
• 관전 기능 구현
• 게임별 채팅 / 공용 채팅 구현
• 개인 RC 파일 수정 구현
• ttyrec / dumplog / rcfiles 웹 다운로드 지원
• 모든 인터페이스를 웹에서 지원
• 인터페이스 완성도 향상
• 모바일 플레이 완벽 지원
• 메일 데몬 지원
• dgamelaunch를 통한 SSH/TELNET 플레이 지원
• 슬래시엠 / 언넷핵 지원
• NAO 부가 기능 통합 (랭킹, 통계)

프로젝트 전체 구조 (알파 버전 기준)

Web Structure (Korean)

본 프로젝트의 웹은 최종 사용자의 뷰 역활을 하는 부분으로, WebSocket 통신을 통해 Webtiles Server에서 게임 데이터(캐릭터 스텟, 타일 정보, 기타 인게임 정보)를 받아 화면에 표시하고 사용자의 입력은 Webtiles Server 전송하여 Remote NetHack Play가 가능하게 해줍니다.

SiteUI, GameUI를 핸들링 하는 부분이 나뉘어져 있으며 HTML5 Canvas & WebGL Framework인 Phaser를 사용하여 타일 부분을 렌더링하고 있습니다.

Webtiles Port Structure (Korean)

넷핵은 다양한 환경의 포팅을 지원하기 위해서 넷핵 게임의 공통된 부분(넷핵 코어) 부분과 포팅용 코드 부분이 나뉘어져 있습니다.

본 프로젝트는 게임 플레이 녹화를 위해 ttyrec를 사용하고 dgamelaunch를 통한 원격 쉘 플레이 지원을 구현하기 위해 NetHack의 tty 포팅 코드에 웹 플레이용 확장 코드(Unix Domain Socket을 이용한 Webtiles Server와의 통신, 게임 데이터 추출 전송, 키 입력 핸들링)을 삽입하여 넷핵 코어의 수정 없이 win/webtiles 에 해당되는 웹 타일용 넷핵 포팅을 만들고 있습니다.

NetHack Webtiles Port는 JSON 포맷으로(json-c 사용) Webtiles Server와 UDP UDS(Unix Domain Socket)으로 데이터 교환을 하고 이를 통해 게임 데이터를 사용자에게 전송하고(Webtiles Port → Webtiles Server → User) 사용자가 입력한 키 입력은 게임에 적용해주는 역할을 합니다.

Webtiles Server Structure (Korean)

Webtiles Server는 일종의 중계 서버로 사용자의 요청을 받아 게임을 시작하면 넷핵을 실행하고 실행된 넷핵 인스턴스와 UDS 통신을 수립합니다. UDS 통신에서 게임 데이터는 최종적으로 사용자에게 WebSocket으로 전달되게 되고, WebSocket으로 받은 사용자의 키 입력 요청은 다시 UDS 통신을 통해 넷핵 인스턴스에 전달합니다. Node.js 기반으로 HTTP, UDS, WebSocket 세 서버의 결합체입니다.

DCSS Webtiles의 Tornado 웹 서버 부분과 유사합니다

Project Folder Structure (Korean)

. - 프로젝트 루트 폴더, Webtiles Server 소스, 프로젝트 폴더 포함

archive - dumplogs, ttyrec, rcfiles가 저장되는 폴더, nginx 디렉토리 리스팅으로 제공됨

dev - 프로젝트 빌드 및 유틸 쉘 스크립트

games - 게임을 컴파일한 빌드 파일과 세이브가 저장되는 폴더

sources - NetHack이 clone되는 폴더

web - 웹 관련

webtiles - sources에 clone된 NetHack에 덮어씌울 Webtiles Port 코드가 들어가는 폴더