STOVE Uploader CLI 사용자 가이드
STOVE Uploader CLI 사용 방법 및 주요 유의사항에 대하여 안내합니다.
•
제품 버전: v0.1.1.0 (Preview)
•
가이드 버전: v2
개요
STOVE Uploader CLI는 STOVE 플랫폼에 콘텐츠를 효율적으로 업로드할 수 있는 명령줄 도구입니다.
개발자와 콘텐츠 제작자가 배치 업로드, 자동화된 워크플로우, 그리고 대용량 파일 처리를 통해 생산성을 향상시킬 수 있도록 설계되었습니다.
시스템 요구사항
•
운영체제: Windows 10 이상
•
메모리: 4GB RAM 이상
•
저장공간: 200MB 이상의 여유 공간
•
네트워크: 인터넷 연결 필수
준비
STOVE 계정
STOVE 스튜디오
STOVE Uploader CLI를 사용하기 위해서는 STOVE Studio에 프로젝트 및 상품 등록이 필요합니다.
설치
다운로드
1.
다운로드 링크를 통해 STOVE Uploader CLI를 다운로드합니다.
2.
원하는 위치에 STOVEUploaderCLI.zip의 압축을 해제합니다.
사용법
프로그램 매개변수
STOVE Uploader CLI를 사용하기 위해서는 몇 가지 매개변수를 필수로 전달해야 합니다.
STOVEUploaderCLI.exe -g {game_id} -s {source} -d {description} -id {user_id} -pW {password} -cd {caller-detail}
예시: STOVEUploaderCLI.exe -g GM-20A5-67F4E943_IND -s "D:\Build\Bin" -d V1.0.2 -id "xxxxx@smilegate.com" -pw pass!2025 -cd 3ebba3d0-3e03-xxxx-xxxxx-xxxxxxxxxxxxxx
Plain Text
복사
옵션 | 값 타입 | 설명 |
-g, --game-id | TEXT | 대상 상품의 게임 ID입니다. |
-s, --source | PATH | 업로드하려는 빌드 디렉토리(경로)입니다. |
-d, --description | TEXT | 업로드하려는 게임 빌드에 대한 설명입니다. (1~60자) |
-id, --user-id | TEXT | STOVE 사용자 계정의 ID(이메일)입니다. |
-pw, --password | TEXT | STOVE 사용자 계정의 비밀번호입니다. |
-cd, --caller-detail | TEXT |
다음 매개변수를 추가하여 콘솔 출력을 조정할 수 있습니다.
옵션 | 값 타입 | 설명 |
-hl, --hide-logs | X (flag) | 콘솔에 로그 출력이 되지 않도록 설정합니다. |
-hp, --hide-progress | X (flag) | 콘솔에 진척도가 표시되지 않도록 설정합니다. |
•
-help 명령어를 통해 전체 명령어를 확인하실 수 있습니다.
STOVEUploaderCLI.exe --help
Plain Text
복사
실행 설정 파일
STOVE Uploader CLI의 매개변수들을 YAML 설정 파일로 저장하여 프로그램에 전달할 수 있습니다. 설정 파일의 주요 항목들은 다음과 같습니다.
build_info:
game_id: your_STOVE_game_id
source: ./source/directory/to/upload
description: your game build description # up to 60 characters, should not be empty
credential:
user_id: your_STOVE_account_id
password: your_STOVE_account_password
YAML
복사
STOVE Uploader CLI 패키지 내에 함께 배포되는 uploader_run_config_example.yaml에서 설정 파일 예시를 확인하실 수 있습니다.
설정 파일을 사용하여 프로그램을 실행할 수 있으며, 설정 파일과 매개변수를 동시에 사용할 경우 매개변수에 입력한 값이 우선적으로 사용됩니다.
STOVEUploaderCLI.exe -c uploader_run_config_example.yaml
Plain Text
복사
기능
매개변수 또는 실행 설정 파일을 전달하여 STOVE Uploader CLI 실행 시 지정한 디렉토리를 STOVE Studio 시스템에 업로드합니다.
주요 기능은 다음과 같습니다:
•
실시간 진행률 표시: 업로드가 진행되는 중 콘솔에 출력되는 로그와 진척도를 통해 업로드 진행 상태를 실시간으로 확인할 수 있습니다.
•
자동 재시작: 동일 PC, 동일 디렉토리에 대해 STOVE Uploader CLI를 실행 중 중단하였다면 이전 업로드를 자동으로 이어서 진행합니다.
•
차분 업로드: 업로드하려는 상품에 대해 라이브 출시된 빌드가 존재하는 경우 라이브 빌드를 기준으로 변경사항이 있는 파일 및 디렉토리만 업로드합니다.
실행 결과
•
성공 시: 업로드가 성공한 경우 STOVE Uploader CLI는 exit code로 0을 반환하며, 콘솔에 출력되는 URL 링크를 통해 업로드한 디렉토리에 대한 STOVE Studio 빌드 관리 페이지에 접속하실 수 있습니다.
•
실패 시: 업로드가 실패한 경우 실패 원인에 따른 exit code를 반환하며, 실패 원인을 콘솔에 출력합니다.
문제 해결
FAQ
Q: 업로드가 실패했어요.
다음 항목들을 확인하신 후 업로드를 재시도해 주세요. 문제가 지속되면 기술 지원을 통해 문의해 주세요.
•
네트워크 연결 상태를 확인해 주세요.
•
올바른 STOVE 계정 정보를 입력했는지 확인해 주세요.
•
올바른 디렉토리 경로를 입력했는지 확인해 주세요.
•
업로드할 수 없는 파일이나 디렉토리가 포함되어 있는지 확인해 주세요 (하단 참조).
•
빌드 설명을 입력했는지 확인해 주세요. (1 ~ 60자)
•
현재 사용자 계정이 업로드를 진행하려는 대상 STOVE Studio 그룹 및 상품에 대해 권한이 부여되어 있는지 확인해 주세요.
Q: 업로드할 수 있는 파일에 제한이 있나요?
다음 항목들이 업로드 대상 디렉토리 또는 하위 디렉토리 내에 포함되어 있다면 업로드를 진행할 수 없습니다. 해당 항목을 제외한 후 업로드를 다시 시도해 주세요.
•
업로드가 불가능한 파일명
◦
_force_studio_dll_
◦
DRMChecker.dll
◦
DRMCheckerV3.dll
•
업로드가 불가능한 디렉토리
◦
combinedata_manifest
◦
__map
◦
{game_id}_json (e.g. my_game_id_json)
Q: 업로드 크기 제한이 있나요?
단일 파일 혹은 디렉토리에 대한 크기 제한은 없지만, 현재 사용자의 Studio 그룹 저장소 사용량을 초과하여 파일 또는 디렉토리를 업로드할 수 없습니다.
Q: 업로드를 취소할 수 있나요?
업로드 중 Ctrl+C를 눌러 취소할 수 있습니다.
기술 지원
문제가 발생하거나 도움이 필요한 경우:
로그 파일
문의 시 로그 파일을 전달해 주시면 보다 빠른 기술 지원이 가능합니다. 로그 파일은 다음 위치에서 확인할 수 있습니다:
%localappdata%\STOVEUploaderCLI\log\
%localappdata%\STOVEUploaderCLICore\log\
{STOVE Uploader CLI 설치 경로}\STOVEUpdater\log\
Plain Text
복사
에러 코드
코드 이름 | 코드 번호 | 발생 원인 | 코드 설명 | 비고 |
UTH_MANAGER_ERROR | 10000 | 내부 로직 | 인증 모듈 관련 내부 에러 | |
AUTH_MANAGER_NOT_IMPLEMENTED | 10098 | |||
AUTH_MANAGER_UNEXPECTED_ERROR | 10099 | |||
AUTH_MANAGER_SIGN_IN_FAILED | 10100 | 로그인 API 호출 실패 | CLI Core에서만 발생 | |
AUTH_MANAGER_SIGN_IN_RETRY_COUNT_EXCEEDED | 10101 | 네트워크 | 로그인 API 호출 실패 (최대 시도 횟수 초과) | |
AUTH_MANAGER_SIGN_IN_CANNOT_RETRY_REQUEST | 10102 | 외부 서비스 | 로그인 API 호출 실패 (비정상 응답) | ID/PW가 올바르지 않은 경우 발생할 수 있음 |
AUTH_MANAGER_SIGN_IN_INVALID_PARAMETER | 10103 | 사용자 입력 | ID/PW 중 하나 이상 미입력 | |
AUTH_MANAGER_SIGN_IN_ALREADY_SIGNED_IN | 10104 | 내부 로직 | 로그인 중 내부 오류 발생 | |
AUTH_MANAGER_SIGN_OUT_FAILED | 10200 | 로그아웃 API 호출 실패 | ||
AUTH_MANAGER_SIGN_OUT_RETRY_COUNT_EXCEEDED | 10201 | 네트워크 | 로그아웃 API 호출 실패 (최대 시도 횟수 초과) | |
AUTH_MANAGER_SIGN_OUT_CANNOT_RETRY_REQUEST | 10202 | 외부 서비스 | 로그아웃 API 호출 실패 | |
AUTH_MANAGER_SIGN_OUT_INVALID_PARAMETER | 10203 | 내부 로직 | 로그아웃 중 내부 오류 발생 | |
AUTH_MANAGER_SIGN_OUT_ALREADY_SIGNED_OUT | 10204 | |||
AUTH_MANAGER_GET_GDS_INFO_FAILED | 10300 | 내부 로직 | GDS 정보 조회 API 호출 실패 | |
AUTH_MANAGER_GET_GDS_INFO_RETRY_COUNT_EXCEEDED | 10301 | 네트워크 | GDS 정보 조회 API 호출 실패 (최대 시도 횟수 초과) | |
AUTH_MANAGER_GET_GDS_INFO_CANNOT_RETRY_REQUEST | 10302 | 외부 서비스 | GDS 정보 조회 API 호출 실패 (비정상 응답) | |
AUTH_MANAGER_REFRESH_TOKEN_FAILED | 10400 | 내부 로직 | 토큰 리프레시 API 호출 실패 | |
AUTH_MANAGER_REFRESH_TOKEN_RETRY_COUNT_EXCEEDED | 10401 | 네트워크 | 토큰 리프레시 API 호출 실패 (최대 시도 횟수 초과) | |
AUTH_MANAGER_REFRESH_TOKEN_CANNOT_RETRY_REQUEST | 10402 | 외부 서비스 | 토큰 리프레시 API 호출 실패 (비정상 응답) | |
AUTH_MANAGER_REFRESH_TOKEN_INVALID_PARAMETER | 10403 | 내부 로직 | 토큰 리프레시 중 내부 오류 발생 | |
AUTH_MANAGER_REFRESH_TOKEN_THREAD_ALREADY_RUNNING | 10404 |
패치 노트
•
v0.1.1.0 (Preview)
◦
STOVE 계정 인증을 위한 추가적인 키 caller-detail 추가
•
v0.1.0.1 (Preview)
◦
최초 프리뷰 버전