[Legacy] Upload a Single-File Build
This is a legacy upload method.
Single-file builds are being gradually replaced by game build folders on Oppai.
For new games, we recommend using the folder-based upload with the sync command.
See:
This tutorial explains how to upload a single-file game build, typically a .zip file, using the Oppai CLI upload command.
Unlike the sync command, this upload method does not use a mapping file. The required information is provided directly through command-line arguments.
Prerequisites
Before you start, make sure you have:
- A game already created in Oppai
- The Game ID of the game you want to upload
- Oppai CLI downloaded and available on your computer
- Your game build as a single file, typically a
.zip
If you haven't created a game yet, access the Oppai Dashboard and create your game first.
Finding your Game ID
After creating your game, open the game's edit page and go to the Basic Info tab.
You can find the Game ID there.
Use the copy button next to the ID to copy it.
Command arguments
The upload command is command-line based. You provide the information required for the upload directly as command arguments.
Required arguments
You must provide these two arguments:
| Argument | Description |
|---|---|
-G, --game | The ID of the game you want to upload the file to. |
-F, --file | The path to the build file you want to upload. |
For example:
./oppai-cli upload -G game_id -F file_path
Optional arguments
You can also provide additional information about the build:
| Argument | Description |
|---|---|
-N, --name | The filename displayed on the website. |
-P, --platforms | The platforms where the build will be available. |
-T, --type | The type of file being uploaded. |
-U, --force | Forces the build to be overwritten if a file with the same name already exists. |
Platforms
The --platforms argument supports:
windows
mac
linux
android
ios
To specify multiple platforms, separate them with commas and do not add spaces.
For example:
-P windows,mac,linux
The default platform is:
windows
File types
The --type argument supports:
executable
source
soundtrack
video
image
document
The default file type is:
executable
For a typical game .zip build, use:
-T executable
Force overwriting
The --force option allows you to overwrite an existing build with the same filename without showing the confirmation prompt.
Use this option carefully.
View all available options
You can see the complete list of available arguments by running:
Windows
.\oppaicli.exe upload --help
macOS
./oppaicli-macos upload --help
Linux
./oppaicli-linux upload --help
Note: The executable name may be different depending on the version you downloaded. Use the actual executable filename included with your Oppai CLI download.
Running the upload
Once you know which arguments you need, build your upload command.
For example:
./oppai-cli upload -G game_id -F file_path -P windows -T executable
For a Windows and Linux game distributed as a ZIP file, the command might look like:
./oppai-cli upload -G 123456 -F "C:\Games\MyGame.zip" -P "windows,linux" -T executable
Replace the Game ID and file path with your actual values.
Confirming the upload
After running the command, Oppai CLI will validate the provided information and locate the game.
If everything is correct, the upload process will be ready to start.
If a build with the same filename already exists, Oppai CLI will display a warning and ask for confirmation.
Type:
y
to continue.
If you use the -U / --force option, Oppai CLI will overwrite the existing build without asking for confirmation.
Uploading the file
After confirmation, the upload will begin.
Oppai CLI will display the upload progress while the file is being transferred.
When the upload finishes successfully, a confirmation message will be displayed.
Your single-file build is now uploaded to Oppai.
Uploading the build does not automatically publish it to players.
You must publish the changes from the Oppai Dashboard after the upload is complete.
Publish your build
After the upload finishes successfully, the build will be available in your Oppai Dashboard, but it still needs to be published.
Open your game's page in the Oppai Dashboard and publish the changes.
Until you publish the changes, the uploaded build will not be available to players.
Once the changes are published, your build will be available to players according to the game's current settings.