아이펀 엔진 레퍼런스 메뉴얼

Release: 1.0.0-b6053

• 엔진 코어 버전별 변경 이력 (stable | experimental)

• Biller 버전별 변경 이력 (stable | experimental)

• Leaderboard 버전별 변경 이력 (stable | experimental)

---

Table of Contents

1. 아이펀 엔진 설치/삭제하기

• 회원 가입 및 사용 신청
  • 회원가입
  • 프로젝트 생성
  • 라이선스
  • 라이선스 관련 문제 해결
  • 크레딧 구매
• 우분투 리눅스에 설치하기
  • APT 저장소 설정하기
  • Mono 프로젝트 저장소 설정하기
  • 배포판 타입 선택하기
  • 아이펀 엔진 패키지 설치하기
  • 데비안 패키지 파일을 사용해서 설치하기
• CentOS 리눅스에 설치하기
  • YUM 저장소 설정하기
  • Mono 라이브러리 설치하기(필수)
  • 배포판 타입 선택하기
  • 아이펀 엔진 패키지 설치하기
  • RPM 패키지 파일을 사용해서 설치하기
• 윈도우에 설치하기
  • 준비하기
• 삭제하기
  • 우분투 리눅스
  • CentOS 리눅스
  • Windows
• 외부 어플리케이션 설치하기
  • MySQL 설치하기
  • Redis Server 설치하기
  • Zookeeper 설치하기
  • MongoDB 설치하기

2. 개발환경 만들기

• 아이펀 엔진이 지원하는 개발 환경
  • C++ 개발 환경
  • C# 개발 환경
• 리눅스 쉘 (C++, C#)
  • 새 프로젝트 만들기
  • Source 디렉터리 구조
  • 빌드 디렉토리 만들기
  • 빌드하기
• 리눅스 GUI & CLion (C++)
  • 새 프로젝트 만들기
  • CLion 솔루션 파일 만들기
  • CLion 에서 디버깅하기 위한 설정
  • CLion 에서 디버깅하기
  • CLion 에서 게임 패키징하기
• 리눅스 GUI & Monodevelop (C#)
  • Monodevelop 설치하기
  • 새 프로젝트 생성
  • Monodevelop 로 프로젝트 열기
  • Monodevelop 로 빌드하기
  • Monodevelop 로 디버깅하기
• 윈도우 GUI & Visual Studio (C++)
  • 새 프로젝트 생성
  • 프로젝트 설정
  • 프로젝트 빌드하기
  • 프로젝트 디버깅하기
  • 프로젝트 배포하기
• 리모트 리눅스 & Visual Studio Code (C++, C#)
  • 시작하기
  • 리모트 호스트에 연결하기
  • 새 프로젝트 만들기
  • VS Code 에서 프로젝트 열기
  • 파일 추가하기
  • 빌드하기
  • 디버깅하기
  • IntelliSense 기능 사용
• 리모트 리눅스 & Visual Studio 2019 (C++)
  • Visual Studio 에 원격 Linux 개발 기능 추가하기
  • 빌드 및 실행을 하게 될 원격 호스트 설정
  • Visual Studio 확장 프로그램 설치하기
  • Visual Studio 에서 프로젝트 생성하기
  • 소스 빌드하기
  • 디버거 실행하기
  • 인텔리센스 동작하게 하기
  • Flavor 추가하기
  • 서버 패키징 하기
• [지원 종료] 리모트 리눅스 & Visual Studio 2015 (C++, C#)
  • 확장 프로그램 설치하기
  • Visual Studio 프로젝트 만들기
  • 새로운 파일을 추가하기
  • 파일 동기화
  • 프로젝트 빌드하기
  • 프로젝트 디버깅하기
  • 인텔리센스 설정하기
  • Flavor 바꾸기
  • 연결 대상 프로젝트 변경하기

3. 엔진 콤포넌트 및 설정

• 콤포넌트 구조와 설정 방법
  • 콤포넌트에 대해서
  • MANIFEST 파일이란?
  • MANIFEST.json 내용 암호화
  • MANIFEST.json 오버라이드하기
• 아이펀 엔진 초기화
• 설정 파일 (MANIFEST.json) 상세
  • 성능 최적화
  • 서버 관리 기능
  • 서버 측 임시 저장소
  • 인증과 빌링
  • 게임 내 소셜 기능
  • 분산 처리 및 서버 확장
  • 클라이언트 지원
  • 게임 콘텐츠 구현
  • 기타

4. 네트워킹

• 아이펀 엔진의 세션
  • 세션 핸들러 등록
  • 세션으로부터 패킷 수신하기(수신)
    • JSON 메시지 핸들러
    • Protobuf 메시지 핸들러
  • 세션으로 메시지 보내기(송신)
    • JSON 메시지 전송
    • Protobuf 메시지 전송
    • 서버에 연결된 모든 세션에게 메시지 보내기
  • 세션 이벤트 타임아웃
  • 세션 종료
  • 세션 데이터
    • 세션 태그
    • 세션 콘텍스트
  • 세션 Ping(RTT)
    • 설정하기
    • 동작
    • 값 얻기
    • 예제
  • 세션 메시지 핸들러 후킹
  • 세션 메시지 전송 후킹
  • 세션의 메시지 전송 안정성
  • 세션 편의 기능
    • 세션 검색
    • 세션 주소
    • 마지막 송수신 메시지 타입
    • 마지막 메시지 수신 시간
    • 세션 별 타임아웃 변경
• 메시지 다루기
  • 메시지 포맷
    • JSON 메시지
      • JSON 메시지 생성 및 읽기
      • JSON 파싱 에러 확인
      • JSON 메시지 스키마 자동 검증
        • 코드 상에서 스키마 지정하기
        • 별도의 스키마 파일 사용하기
    • Protobuf 메시지
      • 메시지 정의
      • 메시지 생성
      • 메시지 읽기
  • 네트워크 보안
    • 메시지 암호화
    • 메시지 리플레이 공격 차단
    • SSL/TLS 설정
  • 메시지 압축
    • 설정하기
    • 압축 알고리즘
    • 공유 사전 사용하기
  • 긴급 메시지
  • 서버의 IP 주소 알아내기
  • HTTP 클라이언트
  • 네트워킹 기능 설정 파라미터
  • 멀티 프로토콜
    • 전송 프로토콜 명시적 선택
    • 전송 프로토콜 자동 선택
  • HTTP 교차 출처 자원 공유 (CORS)
  • (고급) 아이펀 엔진의 네트워크 스택
    • Transport 계층
    • Message 계층
    • Session/Application 계층
      • Session/Application 계층 - JSON 메시지 포맷
      • Session/Application 계층 - Google Protocol Buffers 메시지 포맷
      • HTTP
  • (고급) 아이펀 엔진 세션 상세

5. 메인 이벤트 루프

• 아이펀 엔진의 이벤트
  • 이벤트란?
  • 이벤트 종류
  • 이벤트 실행순서와 이벤트 태그
  • 이벤트 프로파일링 및 디버깅
  • 이벤트 기능 설정 파라미터

6. 데이터베이스 자동접근

• 아이펀 엔진의 오브젝트에 대해서
• 오브젝트 정의하기
  • 오브젝트(Object) 정의
  • 속성(Attribute) 정의
    • 기본(Primitive) 타입
    • 오브젝트 타입
    • 배열 (Array)
    • 맵 (Map)
  • 속성 플래그(Flag) 지정
    • 키(Key)
    • 복합키(Composite Key)
    • 참조 (Foreign)
  • 모델 정의 예제
• 인터페이스 클래스
  • 인터페이스 클래스의 메소드들
    • DB 에 오브젝트 생성
    • DB 에서 오브젝트 읽기
      • 오브젝트 ID 로 한 오브젝트 읽기
      • 오브젝트 ID 로 여러 오브젝트 읽기
      • Key 속성을 이용해 한 오브젝트 읽기
      • Key 속성을 이용해 여러 오브젝트 읽기
      • Fetch 시 오브젝트 cache
      • Fetch 시 LockType
    • DB 에서 오브젝트 삭제
    • NULL 체크
    • 오브젝트 ID 반환
    • 오브젝트 속성 읽기/쓰기
      • Foreign 으로 정의되지 않은 배열이나 Map
      • Foreign 으로 정의된 배열이나 Map
    • 저장한 오브젝트 refresh
    • JSON 으로 오브젝트 초기화
  • 배열 & 맵
    • 배열: ArrayRef<Type>
      • 사이즈 반환
      • 특정 위치에 원소가 있는지 확인
      • 특정 위치 원소 읽기
      • 특정 위치에 원소 쓰기
      • 특정 위치에 원소 추가
      • 특정 위치의 원소 삭제
      • 배열 전체 비우기
      • (편의기능) 배열의 첫 원소 반환
      • (편의기능) 배열의 마지막 원소 반환
      • (편의기능) 배열 맨 앞에 원소 추가
      • (편의기능) 배열 맨 뒤에 원소 추가
      • (편의기능) 조건과 일치하는 원소 개수 반환
      • (편의기능) 조건과 일치하는 원소 목록 반환
      • (편의기능) 배열에서 첫번째 비어있는 슬롯 검색
    • Map: MapRef<KeyType, ValueType>
      • 특정 키의 원소 유무 확인
      • 특정 키의 원소 읽기
      • 특정 키의 원소 삽입
      • 특정 키의 원소 삭제
      • Map 전체 비우기
      • 모든 Key 값 반환하기
      • 사이즈 반환
      • (편의기능) 정수 Map 에서 첫번째 비어있는 슬롯 검색
  • 인터페이스 클래스 사용 예제
    • 인벤토리 초기화
    • 인벤토리에 아이템 지급
    • 인벤토리에서 아이템 삭제
    • 빈 인벤토리 슬롯에 아이템 지급
    • 아이템 장착 슬롯 만들기
    • 아이템 장착
    • 비어있는 퀵 슬롯에 아이템 장착
    • 캐릭터 생성
    • 캐릭터 경험치 및 레벨 증가
• DB 처리 고급 기능
  • 트랜잭션
    • 트랜잭션 롤백
      • 예제: 롤백 가능한 함수 뒤로 코드 옮기기
      • 예제: 롤백을 피해 이벤트 쪼개기
    • 원하지 않는 롤백 감지
      • 예제: AssertNoRollback() 을 이용한 능동적 롤백 감지
      • 예제: AssertNoRollback() 을 포함하는 아이펀 엔진 함수들
  • DB 서버 관리
    • DB 캐싱
    • DB 서버 Sharding
      • Sharding 시 DB 에 생성되는 table/procedure
        • object_databases 에 생성되는 table/procedure
        • key_database 에 생성되는 table/procedure
      • Sharding 시 데이터 마이그레이션
    • 필요한 DB 권한
      • 최소 권한
      • DB 스키마 자동 관리시 추가 권한
      • DB 스키마 자동 관리를 사용하지 않을 때 필요한 schema script 추출
    • DB 서버 Failover 구현
    • 게임 서버 외부에서 DB 접근시 유의 사항
      • 서버가 구동중이지 않은 경우
      • 서버 구동 중 데이터를 조회하는 경우
      • 서버 구동 중 데이터를 추가/변경/삭제하는 경우
  • ORM 성능 개선
    • 오브젝트 접근 가이드라인
    • 빈번하게 사용되는 Object 처리
    • 여러 오브젝트 한번에 Fetch 하기
    • Foreign 을 이용한 오브젝트 fetch 최소화
      • 예제: 친구 목록 구현
      • 예제: 친구 목록에서 불필요하게 인벤토리 읽는 것 피하기
    • 올바른 락 타입 사용
    • DB index 추가
  • (고급) DB에서 오브젝트 검색
    • 예제: 레벨 100 이상의 유저 검색
  • (고급) ORM 에 의한 DB 스키마
    • ORM 에 의한 DB 스키마 자동 변경
    • String 길이 축소
    • ORM 의 타입이 SQL 타입으로 변환되는 규칙
    • ORM 의 table naming 규칙
      • tb_Object_{{ObjectName}}
      • tb_Key_{{ObjectName}}_{{KeyAttributeName}}
      • tb_Object_{{ObjectName}}_ArrayAttr_{{AttributeName}}
      • tb_Object_{{ObjectName}}_MapAttr_{{AttributeName}}
    • ORM 이 생성하는 DB Index 와 Constraint
    • ORM 이 생성하는 DB Procedure
  • (고급) ORM 프로파일링
  • ORM 기능 설정 파라미터
  • MySQL(MariaDB) 서버 설정 및 관리
    • 기본 설정 가이드
    • (고급)성능 개선 가이드

7. 시간과 타이머

• 시간과 타이머
  • Monotonic clock
    • Monotonic clock 활용법
  • Wall clock
    • Wall clock 활용법
    • Timestamp 로의 전환
    • 시간의 문자열 표현
  • 타이머
    • 타이머 활용법

8. 분산 서비스

• ORM, RPC, 로그인
  • 분산 환경에서 ORM 동작
  • 분산 서버 관리
    • 태그로 분산 서버 구분
    • 서버 리스트 추출
      • Rpc::GetPeers(): 모든 서버 리스트 추출
      • Rpc::GetPeersWithTag(): 특정 태그의 서버 리스트 추출
    • 다른 서버의 공인 IP
    • 서버 간 상태/정보 공유
  • 분산 환경에서 클라이언트 관리
    • 클라이언트와 아이펀 세션 연동 / 해제 (로그인 / 로그아웃)
    • 클라이언트가 접속한 서버 찾기
      • Account ID 로 찾기
    • 다른 서버의 클라이언트에게 패킷 보내기
    • 모든 클라이언트에게 패킷 보내기
      • 로그인 여부 상관없이 서버의 모든 세션에 패킷 보내기
      • 서버의 로그인한 모든 클라이언트에 패킷 보내기
    • 클라이언트를 다른 서버로 옮기기
      • MANIFEST.json 설정
      • 클라이언트를 다른 서버로 이동하기
      • 이동 메시지 처리 과정
      • 새 서버에서 옮겨온 클라이언트에 대한 처리
  • Zookeeper 설정 및 관리
    • Zookeeper 설치하기
    • Command-line 툴 사용하기
    • 아이펀 엔진이 만드는 Zookeeper 디렉토리
    • Zookeeper 처리 프로파일링
    • Zookeeper 상태 확인하기
    • Zookeeper 설정 가이드라인
      • 권장 노드 수
      • 권장 기계 사양
      • 각 노드 별 권장 디스크 구성
      • JVM 설정
      • 권장 Zookeeper 옵션
        • globalOutstandingLimit
        • forceSync
        • -Xmx{heap-size}m
        • autopurge.snapRetainCount
        • autopurge.purgeInterval
  • (고급) RPC 를 이용한 서버간 통신
    • RPC 메시지 정의하기
    • 메시지 핸들러 작성하기
      • 명시적인 응답을 보내지 않는 message 에 대한 handler
      • 명시적으로 응답을 보내야 되는 message 에 대한 handler
    • 메시지 핸들러 등록하기
      • 응답이 없는 handler 의 경우
      • 응답이 있는 handler 의 경우
    • 메시지 받을 서버 ID 알아내기
    • 메시지 전송하기
      • 응답을 받지 않는 메시지의 경우
      • 응답을 받는 메시지의 경우
  • 분산처리 기능관련한 설정들
• 서버간 데이터공유
  • 예제 - 서버 이동시 클라이언트 인증 정보 공유하기
    • 프로젝트 준비
      • Flavor 를 통해 게임, 대전 서버 등록
      • MANIFEST.json 수정
      • Flavor 별 처리 준비
    • Game flavor 에 로그인 메시지 핸들러 등록
    • Game flavor 에 PvP 모드 진입 메시지 핸들러 등록
    • PvP flavor 에 PvP 참여 메시지 핸들러 등록
  • CrossServerStorage 기능의 설정 파라미터

9. 데이터베이스 수동접근

• MySQL 요청
  • Mariadb 객체 생성
  • Mariadb 객체 초기화
  • 쿼리 실행
  • 결과 처리
  • MySQL connector 사용 예제
    • DB 스킴 생성
    • SELECT 예제
    • INSERT 예제
    • 바이너리 타입 INSERT 예제
    • Procedure 예제
    • Procedure 의 OUTPUT 얻기
• Redis 요청
  • 연결 초기화
    • 설정값 지정
    • Connection Pool 초기화
  • 명령 실행
    • 지원하는 명령
    • 직접 명령 처리하기
    • 비동기 명령 실행 순서와 태그
  • 사용 예제
    • 예제 - 유저 데이터 저장
    • 예제 - ExecuteCommand()
  • 레디스(Redis) 서버 관리
    • 태그(Tag) 로 레디스 서버 구분
      • 예제 - 태그를 이용한 레디스 서버 구분
    • Redis 레플리케이션
      • 연결 초기화
        • Sentinel 설정값 지정
        • Master 변경 통지 받기
    • Redis 클러스터링

10. 외부 서비스 지원

• 플랫폼 인증 검증
  • Apple Game Center
    • 클라이언트 인증 유효성 검사하기
  • Facebook
    • 클라이언트 인증 유효성 검사하기
    • 사용자 정보 요청하기
  • Google Play Game
    • 클라이언트 인증 유효성 검사하기
  • Google Plus (Deprecated)
  • LINE
    • 클라이언트 인증 유효성 검사하기
    • 사용자 정보 요청하기
  • Nexon Launcher
    • 클라이언트 인증 유효성 검사하기
  • Nexon Toy
    • 클라이언트 인증 유효성 검사하기
  • Kakao Game
  • Apple로 로그인
    • 클라이언트 인증 유효성 검사하기
  • 인증 검증 서비스 설정 파라미터
• 플랫폼 결제 검증
  • iFun Biller
    • 지원 플랫폼
    • 설치 방법
      • Ubuntu 인 경우
      • CentOS 인 경우
    • 실행 방법
      • Ubuntu 16.04 이상 혹은 CentOS 7 이상인 경우
    • 동작 확인
      • Ubuntu 16.04 이상 혹은 CentOS 7 이상인 경우
      • Log 파일
    • iFun Biller 설정 방법 (MANIFEST.json)
  • 결제 검증
    • 아이펀 엔진에서 함수 호출하는 방식
      • 구글 플레이 결제 검증
        • 동기화 방식
        • 비동기 방식
      • 애플 앱스토어 결제 검증
        • 동기화 방식
        • 비동기 방식
      • OneStore(TStore) 결제 검증
        • 동기화 방식
        • 비동기 방식
    • REST API 를 이용하는 방식
      • 플랫폼 연결 초기화
      • Google Play 영수증 검증
      • Apple AppStore 영수증 검증
      • OneStore(TStore) 영수증 검증
      • OneStore(SDK17, API5) 영수증 검증
      • 예제: Apple AppStore 결제 검증
  • 실제 구매 내역이 없는 영수증 처리
  • 트랜잭션 아이디 가져오기
    • 동기화 방식
    • 비동기 방식
  • 게임 서버 측 결제 검증 설정 파라미터
• HTTP 요청
  • 아이펀 엔진의 HTTP Client 기능
    • HTTP Client
      • 헤더 설정
      • 예제: GET 메소드
        • 동기 방식
        • 비동기 방식
      • 예제: POST 메소드
        • 동기방식
        • 비동기방식
      • 예제: PUT 메소드
        • 동기방식
        • 비동기방식
      • 예제: DELETE 메소드
        • 동기방식
        • 비동기방식
    • HTTP Client Pool
      • MANIFEST 설정
      • HTTP 호스트 별 클라이언트 개수 확인
      • 헤더 설정
      • 예제: GET 메소드
        • 동기 방식
        • 비동기 방식
      • 예제: POST 메소드
        • 동기방식
        • 비동기방식
      • 예제: PUT 메소드
        • 동기방식
        • 비동기방식
      • 예제: DELETE 메소드
        • 동기방식
        • 비동기방식

11. 콘텐츠 지원

• 리더보드(랭킹)
  • iFun Leaderboard
    • 설치 방법
      • Ubuntu 인 경우
      • CentOS 인 경우
    • 실행 방법
      • Ubuntu 16.04 이상 혹은 CentOS 7 이상인 경우
    • 동작 확인
      • Ubuntu 16.04 이상 혹은 CentOS 7 이상인 경우
      • Log 파일
    • iFun Leaderboard 설정 방법 (MANIFEST.json)
    • 랭킹 리셋 스케쥴 설정
      • 리셋 스케쥴 등록하기
      • 리셋 스케쥴 수정하기
    • (고급) 랭킹 데이터 직접 삭제/복구
      • iFun Leaderboard 가 MySQL 에 저장하는 데이터
      • iFun Leaderboard 가 Redis 에 저장하는 데이터
      • 랭킹 데이터 삭제하기
        • MySQL 에서 랭킹 데이터 삭제하기
        • Redis 에서 랭킹 데이터 삭제하기
      • MySQL 에서 Redis 로 랭킹 데이터 복구하기
  • 예제: 랭킹 조회하기
    • 주간 전체 랭킹 조회하기
      • 동기 방식
      • 비동기 방식
    • 주간 TOP 10 랭킹 조회하기
      • 동기 방식
      • 비동기 방식
    • 자기 순위 주변 랭킹 조회하기
      • 동기 방식
      • 비동기 방식
    • 자기 랭킹 조회하기
      • 동기 방식
      • 비동기 방식
    • 친구간 랭킹 조회하기
      • 동기 방식
      • 비동기 버전
    • 한번에 여러 기준의 랭킹 조회하기
      • 동기 방식
      • 비동기 방식
  • 예제: 점수 갱신하기
    • 최고 점수인 경우 갱신하기
      • 동기 방식
      • 비동기 방식
    • 점수 갱신 후 내 랭킹 가져오기
      • 동기 방식
      • 비동기 방식
  • 예제: 랭킹 삭제하기
    • 동기 방식
    • 비동기 방식
  • 예제: 랭킹 리셋 스케쥴 알아내기
  • 예제: 랭킹 리셋 여부 확인하기
    • 동기 방식
    • 비동기 방식
  • 예제: 다수의 iFun Leaderboard 를 이용해 Leaderboard 요청 분산시키기
  • 게임 서버 측 Leaderboard 설정 파라미터
• 매치메이킹
  • MatchmakingServer 콤포넌트
    • MANIFEST 설정하기
    • 인터페이스
      • Start()
      • 콜백 핸들러
      • 클래스 정의
      • 서버 구현 예제
  • MatchmakingClient 콤포넌트
    • MANIFEST 설정하기
    • MatchmakingClient 인터페이스
      • 매칭 요청
      • 매칭 요청 취소
      • 콜백 함수로 매칭 상태 확인하기
      • 매치 데이터와 유저 데이터 활용
      • 매칭 상태 변경
      • 클래스 정의
      • 클라이언트 구현 예제
  • 매치메이킹 예제
    • 예제 1: 레벨 차이를 고려한 2:2 매칭
      • MatchmakingClient 코드
      • MatchmakingServer 코드
    • 예제 2: 매칭이 안됐을 때 조건을 바꿔 다시 매칭하기
      • MatchmakingClient 코드
      • MatchmakingServer 코드
    • 예제 3: Group vs. Group
      • MatchmakingClient 코드
      • MatchmakingServer 코드
• 멀티캐스팅, 채팅 지원
  • 멀티캐스팅 이용을 위한 설정
    • MANIFEST 설정
    • 서버 코드
    • 클라이언트 코드
  • 서버에서 멀티캐스팅 다루기
    • 멀티캐스팅 채널 생성하기
    • 멀티캐스팅 채널의 토큰 가져오기
    • 없는 채널의 입장 방지
    • 전체 채널 목록 가져오기
    • 멀티캐스팅 메시지 전송 후킹
      • 메시지 확인하기
        • 예제 - 메시지 변경하기
        • 예제 - 메시지 전송 실패 처리하기
      • 메시지 전달받기
        • 예제: 채널 내 메시지를 로그로 남기기
• 기획 데이터 관리하기
  • 기획 데이터 읽어들이기
    • 기획 데이터가 JSON 파일로 된 경우
    • 기획 데이터가 탭구분자 파일로 된 경우
      • 파일 조건
        • 인코딩 및 확장자
        • 코멘트
        • 헤더
        • 데이터
      • JSON 데이터로의 변환
        • 예제: 탭 구분자 파일의 JSON 변환
      • 연속되는 탭 구분자에 대한 처리
    • 기획 데이터가 콤마 구분자 파일 (CSV 파일)로 된 경우
    • 기획 데이터가 DB 테이블 형태로 존재할 때
      • MANIFEST.json 설정
      • JSON 데이터로의 변환
        • 예제: DB 에 있는 기획 데이터의 JSON 변환
      • 지원하는 데이터 타입 목록
  • 기획 데이터 사용하기
  • 기획 데이터 인덱싱하기
  • 기획 데이터 관리 설정 파라미터
• 3D 공간 기능 지원
  • 월드 생성
    • 방법1 - API 함수
    • 방법2 - MANIFEST 설정
    • Zone
      • Zone 생성
      • Zone 핸들러
  • 월드 찾기
    • 같은 서버 내
    • 다른 서버
  • 월드 삭제
  • 월드 오브젝트 생성
    • 생성
    • 이름 붙이기
    • 세션 붙이기
    • Type 지정
    • 데이터 저장
  • 월드 오브젝트 입장
  • 월드 오브젝트 퇴장
  • 월드 오브젝트 이동
  • 월드 오브젝트 검색
    • 오브젝트 ID 로 찾기
    • 가까운 오브젝트들 찾기
      • 위치 기준으로 찾기
      • 오브젝트 기준으로 찾기
      • 가까운 순으로 정렬하기
      • 가까운 순으로 N 번째 오브젝트 찾기
      • 새롭게 시야에 들어온 오브젝트 찾기
      • 특정 Type 의 오브젝트 찾기
      • 사각형에 포함된 오브젝트 찾기
      • 부채꼴에 포함된 오브젝트 찾기
      • 사용자 정의 필터
    • 가까운 플레이어들에게 메시지 보내기
      • 가까운 플레이어들의 세션 찾기
      • 가까운 플레이어들에게 메시지 보내기
  • 정적 월드 오브젝트
    • 등록
    • 검색
  • 월드 기타 기능
    • 오브젝트 존재 유무 검사
    • 모든 오브젝트 가져오기
    • 모든 세션에게 메시지 보내기
• 텍스트 필터
  • 텍스트 필터 사용을 위한 설정 (MANIFEST.json)
  • 텍스트 필터 사용하기
    • 텍스트 필터 생성하기
    • 텍스트 필터 가져오기
    • 텍스트 필터 타입 확인하기
    • 텍스트가 존재하는지 확인하기
    • 텍스트 치환하기
  • 예제

12. 게임 운영

• 공지기능
  • iFun Announcer 설치
    • 준비하기
      • MySQL
      • Docker 이미지 생성
      • 홈디렉터리 생성
      • 서버 인증서 설정
    • 초기화
  • iFun Announcer 실행
    • HTTPS 모드
    • HTTP 모드
  • 게시물 관리
  • 게시물 분류(Kind) 추가
  • 클라이언트 코드
• 서버 점검 메시지
  • 서버 점검 메시지 설정
    • (방법1) MANIFEST.json 을 이용한 static 한 방식
      • MANIFEST.json 설정
      • maintenance.json 설정
    • (방법2) 서버 실행 중에 설정하는 dynamic 한 방식
  • 서버 점검 메시지 클라이언트 코드
• 플레이어 행동 로그
  • 개요
  • 행동 로그 형식 정의하기
    • 사용 가능한 인자의 데이터 타입
  • Logger 함수 생성하기
  • 행동 로그 출력 위치
    • 표준 출력 장치로 출력
    • 다른 로깅 서비스로 출력
    • 파일로 출력
    • MongoDB 에 출력
    • MySQL 호환 DB 에 출력
  • 행동 로그 설정 항목
• 클라이언트 리소스 관리
  • 클라이언트 리소스 제공 서비스 설정
    • 방법 1: 별도의 웹서버 없이 게임 서비스가 리소스 요청을 처리할 때
      • 리소스 디렉토리 지정
      • MANIFEST.json 설정
      • .funignore 파일 및 규칙
    • 방법 2: 별도의 웹서버 가 리소스 요청을 처리하게 할 때
      • 리소스 목록 파일 생성
      • 리소스 파일들을 웹 서버에 복사
      • MANIFEST.json 설정
      • .funignore 파일 및 규칙
    • 리소스 정보 갱신하기
  • 예제: 외부 웹 서버 활용의 경우
    • 리소스 리스트 받아오기
    • 각 리소스 파일 받아오기
  • 클라이언트 코드
  • 클라이언트 리소스 정보 제공 서비스 설정 파리미터
• 클라이언트 버전 관리
  • 호환되는 클라이언트 버전 지정
    • 예제
      • MANIFEST.json 설정
      • 서버 측 코드

13. 서버 관리

• 관리용 RESTful API 추가
  • REST API URL 과 핸들러 등록
  • 핸들러 작성
  • API Service 등록 예제
  • ApiService 기능 설정 파라미터
• 엔진 카운터 사용하기
  • 카운터 읽기 & 쓰기
    • 카운터 쓰기
    • 카운터 읽기
    • 카운터 사용 예제
    • 외부에서 REST 형태로 카운터 읽기
  • 카운터 변화 감지하기
    • 카운터 변화 감지 예제
    • 변화 감지 로그 출력 주기
    • 엔진에서 기본적으로 변화를 감지하는 카운터
      • Event
      • ORM
  • 기본 제공되는 카운터 목록
    • process
    • os
    • funapi
    • funapi_object_model
  • (고급) Callback 형 카운터
    • Callback 형 카운터 사용 예제
  • 카운터의 설정 파라미터
• 서버 패키징
  • Flavor: 역할에 따라 서버 구분하기
    • Flavor 란?
    • Flavor 설정
    • Flavor 별 자동 생성 파일들
      • MANIFEST.json
      • Launcher script
      • Daemon script
    • 코드 상에서 현재 flavor 알아내기
  • 실 서비스로 옮기기 위한 게임 서버 패키징
    • 생성 가능한 패키지 타입
    • 생성되는 패키지의 버전 숫자 부여
      • Major 버전 숫자
      • Minor 버전 숫자 (code revision ID)
    • 패키지 생성방법
      • 명령행 상에서 작업할 때
      • CLion 로 작업할 때
      • Visual Studio 로 작업할 때
    • 패키지 내용 확인하기
      • TGZ
      • DEB
      • RPM
    • 패키지에 아이펀 엔진 라이선스 파일 포함하기
    • 패키지에 게임 리소스 파일들 포함하기
      • 리소스 디렉토리 지정
      • 코드 상에서 리소스 파일 접근
  • 실 서비스로 배포하기
• 서버 배포
  • 서비스 설정하기
    • Systemd
  • 패키지 생성
  • 패키지 설치/업그레이드
    • Ubuntu 16.04 또는 18.04 또는 20.04
    • Centos 7 또는 Centos 8
  • 서비스 시작/종료하기
    • Systemd
      • 서비스 활성화
      • 서비스 시작
      • 서비스 종료
  • 서비스 인스턴스 여러개 실행하기
    • 준비하기
    • 서비스 유닛 파일 수정
    • 서버 런처 파일 수정
    • 설정 오버라이드 하기
    • 서비스 실행하기
  • 서비스 실행 로그 보기
    • Systemd
  • 패키지 버전 고정하기
    • Ubuntu 환경에서 버전 고정하기
    • CentOS 환경에서 버전 고정하기
  • 비표준 위치에 게임 서버 설치하기
    • 비표준 위치에 게임 서버 패키지 설치하기
    • 비표준 위치에 게임 서버 패키지 설치하고 서비스로 띄우기
      • 서비스 설정 파일에 지정 가능한 환경 변수
      • systemd 를 사용하는 경우 수작업으로 서비스 등록하기
• 실행 중 설정 변경
  • Run-time 에 설정 가능한 플래그들
    • 아이펀 엔진 플래그
    • 서버프로그래머가 추가한 플래그
  • Run-time 설정 변경 기능 활성화 하기
  • Run-time 설정 변경을 위한 RESTful APIs
    • 설정 가능한 모든 flag 조회하기
    • 특정 flag 값 조회하기
    • 특정 flag 값 변경하기
    • 클라이언트 버전 통제하기
      • 호환 가능 클라이언트 버전 정보 조회하기
      • 호환 가능 클라이언트 버전 정보 변경하기
  • Run-time 설정 가능 플래그 사용시 주의점

14. 클라이언트 플러그인

• 들어가기 전에
  • 개요
  • 세션(Session)
    • 세션 아이디
    • 세션과 관련한 서버 쪽 설정
  • 트랜스포트 (Transport)
• Unity3d
  • 유니티 3D 지원 버전에 대해서
  • 시작하기
    • Protocol Buffers 메시지 용 DLL 빌드하기
      • Protobuf 용 .dll 빌드하게 설정하기
      • 생성한 .dll 파일 복사하기
  • 서버에 연결하기
    • FunapiSession 클래스
      • Session Option
      • FunapiSession 객체 생성
      • Transport 연결
      • 프로토콜과 인코딩 타입
    • 이벤트 콜백 함수
      • Session Event
      • Transport Event
      • Transport Error
    • Transport 옵션
      • Base 클래스, UDP 옵션
      • TCP 옵션
      • HTTP 옵션
      • Websocket 옵션
  • 메시지 전송 및 수신
    • 메시지 전송
      • JSON 메시지 보내기
      • Protocol Buffers 메시지 보내기
      • Delayed ack, Piggy back 기능
      • Dropped 메시지
    • 메시지 수신
    • Response Timeout
    • JSON Helper 클래스
  • 메시지 암호화
    • 암호화 타입
    • 암호화 사용
  • 메시지 압축
    • 압축 옵션
      • 압축 최소 크기 지정
      • Zstd 압축 사전 지정
  • 연결 종료 및 재연결
    • 연결 종료
    • 연결 종료 알림
      • Transport Event
      • Session Event
    • 재연결
    • AutoReconnect 옵션
  • Ping 사용하기
    • Ping 설정
  • 서버간 이동
    • 서버간 이동 상태 확인
    • 서버 이동 후 사용할 Transport 의 옵션
    • 서버 이동 중 보내는 메시지의 전송 보장
  • 멀티캐스팅과 채팅
    • 멀티캐스팅 인터페이스
    • 멀티캐스팅 예제
    • 채팅 인터페이스
    • 채팅 예제
  • 공지사항 확인하기
  • 서버 점검 메시지
  • 리소스 파일 다운로드
    • FunapiHttpDownloader 클래스
    • FunapiHttpDownloader 예제
    • 리소스 폴더의 특정 폴더만 다운로드
    • 에셋 번들 다운로드
  • 소셜네트워크 플러그인
    • 인터페이스 클래스
    • 페이스북
    • 트위터
  • C# Runtime Test Code
  • Unity Plugin 로그 보기
  • 로그 저장하기
  • 디버그 로그 파일 만들기
  • 버그 신고
• Unreal 4
  • 지원하는 언리얼 엔진 버전
  • 플러그인 적용하기
  • 서버에 연결하기
    • FunapiSession 클래스
      • 세션 옵션
      • FunapiSession 객체 생성
      • FunapiSession Update
      • Transport 연결
      • 프로토콜과 인코딩 타입
    • 이벤트 콜백 함수
      • Session Event
      • Transport Event
    • Transport 옵션
      • FunapiTcpTransportOption
      • FunapiUDPTransportOption
      • FunapiHttpTransportOption
      • FunapiWebsocketTransportOption
  • 메시지 다루기
    • JSON 메시지 보내기
    • Protocol Buffers 메시지 보내기
    • Delayed ack & Piggy back 기능
    • 메시지 받기
      • JSON 메시지
      • Protocol Buffers 메시지
      • 응답 메시지 시간 제한
    • 메시지 암호화
      • 암호화 타입
      • 암호화 사용
    • 메시지 압축 기능
      • 메시지 압축 예제
  • 연결 종료 및 재연결
    • 연결 종료 알림
    • 세션 닫기 요청
    • 연결 끊기
    • 재연결
    • AutoReconnect 옵션
  • 연결 상태 확인(Ping)
  • 서버 이동
    • 서버 이동 상태 확인
    • 서버 이동 시 세션 및 트랜스포트 옵션 변경
    • 서버 이동 중 보내는 메시지의 전송 보장
  • 멀티캐스팅 기능
    • 멀티캐스트 클래스 인터페이스
    • 멀티캐스팅 예제
      • FunapiMulticast 객체 생성
      • 콜백 함수 추가
      • 채널 입장
      • 메시지 전송
      • 채널 퇴장
  • 공지사항 확인하기
    • 공지사항 Update
  • 서버 점검 메시지
  • 클라이언트 리소스 파일 다운로드
    • FunapiHttpDownloader 클래스
    • FunapiHttpDownloader 예제
      • FunapiHttpDownloader Update
• Cocos2d-x
  • 지원 버전
  • 시작하기
    • 4.x 버전 프로젝트에 코코스 플러그인 적용하기
    • 3.1x 버전 프로젝트에 코코스 플러그인 적용하기
      • Windows 설정
      • iOS 설정
      • macOS 설정
      • Android 설정
  • 플러그인 초기화
  • 서버에 연결하기
    • 세션이란?
    • FunapiSession 클래스
      • Session Option
      • FunapiSession 객체 생성
      • FunapiSession Update
      • Transport 연결
      • 프로토콜과 인코딩 타입
    • 이벤트 콜백 함수
      • Session Event
      • Transport Event
    • Transport 옵션
      • FunapiTcpTransportOption
      • FunapiUDPTransportOption
      • FunapiHttpTransportOption
      • FunapiWebsocketTransportOption
  • 메시지 다루기
    • JSON 메시지 보내기
    • Protocol Buffers 메시지 보내기
    • Delayed ack, Piggy back 기능
    • 메시지 받기
      • JSON 메시지
      • Protocol Buffers 메시지
      • 응답 메시지 시간 제한
    • 메시지 암호화
      • 암호화 타입
      • 암호화 사용
    • 메시지 압축 기능
      • 메시지 압축 예제
  • 연결 종료 및 재연결
    • 연결 종료 알림
    • 세션 닫기 요청
    • 연결 끊기
    • 재연결
    • AutoReconnect 옵션
  • 연결 상태 확인(Ping)
  • 서버 이동
    • 서버 이동 상태 확인
    • 서버 이동 시 세션 및 트랜스포트 옵션 변경
    • 서버 이동 중 보내는 메시지의 전송 보장
  • 멀티캐스팅과 채팅
    • 멀티캐스팅 인터페이스
    • 멀티캐스팅 예제
      • FunapiMulticast 객체 생성
    • 콜백 함수 추가
      • 채널 입장
      • 메세지 전송
      • 채널 퇴장
  • 공지사항 확인하기
    • 공지사항 Update
  • 서버 점검 메시지
  • 리소스 파일 다운로드
    • FunapiHttpDownloader 클래스
    • FunapiHttpDownloader 예제
      • FunapiHttpDownloader Update
• Javascript
  • 시작하기
  • 서버에 연결하기
    • 세션이란?
    • FunapiSession 클래스
      • Session Option
      • FunapiSession 객체 생성
      • 전송 프로토콜 지정 연결
      • 프로토콜과 인코딩 타입
    • 이벤트 콜백 함수
      • Session Event
      • Transport Event
      • Transport Error
    • Transport 옵션
      • HTTP 옵션
      • Websocket 옵션
  • 메시지 전송 및 수신
    • 메시지 전송
      • JSON 메시지 보내기
      • Protocol Buffers 메시지 보내기
    • 메시지 수신
  • 연결 종료 및 재연결
    • 연결 종료
    • 연결 종료 알림
      • Transport Event
      • Session Event
    • 재연결
    • Auto reconnect 옵션
  • Ping 사용하기
    • Ping 설정
  • 서버간 이동
    • 서버간 이동 상태 확인
    • 서버 이동 후 사용할 Transport 의 옵션
    • 서버 이동 중 보내는 메시지의 전송 보장
  • 멀티캐스팅과 채팅
    • 멀티캐스팅 인터페이스
    • 멀티캐스팅 예제
    • 채팅 인터페이스
    • 채팅 예제
  • 공지사항 확인하기
  • 서버 점검 메시지
  • 사용자 정의 Protcol Buffers 메시지 사용하기
    • NPM 설치 확인 및 설치
    • NPM (더미) 프로젝트 생성
    • @ifunfactory/engine-plugin-js 패키지 다운로드
    • proto 파일 적용
    • 사용자 정의 플러그인 빌드
    • 플러그인 JS 파일 교체
  • JavaScript Bundler (Rollup, NPM) 단일 파일로 묶기
    • NPM 패키지 디렉토리 생성
    • 플러그인 패키지 설치 및 의존성 설정
    • Rollup 설정
    • 빌드
    • 적용
    • 사용자 정의 Protocol Buffers 메시지 사용
  • TypeScript 사용하기
    • TypeScript 설치
    • TypeScript 설정 파일 추가
    • NPM build 명령어 추가
    • Rollup 이용해서 단일 파일로 묶기

15. 프로그래밍

• 디버그용 로그
  • Google logging 사용 예제
  • Log 파일 생성 위치
  • 화면에 로그 메시지 출력
  • 로그 기능 설정 파라미터
• 사용자 필요 라이브러리 사용
  • 외부 라이브러리 설치
  • CMakeLists.txt 에 추가
    • 라이브러리 찾기
    • 라이브러리 링크하기
  • 서비스 환경에 배포
• 프로그램 실행 인자
  • 방법1: MANIFEST.json 을 이용
    • MANIFEST.json 에 인자 추가하기
    • 서버 코드에서 인자 읽기
  • 방법2: Google Flag 로 추가
    • Google flag 추가하기
    • 서버 코드에서 flag 읽기
    • 명령행 실행 시 인자 전달하기
    • 서비스로 실행시 인자 전달하기
• 디버깅 및 프로파일링 지원
  • GDB를 사용해서 디버깅 하기
  • 미니덤프(.dmp) 디버깅하기
    • 미니덤프 생성 위치
    • 미니덤프 내용 보기
    • 미니덤프를 GDB 로 디버깅하기
  • 코어덤프(core) 디버깅하기
    • 코어덤프 활성화
    • 코어덤프 저장 경로
    • 코어덤프 내용 보기
  • 메모리 오류 디버깅하기
    • Address Sanitizer 활성화 하기
    • 테스트 하기
  • 메모리 릭 디버깅
    • 준비해야할 것
    • 메모리 릭 따라가기
  • CPU 프로파일링
    • 필요한 프로그램 설치
      • perf 유틸리티
      • FlameGraph
    • 프로파일링 결과 추출
• 테스트 클라이언트 작성
  • 방법1: 아이펀 엔진의 Bot 콤포넌트 이용
    • funtest 의 Network 클래스
    • funtest 의 Session 클래스
    • 예제: 300 개의 Bot 이 각각 5000 번씩 echo 전송
  • 방법2: 유니티 플러그인을 이용
    • Mono C# 라이브러리 이용
    • Visual Studio 이용
      • 프로젝트 설정
      • 빌드 및 실행

16. 데디케이티드 서버 지원

• 클라이언트 데디케이티드 서버
  • 용어 설명
  • 데디케이티드 서버 동작 구조
  • 레디스 서버 및 API 서비스 활성화
  • 데디서버 매니저 콤포넌트 활성화
  • 데디서버 호스트 매니저 설치 및 시작
    • 리눅스 데디서버 호스트 매니저 설치
    • 윈도우 데디서버 호스트 매니저 설치
    • 데디서버 호스트 매니저 설정하기
      • 리눅스 환경 설정 파일 예제
      • 리눅스 환경에서의 언리얼 엔진 4 권한 설정하기
      • 윈도우 환경 설정 예제
    • 데디케이티드 서버 추가 인자 지정
    • 데디서버 호스트 매니저 실행
  • 매치(게임 세션) 시작하기
    • 스폰한 데디케이티드 서버로 유저 보내기 (유저 난입)
    • 스폰 요청 취소하기
    • 가용한 호스트가 있는지 확인
    • 리다이렉트 전 콜백
  • 클라이언트에서 리다이렉션 메시지 처리
    • JSON 메시지
    • Protobuf 메시지
  • 데디케이티드 서버 처리하기 (언리얼 엔진 4)
    • 데디케이티드 서버 시작
    • 데디케이티드 서버가 준비되면 알려주기
    • 접속한 유저 인증처리
    • 게임 결과 보고하기
    • 메치 혹은 유저 데이터 얻기
    • 유저 상태 보고하기
    • 사용자 메시지 보내기
    • 게임 상태 저장하기
    • 명령줄 실행인자 가져오기
  • 데디케이티드 서버 처리하기 (유니티3D)
    • 명령행 인자 처리
    • 데디케이티드 서버 시작
    • 콜백 함수 추가하기
    • 사용자 명령줄 실행인자 가져오기
    • 매치 혹은 유저 데이터 얻기
    • 접속한 유저 인증 처리
    • 데디케이티드 서버가 준비되면 알려주기
    • 유저 진입/이탈 전달하기
    • 게임 상태 보내기
    • 사용자 정의 데이터 보내기
    • 게임 결과 보고하기
  • 데디케이티드 서버 처리 정보를 게임 서버에서 확인
    • 서버 입장/퇴장 콜백
    • 커스텀 데이터 콜백
    • 게임 상태 받아오기
  • 게임 결과 처리하기
  • 데디서버 호스트 매니저와 게임 서버 간 통신
• AWS 데디케이티드 서버 호스팅 지원
  • AWS 데디케이티드 서버 호스팅
    • VM 이미지(AMI) 준비
    • 아이펀 엔진 설정
    • 데디케이티드 서버 호스트 설정 콜백
    • AWS 데디케이티드 서버 호스팅 실행 결과
  • 데디케이티드 서버 State 서비스
    • State 서비스 설치
    • State 서비스 설정
  • 외부에서 AWS 데디케이티드 서버 호스팅 설정 변경
    • AWS 동적 업데이트를 위한 설정
    • AWS 설정 동적 업데이트
    • JWT 권한 승인 콜백
  • 스팟 인스턴스 사용
• 데디케이티드 서버 RPC 통신
  • 게임 서버
    • 기능 활성화 및 설정
    • 연결
    • 데디케이티드 서버 RPC 연결 목록
    • 데디케이티드 서버 태그 활용
    • 요청 보내기
  • 데디케이티드 서버(Unity)
    • 객체 생성 및 옵션
    • 메시지 핸들러
    • 연결
    • 디버깅
  • 데디케이티드 서버(UE)

17. 운영 편의 서비스

• 대시보드 (Dashboard)
  • OS 수준의 리소스 사용량 모니터링
  • 아이펀 엔진 이벤트 처리 성능 모니터링
  • 아이펀 엔진 ORM 처리 성능 모니터링
  • 아이펀 엔진 분산처리 성능 모니터링
  • Stage 별 처리 시간 및 Queue time 프로파일링
    • Overview
    • 테이블 형태
    • 실행 시간 분석
    • 대기 시간 분석
• 디플로이 (Deploy)
  • 미리 알아두어야 할 사항
    • 비동기 HTTP 응답 보내기
    • DeployApiHandlerBase 이용하기 (C++)
    • DeployService 의 인터페이스 이용하기 (C#)
  • 계정 관련 API 구현
  • 캐릭터 관련 API 구현
  • 인벤토리 관련 API 구현
  • 아이템 지급 관련 API 구현
  • 캠페인 (이벤트) 관련 API 구현
    • 캠페인 타입 등록하기
    • 캠페인 정보 이용하기
  • 환불 처리 API
  • 실시간 공지 API
  • 캐릭터 미션 API
  • 사용자 정의 기능 구현
    • 추가 설정

18. 코드 예제

• 방기반 MO 게임
  • Room 프로젝트 준비
  • MO 세션 구현
    • Room 구현
    • 이벤트 직렬화
• 멀티 플레이 서버 추가하기
  • 전체 서버군 구조
  • 게임 서버와 멀티플레이 서버 연동하기
    • 게임 서버의 클라이언트 접속 요청 처리하기
    • 매칭 메이킹 서버의 클라이언트 접속 인증 처리하기
  • 멀티 플레이 서버 측 작업
    • 매치메이킹
    • 게임 진행
    • 게임 종료 처리
  • 부하에 대응하기
• 로그인 예제
  • 로그인 서버 구현
    • ORM 오브젝트 정의하기
    • Protobuf 메시지 선언하기
    • 메시지 핸들러 등록하기
    • 로그인 및 로그아웃 관련 콜백함수 구현하기
    • 로그인 요청 핸들러 구현하기
    • 유저정보 요청 핸들러 구현하기
  • 테스트 클라이언트로 메시지 주고받기
    • funtest 를 이용한 메시지 주고받기
      • funtest 세션 생성 및 콜백함수 구현하기
      • 메시지 핸들러 등록 및 구현하기
    • 샘플 프로젝트를 이용한 메시지 주고받기
      • 샘플 프로젝트 코드 수정하기

19. 참고

• 아이펀 엔진 API 문서
• 연락처

Last updated: 2021-08-04 07:20:09+0000