2014-11-19 19:06:16 +00:00
# SheepIt Render Farm Client
2014-11-19 16:03:05 +00:00
2018-03-30 18:52:06 +02:00
[](http://travis-ci.org/laurent-clouet/sheepit-client)
2017-02-10 20:54:30 +01:00
2014-11-19 19:06:16 +00:00
## Overview
2016-01-06 09:44:47 -05:00
SheepIt Render Farm Client is an * Open Source * client for the distributed render farm [**SheepIt** ](https://www.sheepit-renderfarm.com ).
2014-11-19 19:06:16 +00:00
## Compilation
2021-09-10 00:28:19 +00:00
You will need Java 11 or higher. (OpenJDK and Oracle are both supported).
2019-08-11 17:30:50 +02:00
To create the jar file, simply type `./gradlew shadowJar` on linux/OSX and `gradlew.bat shadowJar` on Windows in the project's root directory.
2014-11-19 19:06:16 +00:00
## Usage
2019-03-22 19:17:14 -07:00
Once you have the jar file, you can see how to use it by running:
2015-10-20 20:37:42 -07:00
2020-09-11 07:11:53 -05:00
java -jar build/libs/sheepit-client-all.jar --help
2015-10-20 20:37:42 -07:00
2016-10-25 09:53:39 +02:00
When you are doing development work, you can use a mirror of the main site specially made for demo/dev. The mirror is located at **http://sandbox.sheepit-renderfarm.com ** , and you can use it by passing `-server http://sandbox.sheepit-renderfarm.com` to your invocation of the client.
2017-02-19 14:19:48 +01:00
2019-03-22 19:17:14 -07:00
At the command line ui (-ui text / -ui oneLine) you could type in the following commands and press enter to control the client:
2017-02-19 14:19:48 +01:00
2019-03-22 19:17:14 -07:00
* status: get the current status of the client (paused, stoped, etc.)
* priority <n>: set the renderer process priority
* block: block the current project
2017-02-19 14:19:48 +01:00
* pause: pause the client to request new jobs after the current frame has finished to render
* resume: resume the client after it was paused
* stop: stop the client after the current frame has finished
* cancel: cancel the stop request
2019-03-22 19:17:14 -07:00
* quit: stop the client directly without finishing the current frame
2023-01-13 18:11:24 +00:00
## Versioning scheme
The main versioning follows the following scheme: `vA.BBCCC.D`
* `A` : major version
* `BB` : last two digits of year (2023 -> 23)
* `CCC` : day of year with leading zeroes (340 is December 6th)
* `D` : number of repeated builds on that day
Development versions use a different schema for "D", generated by "git describe", e.g. `v6.23006.1-14-g840d517` .
For historic reasons, we need to make sure that neither X nor Y of X.Y.Z exceeds 5 digits to be compatible with the backend.
