# Submitting Game Builds

# Uploading Builds

This guide will walk you through the process of uploading your game builds, giving you two convenient options: directly from our desktop application or using our command-line tool, ibuilds.

Before You Begin (Prerequisites):

  • IndieBuilds Account: You'll need an active IndieBuilds developer account. If you don’t have one, sign up at Login:.
  • Game Page Created: Ensure you've created a game page on IndieBuilds for your game.
  • Build Ready: Your game build should be packaged in a format compatible with IndieBuilds. Currently supported compressed .zip format.
    • Windows: zip file must contain a single .exe game executable.
    • macOS: NOT supported.
    • Linux: NOT supported. If you are developing on linux we recommend using a cross compilation tool either in your game engine of choice (if avialable) or by another means to produce windows .exe binaries.

# Method 1: Uploading via the IndieBuilds Desktop Application

Step-by-Step Instructions:

  1. Download & Install: Download the IndieBuilds desktop application from IndieBuilds Desktop. Follow the installation instructions for your operating system.
  2. Login: Launch the application and log.
  3. Select Game: At the top 'Developer' menu click it.
  4. Click "Upload Build": You’ll see an “Upload Build” button – click it.
  5. Choose Your Build File: A file explorer window will open. Navigate to the location of your packaged game build and select the appropriate file.
  6. Enter Build Details: After selecting the file, you'll be prompted for:
    • Build Version: Enter the version number for this build (e.g., 1.0, Beta-2). This is important!
    • Branch (Optional): Select a branch (e.g., "Main," "Beta," "Alpha"). Branches help you organize different versions of your game. If you don't need branches, leave it as the default.
    • Release Notes (Optional): Briefly describe the changes and improvements in this build. This will be visible to players.
  7. Upload: Click the "Upload" button. The application will begin uploading your build. A progress bar will indicate the upload status. Do not close the application during the upload process.
  8. Verification: Once the upload is complete, IndieBuilds will automatically perform some basic checks on your build. You'll see a notification indicating whether the verification was successful or if there were any issues.

# Method 2: Uploading using the ibuilds CLI Tool (Command Line Interface)

The ibuilds CLI is designed for developers who prefer command-line workflows, automation, and scripting.

Step-by-Step Instructions:

  1. Installation: Download and install the ibuilds CLI tool from [Link to ibuilds CLI Download Page]. Follow the installation instructions specific to your operating system (Windows, macOS, Linux).

  2. Authentication: Before uploading, you need to authenticate the CLI with your IndieBuilds account. Open a terminal or command prompt and run:

    ibuilds login [Your API Key]
    
    • You can find your API key in your IndieBuilds developer dashboard: [Link to API Key Page]. Keep this key secure!
  3. Navigate to Build Directory: In your terminal, navigate to the directory containing your packaged game build file (e.g., cd /path/to/your/game/build).

  4. Upload Command: Use the following command to upload your build:

    ibuilds upload --game-id [Your Game ID] --version [Build Version Number] --branch [Branch Name (Optional)] --notes "[Release Notes (Optional)]" [Path to Build File]
    
    • [Your Game ID]: Find this in your game profile on IndieBuilds: [Link to Game Profile Management Page].
    • [Build Version Number]: The version number for this build (e.g., 1.0, Beta-2).
    • [Branch Name (Optional)]: The branch you want to associate with this build (e.g., "Main," "Beta"). If omitted, it defaults to the main branch.
    • [Release Notes (Optional)]: A brief description of changes in this build. Enclose in quotes if containing spaces.
    • [Path to Build File]: The full path to your game build file (e.g., mygame_windows_build.zip).

    Example:

    ibuilds upload --game-id 12345 --version 1.1 --branch Beta --notes "Fixed a critical bug and added new UI elements." mygame_windows_build.zip
    
  5. Verification: The CLI will display progress information during the upload process. Upon completion, it will indicate whether the verification was successful or if there were any errors.


# Troubleshooting & Support

  • Upload Failed: Check your internet connection and ensure you have sufficient storage space on IndieBuilds.
  • File Format Error: Double-check that your build file is in a supported format (see prerequisites).
  • Authentication Issues (CLI): Verify your API key is correct and hasn't been revoked. Run ibuilds logout and then ibuilds login again.
  • Verification Errors: Review the error message carefully. It usually indicates a problem with the build itself or missing required information.

For more detailed documentation, FAQs, and troubleshooting guides, please visit our developer support portal: [Link to Developer Support Portal]

We're here to help! If you have any questions or encounter any issues, don’t hesitate to contact us at [Link to Contact Form/Email Address].