STOVE Uploader CLI 使用者指南
本指南將說明 STOVE Uploader CLI 的使用方式與主要注意事項。
•
產品版本: v0.1.1.0 (Preview)
•
指南版本 v2
概述
STOVE Uploader CLI 是一款可將內容高效上傳至 STOVE 平台的命令列工具。
本工具特別為開發者與內容製作者設計，可支援大量檔案處理、自動化流程與批次上傳，大幅提升工作效率。
系統需求
•
作業系統：Windows 10 以上
•
記憶體：4GB RAM 以上
•
儲存空間：至少 200MB 可用空間
•
網路：需可連接網際網路
使用前準備
STOVE 帳號
使用 STOVE Uploader CLI 前，必須具備 STOVE 帳號。
STOVE Studio 專案
在使用 CLI 上傳前，您必須先在 STOVE Studio 中建立「專案」與「商品」。
安裝
下載
1.
透過此連結下載 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 帳號（Email） |
-pw, --password | TEXT | STOVE 帳號密碼 |
-cd, --caller-detail | TEXT | 帳號認證所需額外金鑰（可向 store.support@smilegate.com 申請） |
以下參數可用來調整 CLI 的輸出內容
參數 | 型態 | 說明 |
-hl, --hide-logs | flag | 隱藏所有日誌 |
-hp, --hide-progress | flag | 隱藏上傳進度列 |
•
完整指令可透過以下方式查看：
STOVEUploaderCLI.exe --help
Plain Text
복사
設定檔（YAML）模式
您可以將要傳入 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
복사
工具內已附上範例：uploader_run_config_example.yaml
以設定檔方式執行：
STOVEUploaderCLI.exe -c uploader_run_config_example.yaml
Plain Text
복사
若同時提供「設定檔 + 命令列參數」，則 命令列參數優先。
主要功能
•
即時上傳進度顯示
•
自動續傳（同一 PC、同一路徑中斷後再執行即可續傳）
•
差異（Incremental）上傳：
若已有 Live 組建，僅上傳變更的檔案與資料夾
執行結果
上傳成功
•
CLI 回傳 exit code 0
•
Console 會顯示可直接前往 STOVE Studio 組建管理頁面的 URL
✘ 上傳失敗
•
CLI 會回傳對應錯誤碼
•
Console 會顯示錯誤原因
問題解決（Troubleshooting）
Q. 上傳失敗了，怎麼辦？
請檢查以下項目：
•
網路連線是否正常
•
STOVE 帳號資訊是否正確
•
是否輸入了正確的組建資料夾路徑
•
組建描述是否填寫（1～60 字）
•
是否包含禁止上傳的檔案或資料夾（如下表）
•
帳號是否具備上傳權限（Studio 群組 / 商品權限）
禁止上傳的檔案 / 資料夾
禁止檔案名：
•
_force_studio_dll_
•
DRMChecker.dll
•
DRMCheckerV3.dll
禁止資料夾：
•
combinedata_manifest
•
__map
•
{game_id}_json
例：my_game_id_json
Q. 有上傳大小限制嗎？
單一檔案 / 資料夾 沒有大小限制。
但若超過您 Studio 群組的儲存容量，則無法上傳。
Q. 可中止上傳嗎？
可以。
執行中按 Ctrl + C 即可中斷。
技術支援
•
•
Discord（STOVE Store 支援伺服器）：日誌檔（Logs）位置
%localappdata%\STOVEUploaderCLI\log\
%localappdata%\STOVEUploaderCLICore\log\
{STOVE Uploader CLI 설치 경로}\STOVEUpdater\log\
Plain Text
복사
錯誤碼（Error Codes）
代碼名稱 | 代碼編號 | 發生原因 | 代碼說明 | 備註 |
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 呼叫失敗（非正常回應） | 可能於帳號/密碼錯誤時發生 |
AUTH_MANAGER_SIGN_IN_INVALID_PARAMETER | 10103 | 使用者輸入 | 未輸入帳號或密碼其中一項以上 | |
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 | 內部邏輯 | Token 更新 API 呼叫失敗 | |
AUTH_MANAGER_REFRESH_TOKEN_RETRY_COUNT_EXCEEDED | 10401 | 網路 | Token 更新 API 呼叫失敗（超過最大重試次數） | |
AUTH_MANAGER_REFRESH_TOKEN_CANNOT_RETRY_REQUEST | 10402 | 外部服務 | Token 更新 API 呼叫失敗（非正常回應） | |
AUTH_MANAGER_REFRESH_TOKEN_INVALID_PARAMETER | 10403 | 內部邏輯 | Token 更新過程中發生內部錯誤 | |
AUTH_MANAGER_REFRESH_TOKEN_THREAD_ALREADY_RUNNING | 10404 |
更新紀錄（Patch Notes）
•
v0.1.1.0 (Preview)
◦
新增 STOVE 帳號驗證所需的 caller-detail 參數
•
v0.1.0.1 (Preview)
◦
初始預覽版本