Documentation

Home / Documentation / RANCHecker & RANCHSync

RANCHecker & RANCHSync

Introduction

We have developed multiple tools to assist users throughout the farm rendering process. We recommend always using the latest version of our tools to maximize compatibility and minimize the risk of issues.

RANCHecker

RANCHecker creates a single archive of your project (scene + assets) for upload to the render farm. Each supported software has its own RANCHecker version and file extension format (.vux).

LogicielExtension
3DS Max *.vu3
Blender *.vub
Cinema 4D *.vuc
Houdini.vuh
Maxwell.vum
Maya *.vua
*RANCHSync upload compatible

For installation and usage instructions, refer to the documentation on the dedicated software pages.

RANCHSync

RANCHSync serves multiple purposes:

  • Download rendered project outputs (images, simulations, etc.) from the RANCH.
  • Upload archives created by RANCHecker (depending on software compatibility—see table above).

*depending on the software, see the chart

API Keys

When you create an account, an API key is automatically generated to link RANCHSync to your RANCH Computing account (highlighted in blue in your dashboard).
This key is available in your dashboard in Settings > Upload & Download section.

Managing API Keys

  • If multiple users share an account or you need to grant third-party access, you can create temporary API keys.
  • These keys are time-limited and can be revoked at any time.
  • The Permissions section allows you to specify whether a key can:
    • project.download → Download rendered outputs (images, simulations, etc.).
    • project.create → Create and upload new projects to the farm.

First usage

  1. Connect your account using the API key from your settings (copy and paste).
    • Option: Copy an existing key or generate a new one.
  2. Set the default directory for saved rendered files.
    • Default path: C:\Users\username\RANCHSync_projects
Copy an existing API Key or create a new one

Interface

Main windows

The interface consists of three tabs: Download, Upload, and Help. Each tab (except Help) is divided into two sections:

  • Left panel: List of projects linked to the connected account.
  • Right panel: Download options for the selected project.

Tray Icon

When you close the main interface, RANCHSync continues running in the background but remains accessible via the system tray menu.

CommandWindowsMac
Left clickOpen main interfaceOpen Menu
Right ClickOpen menuOpen main interface

Open interface : Launch the main window.

Online Dashboard : Open your default browser to the RANCH dashboard.

Logout : Disconnect the current API key (e.g., to switch accounts).

Quit : Fully close RANCHSync.

RanchSync Communication with Our Servers

RANCHSync operates seamlessly on all machines. However, if your company enforces security restrictions, ensure the following are permitted: (Note: Add specific technical requirements here, e.g., ports, domains, or protocols if applicable.)

Protocol Address Port Usage
HTTPS download.ranchcomputing.com 443 Communication with the remote server
HTTPS ranchcomputing.com 443 Communication with the remote server
TCP (local) localhost 7009 Communication between RanchCheckers (Maya, C4D, 3ds Max) and RanchSync