Documentation
RANCHecker & RANCHSync
Introduction
We have developed multiple tools for users to help along with the farm rendering process.
It is recommended to always use the last version of our tools to maximise the compatibility and minimise the risk of issues.
RANCHecker
It create a single archive of your project (scene + assets) that will be uploaded on the farm.
Each software has its own RANCHecker version and its own file extension format (.vux).
| Logiciel | Extension |
|---|---|
| 3DS Max * | .vu3 |
| Blender * | .vub |
| Cinema 4D * | .vuc |
| Houdini | .vuh |
| Maxwell | .vum |
| Maya * | .vua |
For installation and use, please refer to the documentation on the dedicated softwares pages.
RANCHSync
This tool outil has multiple functionalities:
- Download the rendering result of a project computed on the RANCH (images, simulation, …)
- Upload the archive created by RANCHecker *
*depending on the software, see the chart
API Keys
When you register, an API key is automatically created to link RANCHSync to your RANCH Computing account.
This key is available in your dashboard in Settings > Upload and download part.
If several peoples use this account or you wish to share your images with a third party, you have the possibility to create multiple temporary API keys. Those keys are limited in time and could also being disposed at any moment. Abilities part let you determine either if the key could or not :
- project.download → Download the result
- project.create → Create and upload projects
First usage
- Connect your account with the API key available in your settings.
- Choose the default directory where your renders will be downloaded. Initialy, it is set on C:\Users\username\RANCHSync_projects
Interface
Main windows
The interface is composed of 3 tabs « Download », « Upload » and « Help ». Each is divided in 2 part (except ‘Help’) :
- In the left, the projects list on the connected account.
- In the right, the download options for the selected project in the left part
Tray Icon
When you quit the main interface, RANCHSync stay in background task in your computer. However, it remains accessible in the tray menu in your task bar.
| Command | Windows | Mac |
|---|---|---|
| Left click | Open the main interface | Open the Menu |
| Right Click | Open the menu | Open the main interface |
Open interface : Open the main interface
Online Dashboard : Open the dashboard of your default browser
Logout : Disconnect the API key currently connected (to link another account for example)
Quit : Completely close RANCHSync
RanchSync Communication with Our Servers
RANCHSync works effortlessly on all machines. However, if your company has security restrictions, you may consider the following elements to allow them.
| 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 |