How spin files are created
Sirv automatically creates a spin file when you upload a sequence of images. This is a text file (in JSON) which references the images in your animation, plus any other settings you choose.
A spin file is generated when:
- The image names contain a sequence of ascending numerals.
- Between 8 and 1000 images make up the sequence.
- Numerals do not exceed the value 1024.
Spin files are created with the file extension
.spin, for example:
The .spin file name is determined from either the folder or file name:
- Folder name – if there is one spin in a folder, it will take the name of the folder.
- File name – if there are multiple spins in a folder, they will take the name of the images.
When the folder name is used, the image names are disregarded. For example, if you upload this set of images to a folder named “black-dress“:
The following .spin file will be created:
When the spin file name is generated from the file name, the ascending digits in the file names are stripped from the .spin file name. For example, if you upload these 2 sets of spins:
These two .spin files will be created:
You can tell Sirv to use the image file names instead of the folder name. To do this, right-click the folder and choose Folder settings. Change the “Spin file name” option to “Generate from file names”:
Sirv will generate a multi-row spin (also known as a 3D spin) when it detects two sets of digits. The first digits represent rows and the second represent columns.
For example, drag the boot up and down as well as left to right:
Sirv always processes the first set of digits as the row and the second set as the column:
If you upload a sequence of images such as this:
Sirv will create a two-row spin with this name:
Spins have lots of files so to help you manage them, we recommend placing C/c, R/r or S/s before each set of digits.
R = Row
C = Column
S = Spin number
This naming rule may be useful for:
- Descriptive file names – R and C let you instantly know what each set of digits represent.
- Multiple product spins – S signifies when a single product/item has multiple spins (e.g. different colours of the same product).
- Better collaboration – other team members can quickly understand what the digits represent.
For example, if you upload these two multi-row spins:
Sirv will create these 2 spins:
If you apply R and C references to your images but their is only 1 row or 1 column, those digits won’t change in your file names. Therefore, Sirv won’t strip them from the file name.
For example, this 1-row spin:
Will produce this spin file:
If you wish to strip superfluous R01 or C01 entries in your .spin file names, either right-click and use “Rename” to change the name or contact Sirv support from your control panel and request for R01 or C01 to be automatically stripped.
Custom spin detection
If you use an image naming format that is not detected by default, Sirv offers custom spin detection algorithms for Enterprise accounts. Continue using your existing file naming convention and Sirv will be customized to fit that convention. Please contact support with your requirements.
Replacing images in a spin
If you upload one or more images with the same file name, the existing images will be overwritten and the cached spin images will be immediately invalidated. The next time the spin is requested through the browser, it will be recreated using the latest images.
Corrupt or missing images
A spin will be created even if one or more images are missing or corrupt.
Sirv will detect the missing or corrupt images and skip them when the spin rotates.
Corrupt files will display an error message in your control panel, recommending that you reupload them.