Command Line

You can use FurryBallStandalone.exe directly from command line. Here we explain which commands you can use.

Standalone Commands

render

• Command for rendering frame or frames from exported FurryBall scene.
• Syntax:
• render path [arguments]
• Note:
• All of optional arguments can be specified in settings file. It is reason to no of all settings can be overridden.
• To render on single computer it is recommended to use FurryBall.exe application as is illustrated in Standalone Rendering section.
• Path arguments:
• Path must refer to exported scene directory or any of settings file (render_options.fbr or .fbo files).
• Example:
• render "c:/export/"
• render "c:/export/render_options.fbr"
• render "c:/export/custom.fbo"
• Note:
• This argument can be overridden by others arguments.
• If you can render different scenes or you have some problems with render, you can try to use clearMemory command.
• Allowed arguments:
• -exit: Standalone will be closed after render finished.
• Example:
• render "c:/export/" -exit
• -frame (-f): Frame to be rendered.
• Example:
• render "c:/export/" -frame 1
• render "c:/export/" -frame 1 -frame 2
• Note:
• You can set more than one frames to render. If you can override frames from settings file, use -framesClear argument before.
• -framesClear (-fc): All frames setted before (also from settings file) will be cleared, now you can set your own frames.
• Example:
• render "c:/export/" -framesClear -frame 1 -frame 2
• Note:
• This command must be presented before another -frame command, otherwise none of frames will be rendered.
• -fileName (-fn): You can specify output filename.
• Example:
• render "c:/export/" -fileName "$EXPORT_DIR/image_$RENDER_SETTINGS#"
• Note:
• This argument can obtain FurryBall variables as shown in Output Settings section in Standalone Rendering.
• -backup (-b): You can enable backup existing files to backup directory.
• Example:
• render "c:/export/" -backup 0
• -fileFormat (-ff): You can specify output file format.
• Allowed formats:
• 0        OpenEXR (.exr)
• 1        RGBE (.hdr)
• 2        PNG (.png)
• 3        DDS (.dds)
• 4        JPEG (.jpg)
• Example:
• render "c:/export/" -fileFormat 2
• -resolution (-res): You can specify output file resolution. You must specify both width and height
• Example:
• render "c:/export/" -resolution 1920 1080
• -renderSettings (-rs): You can specify render settings to be used for render.
• Example:
• render "c:/export/" -renderSettings "furryBallRenderSettingsDefault[18]"
• Note:
• Render settings must be available in scene. Available render settings are stored in frames directory in files called renderSettings.fbs.
• This settings has sense only if scene render settings is used (ie. render settings is not overridden by pass).
• -pass (-p): You can specify output pass to be rendered.
• Allowed formats:
• 0        Beauty
• 1        Depth        
• 2        Direct Diffuse
• 3        Direct Specular  
• 4        Indirect Diffuse
• 5        Indirect Specular
• 6        Reflections
• 7        Transparency
• 8        Subsurface Scattering
• 9        Shadows
• 10        Alpha
• 11        Normals
• 12        Wireframe
• 13        UVs
• 14        Matte
• 15        World Position
• 16        Ambient Occlusion
• 17        Surface Color
• Example:
• render "c:/export/" -pass 1
• Note:
• This settings clear all selected passes before and set this pass with default settings.
• -textureBaking (-tb): You can specify mesh object and its instance to be used for texture baking.
• Example:
• render "c:/export/" -textureBaking "BackPlane1Shape[4159]" "BackPlane1Shape[0]"
• Note:
• Mesh object and its instance must be available in scene. Available meshes are stored in frames directory in files called meshes.fbs.
• For more details see Texture Baking section in Standalone Rendering.
• Example:
• render "c:/export/" -fc -f 3 -f 5 -ff 2 -res 960 540

clearMemory

• Command for clear all memory used by FurryBall's resources.
• Syntax:
• clearMemory

licensing

• Command for getting licenses information.
• Note:
• All output from licensing commands is in braces.
• Syntax:
• licensing [arguments]
• Allowed arguments:
• -hwid: Get computer's FurryBall hardware id.
• Example:
• licensing -hwid
• Example output:
• {u-A...==}

info

• Command for getting FurryBall information.
• Note:
• All output from info commands is in braces.
• Syntax:
• info [arguments]
• Allowed arguments:
• -fbName (-fbn): Get FurryBall name.
• Example:
• info -fbName
• Example output:
• {FurryBall RT}
• -fbVersion (-fbv): Get FurryBall version.
• Example:
• info -fbVersion
• Example output:
• {1.2.3870}
• -pluginPath: Get FurryBall installed directory.
• Example:
• info -pluginPath
• Example output:
• {C:\Program Files\FurryBall RT\}
• -appDataPath: Get path refers to FurryBall application data.
• Example:
• info -appDataPath
• Example output:
• {C:\ProgramData\FurryBallRT\}
• -cardNames (-cn): Get all FurryBall capable cards and its information on your machine.
• Example:
• info -cardNames
• Example output:
• {NVIDIA GeForce GTX 560,2048,0,2,1
• NVIDIA GeForce GTX 580,3072,0,2,0}
• Note:
• Each graphics card is displayed on single line.
• Graphics card line consist of card name, video memory in MB, single GPU or multi GPU, major compute capability, minor compute capability

settings

• Command for getting or setting FurryBall settings.
• Note:
• All output from settings commands is in braces.
• Syntax:
• settings [arguments]
• Allowed arguments:
• -get: Get FurryBall settings.
• Syntax:
• settings -get [attribute]
• Example:
• settings -get -textureCachePath
• settings -get -textureCachePath -presetsPath
• Note:
• You can set multiple attributes and returned values will be displayed on new lines.
• -set: Set FurryBall settings.
• Syntax:
• settings -set [attribute] [value]
• Example:
• settings -set -cards 0
• settings -set -doNotSave -cards 0
• Note:
• You can set multiple attributes at once.
• Allowed attributes:
• -doNotSave: Disabling saving any changes in this settings command into configuration file.
• Example:
• settings -set -doNotSave -cards 0
• Note:
• This attribute is allowed only for set argument.
• -log: Enabling or disabling FurryBall logs.
• Allowed values:
• 0        Disable logs
• 1        Enable logs
• Example:
• settings -set -log 0
• Note:
• This attribute is allowed only for set argument.
• -cards: Allowed card used for rendering via FurryBall.
• Example:
• settings -set -cards 0
• settings -get -cards
• Example output for get command:
• {0:1}
• Note:
• In this attribute is stored index of allowed card from all cards, which can be get by info -cardNames command.
• In case of setting incompatible cards combination, available cards combination will be displayed.
• -textureCachePath: Directory with FurryBall texture cache.
• -presetsPath: Directory with FurryBall presets.
• -standaloneVersion (-stv): Current standalone version.
• Allowed values:
• 0        Free version
• 1        Client only
• 2        Full version
• Example:
• settings -set -standaloneVersion 0
• settings -get -standaloneVersion
• Example output for get command:
• {2}
• Note:
• For using free version you must have done online activation.
• For using full version you must have a valid license.
• -updateNotification: Enabling or disabling update notification.
• Allowed values:
• 0        Update notification is disabled
• 1        Update notification is enabled
• X        Update notification is enabled for all builds greater than X
• Example:
• settings -set -updateNotification -3870
• settings -get -updateNotification
• Example output for get command:
• {1}

exit

• Command for close FurryBall standalone application.
• Syntax:
• exit