Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/RykoTheDev/Onyx-Steam-Build-Uploader/llms.txt

Use this file to discover all available pages before exploring further.

Onyx ships as a single self-contained executable built with Godot Engine 4.5. There is no installer, package manager entry, or runtime dependency — download the binary and run it. This page covers prerequisites, platform-specific steps, and how Onyx stores its configuration.

​
Prerequisites

Before running Onyx, you need the following in place:
  • Steamworks SDK — Download from the Steamworks partner site. Onyx requires the ContentBuilder component, which includes SteamCMD.
  • ContentBuilder directory — The tools/ContentBuilder/ directory from the Steamworks SDK, with content/, output/, and scripts/ subdirectories present.
  • A Steamworks partner account — Required to authenticate with Steam and publish builds.
Onyx does not bundle SteamCMD. It calls the steamcmd.exe or steamcmd.sh binary that is already part of your ContentBuilder installation.

​
Download Onyx

Download the latest release from the Onyx GitHub Releases page. Choose the file that matches your platform:
PlatformFile
WindowsOnyxUploader.exe
LinuxOnyxUploader.x86_64

​
Platform setup

1

Download the executable

Download OnyxUploader.exe from the releases page and place it in a folder of your choice. A dedicated folder is recommended because Onyx writes settings.cfg next to the executable.
C:\Tools\OnyxUploader\
└── OnyxUploader.exe
2

Run the executable

Double-click OnyxUploader.exe. No installer is needed — the application is a single self-contained file with all assets embedded.Windows SmartScreen may warn that the file is from an unknown publisher. Click More info then Run anyway to proceed.
3

Set your ContentBuilder path

On first launch, Onyx opens a setup dialog. Click Browse and navigate to your ContentBuilder directory (for example, C:\SteamworksSDK\tools\ContentBuilder). Onyx validates that content\, output\, and scripts\ subdirectories are present before saving the path.
SteamCMD on Windows is located at builder\steamcmd.exe inside the ContentBuilder directory. Onyx resolves this path automatically.

​
ContentBuilder directory structure

Onyx validates the ContentBuilder directory when you configure it. The directory must contain the following structure: 
ContentBuilder/
├── builder/               # Windows: contains steamcmd.exe
│   └── steamcmd.exe
├── builder_linux/         # Linux: contains steamcmd.sh
│   └── steamcmd.sh
├── content/               # Required — place your game files here
├── output/                # Required — SteamCMD writes upload logs here
└── scripts/               # Required — VDF build config files go here
    ├── app_<APPID>.vdf
    └── depot_<DEPOTID>.vdf
If any of content/, output/, or scripts/ are missing, Onyx will reject the directory and display an error. Create the missing folders manually before retrying.

​
Settings file

Onyx saves all configuration — including the ContentBuilder path and stored Steam accounts — to a file called settings.cfg.
ContextLocation
Running the distributed executableNext to OnyxUploader.exe or OnyxUploader.x86_64
Running from the Godot editoruser://settings.cfg (Godot’s user data directory)
To reset Onyx to a clean state, delete settings.cfg and relaunch. Onyx will open the setup dialog again on next startup.
Steam credentials stored in settings.cfg are saved in plain text. Keep the file and the directory containing Onyx in a location only you can access.

​
Next steps

Quickstart

Complete your first upload end-to-end.

Setting up ContentBuilder

Configure your ContentBuilder directory and VDF files.

Build docs developers (and LLMs) love

Get started for freeTalk to us