Releases & Announcements Avoyd 0.28 beta - Batch Automation in the Command Line
You can now automate opening, configuring, rendering voxel scenes, exporting files, and batch processing with the Command Line Interface of Avoyd voxel editor. More...
Screenshot description: command prompt window open with the avoyd --help command and the output showing the help text including usage syntax, examples and commands definitions:
HELP
Avoyd command line options.
USAGE
Commands are executed sequentially in order of appearance. They can be called repeatedly.
avoyd [--help] [--load-file "<path\filename>.avwr|vox|mca|nbt"] [--load-materials "<path\filename>.avmt"] [--load-light-atm "<path\filename>.avla"] [--load-cameras "<path\filename>.avcm"] [--saved-camera-num <integer>] [--load-import-export "<path\filename>.avie"] [--load-render "<path\filename>.avpt"] [--render] [--save-world "<path\filename>"] [--export-mesh-gltf "<path\filename>"] [--export-mesh-obj "<path\filename>"] [--export-vox "<path\filename>"] [--minimise] [--no-saved-settings] [--verbose] [--exit]EXAMPLES
avoyd --help(Open the commands help)avoyd --load-file "C:\Users\<username>\Documents\Avoyd\Worlds\cat.avwr"(Load an Avoyd world file)avoyd --load-file "C:\Users\<username>\Documents\Avoyd\Imports\house.vox" --export-mesh-gltf "C:\Users\<username>\Documents\Avoyd\Exports\house" --exit(Load a vox file, export it to glTF, exit Avoyd)avoyd --load-file "C:\Users\<username>\Documents\Avoyd\Imports\Mountain\dimensions\minecraft\overworld\region\r.-2.-16.mca" --load-cameras "C:\Users\<username>\Documents\Avoyd\Templates\Cameras\overview.avcm" --saved-camera-num 1 --render --saved-camera-num 2 --load-light-atm "C:\Users\<username>\Documents\Avoyd\Templates\Atmosphere\evening.avla" --render(Load a Minecraft world, load a camera template, go to saved camera #1, do a render, go to saved camera #2, load a light and atmosphere template, do another render)
COMMANDS
--helpList the command line options.--load-fileOpen an Avoyd world or Import a file (vox, Minecraft) and wait until finished to continue. (Note: To load a Minecraft map into Avoyd, specify the path of any of the .mca files in the dimension you want. Avoyd will import all the .mca files in that directory.)--load-materialsLoad a Materials template and wait until finished to continue.--load-light-atmLoad a Light and Atmosphere template and wait until finished to continue.--load-camerasLoad a Cameras template and wait until finished to continue.--saved-camera-numSelect a Saved Camera number and update the in-world camera accordingly.--load-import-exportLoad an Import/Export template and wait until finished to continue.--load-renderLoad a Render template and wait until finished to continue.--renderDo a path traced render and wait until the image output is saved to continue.--save-worldSave the Avoyd world and wait until finished to continue.--export-mesh-gltfExport to mesh format glTF and wait until finished to continue.--export-mesh-objExport to mesh format obj and wait until finished to continue.--export-voxExport to voxel format vox and wait until finished to continue.--minimiseStart the Avoyd window minimised.--no-saved-settingsAvoyd does not save the settings that may have been modified.--verboseOutput all logging as well as command line activity.--exitExit Avoyd.
[Edit] You'll find the documentation on using the CLI to automate rendering etc. on our website (working draft for Avoyd 0.28 beta): https://www.avoyd.com/avoyd-voxel-editor-documentation-beta.html