db&w documentation wiki

finest software | finest docs

User Tools

Site Tools


renderbar

This is an old revision of the document!


renderBar — User Guide

renderBar is a waiting line for files that need to be processed by another program. You tell renderBar which program to use, add your files, and press Start. renderBar works through the list one file after another, even while you do something else.

Typical examples are render jobs for Blender or Maya, but any program that is started from a command line and works on a file can be used.

The main window

At the top you find a toolbar with the commands you need most:

ButtonWhat it does
Add Files…Adds files to the waiting line (the queue).
Task Runners…Opens the list of saved jobs, where you set up how files are processed.
StartBegins processing the files in the queue.
PausePauses or resumes the current job.
StopStops the current job and stops working through the queue.
Auto-startStarts new files automatically when they are added.
Copy OutputCopies the text in the output area to the clipboard.
Clear OutputRemoves the visible text in the output area.

Below the toolbar, the window is split in two:

- Queue (top): the files that are waiting, being processed, or finished. - Output (bottom): the messages produced by the selected file's program.

The same commands are also available in the File, Queue, Tools, and Help menus.


Set up a job (a "task runner")

A task runner is a saved instruction that tells renderBar:

- which program to start, - which kinds of files it handles, - and what exactly to tell the program.

You only need to set this up once for each program you use.

1. Click Task Runners… in the toolbar, or choose Tools → Task Runners…. 2. Click Add below the list on the left. 3. On the General tab, fill in:

  1. Name — anything you like, for example Maya Render.
  2. Executable — the program to start. Use Browse… to pick it.
  3. Icon — optional. A small picture shown next to the name. If you leave

it empty, renderBar uses the icon of the program you selected.

  1. Extensions — the file endings this job handles, separated by

semicolons and written without the dot, for example ma;mb;fbx. 4. Switch to the Command Line tab and enter the instructions for the

 program. You do not need to type the file path yourself — use the
 placeholders described below.

5. Click Save.

Tip: You can also drag a program file (.exe, .bat, or .cmd) onto
the task runner window. renderBar creates a new entry with the name and
program already filled in.

Duplicating a job

If two jobs are similar, you do not have to start from scratch:

1. Right-click an entry in the task runner list. 2. Choose Duplicate. 3. Change the name and any settings that differ. 4. Click Save.

The copy is added directly below the original and named … Copy.

Turning a job on or off

On the Scheduling tab you can untick Enabled. A disabled job stays in the list and can still be edited, but it is not used for new files. This is handy for jobs you only need now and then. If files are already waiting for a job that you disable, those files fail with a message in their output.

Choosing a priority

Also on the Scheduling tab, Task priority decides how much attention Windows gives the program while it runs. Leave it on Default to use the setting from Tools → Preferences, or choose a specific level for this job only.

The Workload setting records whether the job mainly uses the CPU, the GPU, or both. It helps you keep an eye on what each job needs.


Telling the program which file to open

In the Command line field, placeholders stand for the file and other details. renderBar replaces them automatically.

PlaceholderStands for
${payload}The full path of the file being processed
${payloadDir}The folder that contains the file
${payloadName}The file name, including its ending
${payloadStem}The file name, without its ending
${payloadExt}The file ending, without the dot
${runnerName}The name of the task runner
${runnerPath}The full path of the program
${runnerDir}The folder that contains the program

Example:

--file "${payload}" --output "${payloadDir}/${payloadStem}.png"

Put quotation marks around anything that may contain spaces, such as a file path. On Windows, renderBar passes paths in the usual Windows format, including network locations such as \\Server\Share\File.png.


Reading values from a file (optional)

Some programs need details from inside the file, for example the frames to render. If the file is plain text, renderBar can read those values for you.

On the Command Line tab, under Payload variables, enter a pattern that matches a line in the file. Each %name% picks up the text at that position:

Render Range %framestart% %frameend% %step%

If the file contains the line Render Range 125 250 2, renderBar sets framestart to 125, frameend to 250, and step to 2. You can then use those values in the command line:

--start ${framestart} --end ${frameend} --step ${step} "${payload}"

Every pattern you enter must be found in the file. If one is missing, the job stops with a message so you can check the pattern.


Add files to the queue

You can add files in any of these ways:

- Click Add Files… in the toolbar or choose File → Add Files…. - Drag files from Windows Explorer and drop them onto the renderBar window. - Use Open with in Windows and choose renderBar. - Drag files onto the renderBar program or its shortcut.

renderBar uses the file ending to pick the matching job. If more than one job matches, a small window asks which one to use. If none matches, you can choose a job for that type of file for this session.

If renderBar is already running, opening another file simply adds it to the existing window.


Process the queue

1. Press Start (or F5). 2. renderBar processes the files one after another and shows each one's

 messages in the **Output** area.

3. When everything is finished, the status bar shows that renderBar is idle.

The queue keeps status labels so you can see what happened:

- Waiting — not processed yet. - Rendering — currently running. - Done — finished successfully. - Failed — the program reported a problem. Check the output. - Stopped — you stopped it, or it was interrupted.

Finished files are not processed again when you press Start. Use Retry to put one back in the queue.

Pausing and stopping

- Pause (F6) freezes the current program and pauses the queue. - Pressing Pause again resumes both. - Stop (F7) stops the current job. Files that were still waiting remain in

the queue and can be processed by pressing **Start** again.

Starting new files automatically

The Auto-start button in the toolbar (also in the Queue menu) makes renderBar begin new files as soon as they are added, without pressing Start each time.

- It only applies to files added after you switch it on. Files that are

already waiting stay put until you press **Start**.

- The button can be switched on or off at any time, in any state. Switching it

on never starts files that are already waiting.

- Pause and Stop switch auto-start off, so the queue does not restart

behind your back. Switch it back on at any time, or press **Start** (or resume
from pause) to switch it back on.

- Files added while a job is running are picked up after the current job, as

usual.

- The setting is remembered between sessions. Restored files from the last

session never start on their own.

Working with queue entries

Right-click an entry in the queue to:

- Retry a finished or failed file. - Remove it from the queue. - Show Command Line… to see the exact instruction that was, or will be,

sent to the program.

- Copy Command Line to put that instruction on the clipboard. - Open Containing Folder to jump to the file in Windows Explorer. - Copy Output or Clear Output for that file's messages.

You can drag entries up and down to change the order in which they are processed.

To remove all finished entries at once, choose Queue → Clear Finished.


Preferences

Choose Tools → Preferences… to change:

- Launch renderBar at login — starts renderBar automatically when you sign

in to Windows.

- Task priority — the default amount of attention Windows gives to running

programs. Lower settings keep your computer more responsive; higher settings
may finish jobs sooner.

The Preferences window also shows the folder where renderBar keeps your queue and jobs.


The tray icon

The tray icon works like a traffic light:

- Green — a job is running. - Amber — the queue is paused. - Red — a job failed and is still in the queue. It turns back when you

retry, remove, or clear the failed file, or start a new run.

- No colour — renderBar is idle.

Closing the window does not quit renderBar. It keeps running in the notification area (the small icons near the clock), so a running job is not interrupted.

- Double-click the tray icon to show the window again. - Right-click it for a small menu with Show renderBar, Start, Pause,

  • Stop*, and Quit.

- The tray icon also tells you when a job finishes or fails.

Use File → Quit (or Quit in the tray menu) to close renderBar completely.


Where your settings are kept

renderBar remembers your queue, jobs, window size, and preferences between sessions. The files are stored in your personal settings folder:

%APPDATA%\db&w\renderBar

You can find this path in Tools → Preferences…. Deleting the folder resets renderBar to a fresh state.

Uninstalling renderBar does not delete this folder, so your jobs and queue are preserved if you install it again.


If something goes wrong

A file is not processed. Open the task runner list and check that a job is Enabled and that its Extensions include the file's ending.

A job fails immediately. Check the Output area. The program's message usually explains the problem. Also confirm the Executable path is correct — programs sometimes move after an update.

A “payload variable” error appears. The pattern under Payload variables did not match anything in the file. Compare the pattern with the file's contents, paying attention to spelling and capitalization.

The command looks wrong. Right-click the queue entry and choose Show Command Line…. This shows the exact instruction renderBar would send, which makes it easy to spot a wrong placeholder or a missing quotation mark.

The window disappeared. renderBar is still running in the tray. Double-click its tray icon, or right-click the icon and choose Show renderBar.


Keyboard shortcuts

ShortcutAction
F5Start
F6Pause / resume
F7Stop
Ctrl+OAdd files
Ctrl+TOpen task runners
F1Open the online documentation

More help

renderbar.1794998970.txt.gz · Last modified: by lightwolf