vikus-viewer-script v2

There is a new version of vikus-viewer-script incoming. WIP

Example:

npm i
node bin/textures.js /path/to/your/images
node bin/spritesheets.js data/tmp/256/ --outputFormat jpg

OLD from here on

---

The script in /images will generate textures and spritesheet assets which are needed for the vikus-viewer. The script in /tsne will generate a TSNE layout which can be used as an alternative to the timeline-view in VIKUS Viewer.

Requirements

• nodejs
  • use the installer on https://nodejs.org/en/download/
  • or use nvm https://github.com/creationix/nvm

Usage image script

Download or clone this repo, navigate to /images and install the required node packages:

npm i

All your images should be in one folder (lets say "images") and named x.jpg, where x is the id of the image.

To generate textures and sprites run the script like this:

IMAGEPATH=/path/to/images npm run build

This will create a data folder for the textures (1024 and 4096) next to the original image folder as well as a sprites folder for the spritesheets.

You are now finished in preparing the textures and spritesheets!

Copy the folder 1024, 4096 and sprites inside data into your /data folder of your vikus-viewer instance. After a successfull run you can delete the tmp folder.

A note for collections of 5000+ items: In the default configuration the script will generate sprites at the maximum dimensions of 256x256px. For faster loading time and collections with a lot of items, you should adjust the resolution of the sprites by running the scripts individually.

node textures.js -i /path/to/images -s 128 -f jpg
node spritesheets.js -s 128 -i /path/to/images

-i: input path
-s: sprite dimension
-f: input image format

Usage TSNE script

Download or clone this repo, navigate to /tsne and install the required node packages:

npm i

Run the TSNE script:

node tsne.js -i /path/to/images

/path/to/images should be pointed low res images (made with the texture script) in the 1024px resolution. After you run the script a tsne.csv will be generated. Copy the csv into the data folder of your VIKUS Viewer instance and add an "tsne" entry to the loader section in the config.json file pointing to the tsne.csv file. Have a look at the Van Gogh Example config