1. Build Sytem 이란?
빌드/배포/백업 자동화 툴.
빌드 담당자 성향에 따라 제각각 관리되어 왔던 각 국가별 빌드/배포/백업 작업의 자동화를 진행하여 국내 및 해외 빌드/배포 프로세스를 일원화 시킨다.
2. Build System 사용 전 준비 되어야 할 시스템 환경
2.1 Perforce Command Line Client 설치가 필요하다.
설치파일 perforce.exe 를 실행하여, 해당 옵션만 선택 후, 설치한다. (그림 a 참조)
(Perforce path: //client/클라/설치파일모음/BuildSystem-사용시 필요한 파일/perforce.exe)
<그림 a>
2.2 개발라인 e-mail 전송을 위한 outlook 설정이 필요하다
a. 메일 서버 유형: POP3
b. 메일 서버 주소: mail.webzendev.com
c. 개발 메일 id 및 pw는 개발망 AD 계정
2.3 C++ Redistributable Package 를 설치해야 한다.
(Perforce path: //client/클라/설치파일모음/BuildSystem-사용시 필요한 파일/vcredist_x86.exe)
2.4 바이너리 패커 사용을 위해서는 Themida가 시스템에 설치되어 있어야 함.
(Perforce path: //client/클라/설치파일모음/Themida/)
Themida를 이용해서 패킹할 때에는 자동으로 디지털 서명이 진행됨.
2.5 핵쉴드를 사용한다면, HSB Generator 설정을 해야 함. (2012년 5월 현재, 핵쉴드를 사용중인 국가는 없으므로 HSB 생성 관련 설정은 하지 않도록 한다)
HSB Generator 사용을 위해서는 HSBGen.exe가 시스템에 설치되어 있어야 함.
a. HSBGen.exe는 국가별 HackShield 버전에 맞는 것을 이용해야 한다
b. 버전별 HackShield는 Perforce path: //HackShield 에 존재
c. HSBGen.exe의 위치 : 각 버전/Korean(kr)-SDK/Bin/Win/x86/AntiCrack/HSBGen.exe
3. Build System 사용법
3.1
1) e-mail Address
Build 결과를 메일로 받아 볼 수 있다. 통지를 받을 e-mail 주소를 적을 것.
(여러 명의 주소를 ;(세미콜론)으로 구분하여 입력 가능. 세미콜론 구분자 사이에 공백이 있으면 메일 발송 도중 오류가 발생하므로 주의해주세요.)
2) Perforce Root Path
Perforce 설치 시 Root로 지정한 Path를 등록해준다.
3) Project Path
빌드할 소스가 위치하는 working copy folder를 의미한다 (ex. D:\Project). 국가별로 다르니 처음에 잘 세팅해 둘 것.
4) 실행 파일 Output Path
빌드 시 실행파일이 생성되는 경로를 의미한다. 국가별로 다르니 처음에 잘 세팅해 둘 것.
5) 빌드 버전 선택용 콤보박스
버전을 선택하여 국가별 빌드 항목을 선택할 수 있는 콤보박스.
“Load ver.” 버튼을 클릭하지 않은 경우엔, 이 선택할 리스트 내용이 없다.
6) “Load ver.” 버튼
ClientVer.h를 읽어서 국가별 버전 정보를 얻어오는 버튼 (3.2 에서 자세히 설명)
7) SVN- 소스 Update 선택
SVN 서버에서 소스를 받아오는 방법 선택.
None – 소스를 받아오지 않고 로컬에 있는 소스를 유지한다.
Update – 최신 소스를 전부 받아온다. (로컬에서 수정한 채 commit을 안하고 그대로 둔 소스는 Update 되지 않음. 주의할 것)
특정 Revision Update – 이 옵션을 선택하면 에디트 박스가 보여지며 (아래 그림 참고), 이 에디트 박스에 Revision 번호를
입력하면, 해당 Revision까지의 소스만 받아온다.
8) Build or ReBuild 선택
Build 또는 ReBuild 둘 중 하나를 선택하여 빌드.
선택된 config가 모두 빌드 되면 SVN 서버에 Tag가 자동 등록된다. (로컬의 revision 번호에 해당하는 Tag가 등록됨)
(Tag명은 버전명과 동일하고, 같은 버전을 다시 빌드하여 Tag명이 중복되면 기존 Tag를 지우고 다시 등록함)
Debug config만 빌드한 경우엔 Tag를 등록하지 않음.
9) Build 후 기본 테스트 진행 선택
GameClient_Debug.exe 또는 GameClient.exe 를 빌드 하는 경우 기본테스트 진행 옵션을 선택하여
간략한 게임 접속 테스트를 진행할 수 있다.
BuildSystem 폴더 내에 autotest.ini 파일이 존재해야 하며, autotest.ini에 적절한 유저 id 세팅이 필요하다.
autotest.ini 파일 샘플 경로- Perforce path: //client/클라/개발관련 ini/autotest.ini
현재는 “start-> loading->서버선택->캐릭선택->마을진입->종료” 정도만 자동 테스트함. – 차후 기능 추가 예정.
기본테스트가 자동 진행되는 동안, 로딩중 리소스 이상 문제로 더 이상 진행이 안 되는 경우가 있을 수 있다.
(로딩 멈춤 혹은 crash 발생 등등…)
오랜 시간 빌드 완료 메일이 오지 않는다면 혹시 이 step에서 멈춰있지는 않은지 확인해보자 --;
이런 경우를 대비해서, 빌드 시 이 항목을 선택하여 빌드하지 말고,
빌드 완료 후 메뉴의 “Tools/Test…” 를 이용해 차후 따로 테스트 해보는 것도 방법이 된다. (단축키는 F7)
10) Perforce 리소스 받기 선택
각 국가별 Perforce 리소스 Path가 지정되어 있어야 함.
해당 체크박스를 켜면 Perforce Sync 후, 최신 데이터를 내 실행파일 Output Path의 Data 폴더로 복사해 오는 작업이 자동 진행됨.
11) Build 결과 메일링 서비스 선택
빌드 결과에 대한 e-mail 통지를 받을 수 있다.
(Backup 진행 선택 시엔, Backup 진행 전까지의 결과를 e-mail로 통지하고 Backup 이후에 Backup 완료 e-mail 통지를 다시 한다.)
12) 담당자
빌드 담당자 이름을 입력할 것. 이 세팅은 저장되지 않는다. 한번 이름 세팅 후 다시 바꾸지 않아 담당자가 모호하게 되는 경우를 방지하기 위해
일부러 저장 안 함.
빌드 시 이름을 정확히 입력하는 습관을 들일 것.
13) Start (단축키 F5)
모든 세팅이 완료 되었으면, Start 버튼으로 작업을 시작한다.
작업 시작 시, 현재 세팅이 localEnv.cfg 파일에 저장된다.
14) 바이너리 패킹 진행 선택 – 선택시 자동 진행
바이너리 패킹시 사용하는 설정파일(*.arm 또는 *.tmd) 세팅 및 바이너리 패킹 결과 Output Path 가 지정되어 있어야 함.
SoftwarePassport는 패킹 설정 파일이 *.arm 이며, Themida는 *.tmd 이다.
Themida로 패킹하기 위해서는 빌드 PC에서 환경 변수 설정이 필요하다.
Themida.exe가 위치하고 있는 폴더가 D:\Themida 인 경우,
내 컴퓨터 -> 고급 -> “환경 변수” 버튼 클릭
Path 항목을 선택 후, “편집” 버튼 클릭
변수 값 맨 뒤에, ;D:\Themida 추가 하고 “확인”버튼 클릭하고, 시스템 리부팅!!!
또한 Themida를 사용하는 경우,
실행 파일 배포의 가장 마지막 단계에서 코드 사인(디지털 사인)을 자동 진행하게 된다.
15) HSB 파일 생성 진행 선택 및 디지털서명 설정
(1) 핵쉴드를 사용한다면, HSB Generator 설정을 해야 하고 반드시 HSB 파일 생성 진행 체크박스를 켜야 한다.
HSBGen.exe 파일 path는 국가별 핵쉴드 버전에 맞춰 path를 지정해야 함.
핵쉴드 버전이 업데이트 되면 경로 지정도
다시 세팅할 것!
Sungame.exe 경로 및 AntiCpx.hsb 경로는 HSBGen.exe를 직접 실행할 때 처럼 지정하면 된다.
주의) HSBGen은 AntiCpx.hsb
파일을 생성할 때, pack 버전 Sungame.exe 파일도
변경한다.
따라서, HSBGen이 변경한 Sungame.exe 파일이 최종적으로 유저에게 배포되어야 한다.
HSB 파일 생성 진행 선택하면, hsb 파일 생성 후 HSB Gen 설정의 pack file Path에 있는 Sungame.exe를
바이너리 패킹 설정의 output path로 복사한다.
(따라서 HSB Gen 설정의 pack file Path와 바이너리 패킹 설정의 output path를 동일하게 설정하는 것이
바람직하다. 최종 배포파일이 한 곳에 모일 수 있도록. ex)D:\Project\Client\_bin_Pack )
(2) 핵쉴드를 사용하지 않더라도 디지털 서명을 위해서는 unpack file이 위치하는 경로와
pack file이 위치하는 경로 세팅은 반드시 해두어야 한다.
그래야 pack file에 디지털 서명이 정상적으로 진행되며, 배포에도 문제가 없게 된다.
16) 배포 선택
배포할 목록을 체크 한다. (5가지 목록 중 한 개도 체크되어 있지 않으면 배포 작업은 진행되지 않음)
배포 Upload Root Path를 지정하면 국가별로 Perforce에 업로드 된다.
//client/국가별버전배포/국내
//client/국가별버전배포/글로벌
//client/국가별버전배포/대만
//client/국가별버전배포/일본
//client/국가별버전배포/중국
지정한 path를 기준으로 upload 되는 경로는 다음과 같다.
배포가 되는 경우, Perforce 에는 빌드관련 로그(BuildLog)가 별도로 upload 되어 pdb/map 관리 및 실행 파일 관리를 국가별로
할 수 있게 한다.
17) Backup 진행 선택
Backup Root Path를 지정후 체크박스를 켜주면, 국가별로 백업이 진행된다. (다음 그림 참조)
이 경우, 국가 폴더는 빌드버전 앞머리에 따라 구분된다. (앞머리가 없으면 kor)
Backup 옵션도 반드시 선택하도록 하자!!
그리고, 주기적으로 Backup 폴더의 오래된 Backup파일들을 지워주자.
Perforce 업로드 시 description에 다음 그림과 같이 입력된다. (빌드 버전과 담당자가 명시됨)
18) Log 창
진행중인 작업 log가 출력된다.
3.2 “Load Ver.” 버튼 사용
이 버튼을 이용하여 버전을 선택해야만 Build System을 정상적으로 사용할 수 있다.
버튼을 클릭하면, 다음과 같은 선택 창이 뜬다.
“예”를 선택하면, SVN에 연결하여 최신 버전의 ClientVer.h를 받은 후, 버전을 읽어오는 것이고,
“아니오”를 선택하면, 로컬 폴더에 있는 ClientVer.h 에서 버전을 읽어오는 것이다.
“예”를 선택하여 파일을 가져오는 경우, 아래와 같은 확인 창이 뜨며
“아니오”를 선택하여 로컬의 파일을 가져오는 경우엔 시간이 얼마 걸리지 않아
바로 콤보박스를 열면 국가별 버전 확인이 가능하다.
버전을 선택하면, 빌드 버전을 증가시킬 수 있는 “Create Ver.” 버튼이 생기며, (배포시 빌드 버전은 반드시 올려줘야 한다!_)
이 버튼을 클릭하면, 아래 그림과 같이 확인 창이 뜬다.
“예”를 클릭하면, 버전이 수정되고 ClientVer.h가 다시 로드되므로
다시 콤보박스를 열어 수정된 버전을 선택하도록 하자.
만약 실수로, 버전을 잘못 올렸다면..(예를 들어, 타 국가 버전을 올렸거나..) “Revert” 버튼을 클릭하여
버전 수정 이전 상태로 되돌린다.
아래 그림은 “Revert” 버튼 클릭 시 출력되는 확인 창이다.
버전을 선택하면, 각 버전에 따른(국가별) 빌드 config가 선택 목록으로 나온다. (여기서 선택한 config가 없으면 빌드는 진행되지 않음)
4가지 config를 모두 체크하여 한 번에 빌드를 다 해두는 것이 시간이 더 걸릴지는 몰라도 편하다.
(차후, 문제 발생시 덤프용 실행파일을
새로 빌드해서 주지 않아도 된다)
급히 배포되어야 할 빌드가 아니라면 4가지 config를
모두 체크하자.
국가별 빌드 config를 선택 목록으로 보여줄 수 있는 건 BuildSystem 폴더에 존재하는 config.ini 가 있기에 가능하다.
이 ini 파일에 국가별 버전 구분자 (cn , tw , jp , gsp 등등) 및 config / exe 파일 명 등이 세팅되어 있다.
만약 build config가 새로 추가 되거나, 국가가 새로 추가 되는 경우 config.ini 도 수정이 되어야
Build System 이용 시 정확한 빌드가 가능하다. (가장 중요함!!!!!)
원하는 빌드 옵션을 모두 체크 후, “Start” 버튼을 클릭하면, 버전이 수정된 경우, 자동으로 소스 commit이 된다.
최종적으로 아래 그림과 같이 선택한 작업 목록을 출력하며 마지막 확인을 요청하는 창이 뜬다.
내용을 반드시 확인한 후, 이상 없으면, “OK”버튼을 클릭한다.
3.3 메뉴 및 단축키 설명
1) File 메뉴
- Save (Ctrl+S) : 현재 설정을 저장한다. (localEnv.cfg ) Start 버튼 클릭시에도 저장 되지만 수시로 저장하고 싶을 때 사용.
- Start (F5) : 작업을 시작한다. Start 버튼 클릭과 같은 기능.
- Exit (Alt+F4) : 프로그램 종료.
2) Tools 메뉴
- Test (F7) : 별도로 기본테스트를 진행하고 싶을 때 사용. (GameClient.exe 또는 GameClient_Debug.exe를 선택할 수 있다.
- 국내 test_release Upload (Ctrl+U): 국내버전의 경우 //test_release or //test_Dev_release 에 직접 업로드해야 하므로 별도의 메뉴를 만들었다. (해외버전은 사용 하지 말 것)
이 메뉴를 선택하면, 업로드할 폴더를 선택하라는 다이얼로그 박스가 열리고 확인을 클릭하면 업로드 됨.
(Perfoce 리소스 path에 설정한 폴더가 디폴트로 선택되어 열림)
- engine dll binary packing (Only Themida) … (Ctrl+P) : 엔진 dll을 바이너리 패킹하여 배포할 때 사용하는 메뉴. (Themida 패커만 지원)
메뉴를 선택하면 패킹 설정 파일을 선택하라고 나오는데, “SUNEngine.tmd”를 선택해야 함.
dll 패킹을 위한 설정은 exe와 다르므로 주의할 것.
또한, 엔진이 변경되는 경우에만 패킹하면 됨.
(패킹된 dll은 원본 파일과 같은 폴더 내에 위치한다. 원본은 *.bak라는 이름으로 백업됨)
Themida로 패킹되므로, 코드 사인(디지털 사인)은 패킹 이후 자동 진행된다.
3) Help 메뉴
- About Build System… (F12) : 프로그램 정보 및 도움말을 확인 할 수 있다.