Files
sheepit-shadow-nabber/README.md

33 lines
1.5 KiB
Markdown
Raw Normal View History

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
[![Build Status](https://secure.travis-ci.org/laurent-clouet/sheepit-client.svg)](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
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
2018-08-18 12:09:00 +02:00
You need Java 1.7 or more. (OpenJDK and Oracle are both supported).
You also need [ant](http://ant.apache.org/).
To create the jar file, simply type `ant` in the project's root directory.
2014-11-19 19:06:16 +00:00
## Usage
Once you have a jar file, you can view the usage by running:
java -jar bin/sheepit-client.jar --help
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
At the command line ui (-ui text / -ui oneLine) you could type in the following commands and press enter to controll the client:
* status: to get the current status of the client (paused, stoped, ...)
* priority <n>: to set the renderer process priority
* block: to block the current project
* 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
* quit: stops the client directly without finishing the current frame