Library Client: User Guide

Jeff Montgomery -

Welcome to our Library Client user guide. Here you can find an overview of the features and behaviors of the Library Client.


Looking for help with a specific issue? Please see our
Library Client FAQ page or Contact Us for help.


 

What’s New!

Current release is now in version 3.0.

We have changed up the color themes, updated some labels to better indicate what they do, streamlined some behaviors, and added in some new features!

  • All operating systems - Option to login by retrieving your key directly using your account information (previously iOS version only)
  • Refresh Library is now Check for Updates
  • Sync Library is now Download All
  • Output Path is now Download Directory
  • List view- the original library display, but now only shows titles. The file lists have been moved to the new title information screen.
  • New! - Tile view- displays your library by title cover icons 
  • New! - Selection mode - When using select all or individually selecting a title will go to a dedicated screen where titles can be selected/unselected and downloaded. 
  • New! - Title information page - reached by clicking on the i icon or on anywhere on a title that has multiple files. screen that shows publisher, rule system, date downloaded, date of last update of files, and the complete file list for that title. 
  • Sorting options now have their own drop down and we have added the option to sort by purchase date ( New to Old and Old to New)
  • Two new filter options
    • Not Downloaded - shows titles that have not been downloaded
    • Has Updates - Appears only when a title’s files have been updated and will show only those titles that have updated files.
  • Additional visual cues and behaviors
    • Titles that have files downloaded will now have an i icon instead of an Open button.
    • Clicking on the i icon will go to the title information page
    • Titles with just one file will now open the file when the bar/title cover is clicked on
    • Titles with multiple files will go to the title information page when the bar/title cover is clicked on
    • Titles that have no downloads will now have their cover image faded out
    • When an error occurs the status message will appear at the bottom highlighted red
    • If downloading has been deactivated for a folder scan the download buttons will fade out

 


 

Getting Started

If this is your first time using our Library Client you will need to download the program.

You  can find the download file and installation instructions for all available operating systems (Windows, macOS, iPad, and Android) here: http://www.drivethrurpg.com/library_client.php

Mobile and ChromeOS users can find the Library Client directly on GooglePlay or the Apple Store. Just search for DrivethruRPG Library. 

ChromeOS: The Android version has been confirmed to be working on the most recent version of ChromeOS, however some older versions and devices may have trouble running the Library Client. 

Linux: Currently our Library Client is not available on Linux, but our team is looking at possibly adding it in the future. If you would like to request a Linux version, please let us know.

 

Launching the Library Client

Once installation is complete, click on the icon ( a capital D with an arrow on the bottom) labelled DriveThruRPG to launch the Library Client. 

 

Logging In

In order to login to the Library Client you will need an Application key. There are two ways to get your key:

Using your account information:

    • On the login screen click Get my Application key. 
    • This will take you to a screen to enter the email and password you use for our site to log in. 
    • Enter your information and then click Get Key
    • This will take you back to the previous screen, but the application key will be filled in now. 
    • Click Login. 

Retrieving your Application key from the website:

You can always manage your Application key by logging into any of our sites and going to your My Account page. lt will be in a section labelled Application Keys right under where you manage your name and email.

Once you have logged in the Library Client will begin retrieving your Library information from our website. Please note that for larger Libraries this may take a few minutes. Once finished the Library Client will attempt to scan your designated download folder to check for existing files. 

 

Scanning Designated Download Folder

The Library Client will always scan your Download Directory on every launch, after every Check for update click, and any time you change the Download Directory.This may take a while if you have many files. However if the folder does not exist yet then the Library Client will quit the scan. 

During this scan all downloading is disabled and a status message will appear at the bottom until the scan is finished. 

 


 

Customizing and Filtering Library View 

List View and Tile View

You can display your library either in the original list view or in the tile view. To toggle between the two views click on the icon to the left of select all. The selected view option will turn red when active. Clicking on the four squares will toggle the tile view. Clicking on the three links will toggle the list view. 

List View: The original view. Creates a lists of titles with title cover, title, publisher, rule system, and then status icon

Tile View: Displays a large icon of the title cover, status icon is in the center, and at the bottom is title, publisher and rule system information. 

 

Sorting your library

You can sort your library by purchase date, title, publisher, or rule system in either descending (Z - A) or ascending (A - Z) order . Just click on the sorting option drop down located between select all and the search (there will be an icon with an arrow pointing down next to a list of lines), and then select the option you want to use to sort. 

 

Filtering your library

There are a few ways to filter your library if you are looking for something specific or want to know the status of a title.

  • All - Will display your entire library.
  • Downloaded - Will display titles that have files downloaded
  • Not Downloaded - Will display only titles that have no files downloaded
  • Keyword Search - Will display titles that have a match in their title, publisher, or rule system to the keyword(s) that was entered in the search bar. 

 


 

Downloading Your Library

After the Library Client loads your library data and finishes its initial folder scan (if the folder exists) then you are ready to start downloading. 

Previously Downloaded Files

If you have previously downloaded files from your My Library, the Library Client is designed to recognize any files from our servers. We recommend doing one of the following before downloading anything in the Library Client.

Change the Download Directory:

      • Click on Settings and change the Download Directory to the folder where the already downloaded files are. Click Save Changes.
      • It will go back to the main library screen and start scanning the folder (Please note downloading will be disabled at this time)
      • Once the scan is complete downloads will be enabled again and titles should start showing the i icon
      • If nothing seemed to have happened then click on Check for updates and wait a couple of minutes for it to recognize the files. 

Move the files to the Download Directory:

      • Move the files to the folder that the Download Directory in Settings is set to. 
      • Open the Library Client and click Check for updates
      • The Library Client will start scanning the folder. (Please note that downloading will be disabled at this time.)
      • Once the scan is complete downloads will be enabled again and titles should start showing the i icon
      • If nothing seemed to have happened then click on Check for updates and wait a couple of minutes for it to recognize the files.

 

Download All - Clicking this will begin downloading any file that isn’t recognized as already being downloaded.

 

Downloading all files for a specific title - In the main Library screen click on the download icon (blue with a white arrow pointing down over a hard drive) or use selection mode to download.

List View:

      • Click on the download icon (blue with a white arrow pointing down) on the right hand side
      • Check the selection circle on the left hand side and download in the selection mode

Tile View:

      • Click on the download icon (blue with a white arrow pointing down) in the middle
      • Check the selection circle on the left hand top corner and download in the selection mode

 

Selection Mode

Selecting a title or clicking on the Select all button will go to the selection mode. The titles that appear are will depend on how you filter your library before entering selection mode (ie if you search for bard and then go to selection mode - only titles that have a match for bard will appear).

In this mode the download icons are disabled. Only Download Selected and Download All will start downloads. To leave the selection mode click on Cancel. 

Select all will select all your titles. Clicking unselect all will remove all the selections. When you are ready to download your selected titles click on Download Selected in the top left side. 

List View: Clicking anywhere on the title bar or cover icon will select or unselect the title. When a title is selected a green check mark will appear on the left hand side. 

Tile View: Select a title by clicking in the top left corner When a title is selected a green check mark will appear in the corner. Then clicking anywhere on the cover will remove the selection. 

 


 

Updating and Managing Library Information

When you make new purchases or unarchive a title the Library Client will need to look for those updates. You can also archive a title to remove it from the Library Client as well. 

 

Checking for Updates

Clicking Check for updates will cause the Library Client to scan your online account for any updates (new purchases, unarchived titles, title updates, etc.) and scan the Download Directory folder.

 

Titles with updated files

When a title has its files updated or changed the Library Client will detect this when its next scan is triggered. The Has Updates button will appear and initially be highlighted blue. Clicking on Has Updates will filter the library down to the updated titles.

 

The Library Client has three options on how to deal with downloading updated files. You can change this option in the Settings (gear icon)

  • Always ask before replacing old file(s) - a pop up will appear asking what you would like to do: Archive or Replace the old file, or do nothing
  • Rename old files: during a download the app will automatically rename the old file and download the new file, keeping both files.
  • Replace old files: during a sync the app will automatically remove the old file and download the new file during a sync
  • Always Ask: a  pop up to appear asking you what you would like to do with the changed file(s). Clicking the box for Remember my choice will apply the chosen option to all changed files.  Rename and Replace work the same as above, while Do not update will leave the old file alone and not download the new one. 

 

Removing Titles from the Library Client

The Library Client is designed to where any title placed in your My Archives will not be loaded in the app. 

If there is a title that you do not want the Library Client to manage go to the website and place that title in your My Archives.  If you place it in the archive after you have already loaded your library in the Library Client, then you will need to sign out and back into the Library Client. 

To put a title in your My Archives:

    • Go to Your My Library on the website
    • Find the title you want to archive
    • Click on the icon that looks like a file box

If you change your mind just unarchive the title on the website and then open the Library Client and click check for updates. 

To unarchive a title:

    • Go to your My Library on the website
    • Scroll down and expand your My Archives
    • Find the title you want to unarchive
    • Click the icon of the arrow pointing up

 

Managing your files on your hard drive

Currently only available on Windows and macOS

The Library Client is designed to be flexible with how a user may want to organize their files on their hard drive. 

You can rename your files, rename the folders, have as many or as little folders you want, or even keep your files spread across multiple directories, and still be able to open them in the Library Client. 

  • Renaming files or folder: Once you have renamed the file you will need to open the Library Client and then click Check for Updates (Refresh Library for Version 2.0) to update the library information.
  • Moving files to folders in the Download Directory: Once you have finished moving your files just open the Library Client and then click on Check for Updates to update the library information. 
  • Moving files to a new directory/hard drive: 
    • Open the Library Client
    • Go to Settings and change the Download Directory to the new directory
    • Click Save Changes
    • The Library Client should begin scanning the new directory and updating the library information.

 


 

Settings

You can access the Settings by clicking on the gear icon in the upper right corner. Enabling an option will cause a green check mark icon to appear on the left side. Disabling an option will remove the check and show a light gray circle instead. 

Here you can also see which version of the Library Client you are running.

 

File Save Location - Download Directory

This is currently only available for the Windows and macOS versions. 

At any time you can change the location that the Library Client will save the files it downloads. Changing this location will not affect already downloaded files - they will still be able to be opened (unless the files have been moved)

To change the download location:

    • Click on the gear icon to go to Settings. 
    • Go to the Download section at the top
    • Find the Download Directory option 
    • Then either click on the three dots on the right side to choose the new folder or manually type in the folder location. (Please make sure your folder is not set to read only.)
    • Then click Save Changes. 

After going back to the main library page the Library Client will perform a scan of the new location and then you will be ready to download.  You can also use this to get the Library Client to connect to files you have already downloaded from our site. 

 

Multiple File Download Options

You can also control how many files at a time the Library Client will download at the same time. 

To change the number of simultaneous downloads:

  • Click on the gear icon to go to Settings
  • Find the Number of simultaneous downloads option.
  • Then click on the drop down to pick one how many you would like to download at a time
  • Click Save Changes

 

Library Client Update Notifications

There are two ways you can check when we release an updated version of the Library Client

  • Enable the Check for updates when app starts option in Settings (gear icon). (When enabled a green check mark icon will appear by it)
  • Visit our Library Client webpage 

When you have the Check for updates when app starts option enabled, when a new update is released then the next time you launch the Library Client you will get a pop up window asking if you would like to update the app. This option should be enabled as default as well.  

 

Activity Logging

Currently only available on Windows and macOS

For the Windows and macOS versions the Library Client can create a text file to log its activity. This option is enabled by default and we highly recommend to keep this enabled since it is used to assist in troubleshooting issues. 

To enable or disable logging:

  • Click on the gear icon to go to Settings
  • Find Enable Logging to assist in improving the application  
  • Click to enable or disable

 

Additional Settings

Show Delete Confirmation - when the box is checked  the app will always ask for confirmation  to delete a file when you click on the delete icon. 

Sign Out - Will sign you out of the Library Client. This will also clear out any cached library data. So if you have files in a different folder from your Download Directory you will need to direct the Library Client to them again

Save Changes - click to save any changes made to the settings and return to the library.  

Cancel - clicking will close the Settings window and any changes made will not be saved.

Have more questions? Submit a request

0 Comments

Article is closed for comments.