0.0.5 • Published 6 years ago

av-render v0.0.5

Weekly downloads
11
License
ISC
Repository
-
Last release
6 years ago

General process

  1. Install Nodejs on the device if NodeJs is never installed before. https://nodejs.org/en/download/
  2. Open command-line toolterminal or shell based on the operation system.
  3. Install av-render by typing following command: npm install --global av-render. After installation you can type av-render -V to confirm.
  4. Set your username and apiToken by typing
   av-render username your-username
   av-render apiToken your-api-token
  1. If installation is successful, there is no necessary to run step 1-3 anymore. To run the program, type av-render render to start rendering all images for all the situations of configration.

  • Once start redering, this program will create a folder named av-render in your desktop. And it will put all renderd images named as sku in this folder

Options explanation

  1. --sku : this option can be set as one sku like 'AHSF-3096-DTT10_WMH_WE_B52x2' or a path of csv file which should contain many skus you want to render like '/home/user/Downloads/example.csv'
  • Usage Example: av-render render --sku '/home/user/Downloads/example.csv' or av-render render --sku 'AHSF-3096-DTT10_WMH_WE_B52x2'
  1. --width and --height : these two options are used to set height and witdh of rendered images. Default is 800 for both.
  • Usage Example: av-render render --width 800 --height 900
  1. --camera: this option is for choosing a specific camera for rendering. This option should be the Id of the choosed camera.
  • Usage Example: av-render render --camera '1234556788999
  1. --csv: use this option when you want to update the reference csv file which contains all skus with related configuration. This file should be same with the csv file which the app is using.
  • Usage Example: av-render render --csv '/home/user/Document/example.csv
  1. -o or --override: use this option when there is already a image in the av-render folder and you want to override the existing image with new redered image.
  • Usage Example: av-render render -o or av-render render --override

Note: It is possible to use more than one option at the same time. For example av-render render --sku 'AHSF-3096-DTT10_WMH_WE_B52x2' -o -width 1200 --camera 'aedadf12332edsc23cw'