•
Product Version: v0.1.1.0 (Preview)
•
Guide Version: v2
Overview
STOVE Uploader CLI is a command-line tool that enables efficient uploading of content to the STOVE platform. It is designed to help developers and content creators improve productivity through batch uploads, automated workflows, and extensive file processing.
System Requirements
•
Operating System: Windows 10 or later
•
Memory: 4GB RAM or more
•
Storage: 200MB or more of free space
•
Network: Internet connection required
Prerequisites
STOVE Account
A STOVE member account is required to use STOVE Uploader CLI. If you don't have an account yet, please create one through the STOVE Sign Up link.
STOVE Studio
To use STOVE Uploader CLI, you need to register projects and products in STOVE Studio. Please visit STOVE Studio to create your projects and products first.
Instalation
Download
1.
Download STOVE Uploader CLI through the Download Link
2.
Extract the STOVEUploaderCLI.zip file to your desired location.
Usage
Program Parameters
To use STOVE Uploader CLI, you must pass several required parameters.
STOVEUploaderCLI.exe -g {game_id} -s {source} -d {description} -id {user_id} -pW {password} -cd {caller-detail}
Example: 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
복사
Option | Value Type | Description |
-g, --game-id | TEXT | Game ID of the target product. |
-s, --source | PATH | Source directory to upload. |
-d, --description | TEXT | Description of the game build to upload. (1~60 characters) |
-id, --user-id | TEXT | STOVE user account ID(Email). |
-pw, --password | TEXT | STOVE user account password. |
-cd, --caller-detail | TEXT | An additional key to authenticate your STOVE account. (You can request a key through store.support@smilegate.com). |
You can add the following parameters to adjust console output:
Option | Value Type | Description |
-hl, --hide-logs | X (flag) | Disable log output to console. |
-hp, --hide-progress | X (flag) | Disable progress display in console. |
You can check all available commands using the --help command:
STOVEUploaderCLI.exe --help
Plain Text
복사
Configuration File
You can save STOVE Uploader CLI parameters as a YAML configuration file and pass it to the program. The main items in the configuration file are as follows:
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
복사
You can find an example configuration file in cli_config_template.yaml distributed with the STOVE Uploader CLI package.
You can run the program using the configuration file. When using both configuration file and parameters simultaneously, parameter values take priority.
STOVEUploaderCLI.exe -c uploader_run_config_example.yaml
Plain Text
복사
Features
When running STOVE Uploader CLI with parameters or configuration file, it uploads the specified directory to the STOVE Studio system.
Key features include:
•
Real-time Progress Display: You can monitor upload progress in real-time through logs and progress indicators displayed in the console during upload.
•
Automatic Resume: If STOVE Uploader CLI is interrupted during execution on the same PC and directory, it automatically resumes the previous upload.
•
Differential Upload: When a live build exists for the product you want to upload, only files and directories with changes compared to the live build are uploaded.
Execution Results
•
On Success: When upload succeeds, STOVE Uploader CLI returns exit code 0, and you can access the STOVE Studio build management page for the uploaded directory through the URL link displayed in the console.
•
On Failure: When upload fails, it returns an exit code based on the failure cause and displays the failure reason in the console.
Troubleshooting
FAQ
Q: Upload failed.
Please check the following items and retry the upload. If the problem persists, please contact technical support.
•
Check your network connection status.
•
Verify that you entered correct STOVE account information.
•
Verify that you entered the correct directory path.
•
Check if any files or directories that cannot be uploaded are included (see below).
•
Verify that you entered a build description. (1 ~ 60 characters)
•
Verify that your current user account has permissions for the target STOVE Studio group and product you want to upload to.
Q: Are there restrictions on files that can be uploaded?
If any of the following items are included in the upload target directory or subdirectories, upload cannot proceed. Please exclude these items and try uploading again.
•
Files that cannot be uploaded:
◦
_force_studio_dll_
◦
DRMChecker.dll
◦
DRMCheckerV3.dll
•
Directories that cannot be uploaded:
◦
combinedata_manifest
◦
__map
◦
{game_id}_json (e.g. my_game_id_json)
Q: Is there a size limit for uploads?
There is no size limit for individual files or directories, but you cannot upload files or directories that exceed your current user's Studio group storage usage limit.
Q: Can I cancel an upload?
You can cancel during upload by pressing Ctrl+C.
Technical Support
If you encounter problems or need assistance:
Log Files
Providing log files when contacting support enables faster technical assistance. Log files can be found in the following locations:
%localappdata%\STOVEUploaderCLI\log\
%localappdata%\STOVEUploaderCLICore\log\
{STOVE Uploader CLI installation path}\STOVEUpdater\log\
Plain Text
복사
Error Code
Code name | Code number | Reason for occurrence | Code description | Note |
AUTH_MANAGER_ERROR | 10000 | Internal logic | Internal error related to authentication module | |
AUTH_MANAGER_NOT_IMPLEMENTED | 10098 | |||
AUTH_MANAGER_UNEXPECTED_ERROR | 10099 | |||
AUTH_MANAGER_SIGN_IN_FAILED | 10100 | Login API call failed | ||
AUTH_MANAGER_SIGN_IN_RETRY_COUNT_EXCEEDED | 10101 | Network | Login API call failed (maximum number of attempts exceeded) | |
AUTH_MANAGER_SIGN_IN_CANNOT_RETRY_REQUEST | 10102 | External Services | Login API call failed (abnormal response) | • This may occur if the ID/PW is incorrect. |
AUTH_MANAGER_SIGN_IN_INVALID_PARAMETER | 10103 | User input | At least one of ID/PW is not entered | |
AUTH_MANAGER_SIGN_IN_ALREADY_SIGNED_IN | 10104 | Internal logic | An internal error occurred while logging in | |
AUTH_MANAGER_SIGN_OUT_FAILED | 10200 | Logout API call failed | ||
AUTH_MANAGER_SIGN_OUT_RETRY_COUNT_EXCEEDED | 10201 | Network | Logout API call failed (maximum number of attempts exceeded) | |
AUTH_MANAGER_SIGN_OUT_CANNOT_RETRY_REQUEST | 10202 | External Services | Logout API call failed | |
AUTH_MANAGER_SIGN_OUT_INVALID_PARAMETER | 10203 | Internal logic | An internal error occurred while logging out | |
AUTH_MANAGER_SIGN_OUT_ALREADY_SIGNED_OUT | 10204 | |||
AUTH_MANAGER_GET_GDS_INFO_FAILED | 10300 | Internal logic | Failed to call GDS information query API | |
AUTH_MANAGER_GET_GDS_INFO_RETRY_COUNT_EXCEEDED | 10301 | Network | Failed to call GDS information query API (maximum number of attempts exceeded) | |
AUTH_MANAGER_GET_GDS_INFO_CANNOT_RETRY_REQUEST | 10302 | External Services | Failed to call GDS information query API (abnormal response) | |
AUTH_MANAGER_REFRESH_TOKEN_FAILED | 10400 | Internal logic | Failed to call Token refresh API | |
AUTH_MANAGER_REFRESH_TOKEN_RETRY_COUNT_EXCEEDED | 10401 | Network | Failed to call Token refresh API (maximum number of attempts exceeded) | |
AUTH_MANAGER_REFRESH_TOKEN_CANNOT_RETRY_REQUEST | 10402 | External Services | Failed to call Token refresh API (abnormal response) | |
AUTH_MANAGER_REFRESH_TOKEN_INVALID_PARAMETER | 10403 | Internal logic | An internal error occurred while refreshing the token | |
AUTH_MANAGER_REFRESH_TOKEN_THREAD_ALREADY_RUNNING | 10404 |
Patch Notes
•
v0.1.1.0 (Preview)
◦
Added additional key caller-detail for STOVE account authentication
•
v0.1.0.1 (Preview)
◦
First preview version