TumblRipper Documentation

Last Updated : 2019-10-01

Welcome to the full documentation for TumblRipper v3

Installation

TumblRipper v3 is using Squirrel for it's installation and updates.

You just run the setup.exe file from the website, and installation will occur silently and painlessly, TumblRipper will start once it's done.

Installation is done inside of your Application-Data folder, so no Administrative Rights are necessary.

Interface

TumblRipper's interface is done in WPF using MahApps Metro and Material Design In XAML libraries for a cleaner UI.

Main Window

Screenshots

Right Click Menu

• Open Folder Opens the file explorer directly in the media folder
• Open In Browser Opens your default browser to the site url
• Edit Change the properties for the entry.
• Consolidate Re-indexes the selected entries just like the first time. It won't download files that have already been downloaded. Usefull if you change options.
• Run Update the selected entries. It will stop once it reaches the previous point.
• View Errors Opens a window so you can view the different errors, retry one by one, or delete them. (Right click on entries for options)
• Disable Disables the selected entries
• Enable Enables the selected entries
• Delete Deletes the selected entries. It won't remove any downloaded files.

Settings

Screenshots

General

• Default Directory : A Folder where TumblRipper will suggest new website entries. Do not use the MyPictures folder. As Windows will process those files and result in high cpu-usage and slow downloading.
• Anonymous usage stats : This will send some usage statistics back to me. You cannot disable this option when running the free version.

Plugins

This will allow you to set the default options for every plugin. Please make sure you click on the "Make default settings" button after each plugin.

Network

If your connection requires you to run thru a proxy server, you can set it up here

Advanced :

• Subscribe to beta channel : receive experimental updates
• Check for updates now : click to check if there are changes
• Reset all settings : Factory reset TumblRipper v3

Add a Website

Screenshots

• Website : This field is where you will put the url of the website you wish to back-up. Once inserted TumblRipper will try to automatically select the best plugin for the job.
• Plugin : You can let TumblRipper automatically select a plugin for you, or select one manually. You can find the list of plugins here with descriptions and configurations.
• Folder : The folder where the media will be downloaded. It must be an empty folder. TumlbRipper will create a hidden folder in it where settings for that entry will be saved. TumblRipper will suggest a folder, based on the Default Folder you set in the Settings, and the title or url of the website.
• Title : Title of the entry that will appear in the list
• ... button : This will try to read the Title again from the website.

Free Version Limits

To support active development, but allow most users to benefit from a free application, it was decided to limit TumblRipper to 3 website entries. This should be enough for most users. Users who donate receive a lifetime serial number that unlocks that limitation.

Advanced Topics

Folder Structures

When you create a new entry, all settings related to that entry will be saved in a hidden sub-folder.

It contains the list of indexed media, the list of failed media, the list of pending media, and two xml file containing all settings for that entry.

This allows you to later import back that directory or share it between computers (NAS Storage, Cloud, etc... ).

The main tumblripper settings xml file only contains a list of directories.

All settings files are standard xml files and can be freely edited outside of TumblRipper. You are however on your own as i cannot guarantee anything.

Files & Folders

C:\Users\[USERNAME]\AppData\Local\TumblRipper3 - Contains the tumblripper3 settings files. If you wish to "reset" your tumblripper, remove them.

C:\Users\[USERNAME]\AppData\Local\TumblRipper - Used by Squirrel, contains the actual TumblRipper installation. It's normal for two versions of the app to be there.

Writing your own plugin

Plugin structure is starting to feel final, so i will soon release the interface that you can import to build your own plugin.