OF-Scraper
  • Welcome
  • Requirements
  • Install
    • Pre-Install Guides
      • Linux
      • Windows
      • Mac
    • PIPX Install
    • PIP Install
    • Binary Releases
    • Docker
    • Release Info
    • Managing Multiple Python Versions
  • Getting Started and Settings
    • Config Options
      • Config Location
      • General Options
      • File Output Options
        • Placeholders
        • Responsetype Placeholders
      • Download Options
        • Download Toggles
        • Media Filtering Options
        • Advanced Download Options
      • Setting metadata path
      • Binaries Options
      • CDM Options
      • Performance Options
        • Values to Pick
      • Script Options
      • Advanced config options
        • Changing Const Values
        • Mediatype overwrites
    • Depreciated Options
    • Auth
    • Controlling Output/Logs
    • Migrating from Digitalcriminal's script
  • Using the Scraper
    • Using Prompts
      • Old Menu
      • Page 2
    • Username selection or Fuzzy Search
    • Basic Automation with command-line
      • Basic Actions
        • Liking/Unliking Post
        • Downloading Content
          • Downloading Text Files
          • Downloading Purchases From Deleted Models
        • Multiple Actions
      • Model Filtering/Sorting
        • Price Filtering/Sort
      • Advanced Args
      • Scripting tips
      • Enable label scan
    • Recipes
      • Adding Proxy
      • Redownload Deleted Downloads
  • Content Check Modes
    • Table Columns
    • Table Management
      • Pre 3.10.7 filtering
  • Scraping Individual Posts or Media
  • Metadata
    • Schema
    • Creating Metadata
    • Metadata location
  • CDM Setup
    • CDM issues
  • FAQ/Common Issues
    • Page 1
  • Command Reference
    • Shared Options
      • General Program Options
        • Program Options
        • Logging Options
        • Filename Modification Options
        • Media Filters Options
        • Download Options
        • Advanced Program Options
      • Shared Scrape and Metadata Check Mode Options
        • User List Filter Options
          • Advanced User Filters
        • User Selection Options
        • Model Sorting & Processing Options
        • Content Options
        • Automation Options
        • Advanced Search & Processing Options
    • Main Scraper Options
    • Metadata Check Mode Options
    • Content Check Modes Options
    • Manual Mode Options
  • Request Change to Doc
  • Testing
Powered by GitBook
On this page
  • Config settings for save locations
  • Media Filtering
  • Key Options
  1. Getting Started and Settings

Config Options

PreviousGetting Started and SettingsNextConfig Location

Last updated 1 year ago

Example Config

{
    "config": {
        "main_profile": "main_profile",
        "metadata": "{configpath}/{profile}/.data/{model_username}_{model_id}",
        "discord": "",
        "file_options": {
            "save_location": "/home/james/Data/ofscraper",
            "dir_format": "/{model_username}/{responsetype}/{mediatype}/",
            "file_format": "{filename}.{ext}",
            "textlength": 0,
            "space-replacer": " ",
            "date": "MM-DD-YYYY",
            "text_type_default": "letter",
            "truncation_default": true
        },
        "download_options": {
            "file_size_limit": 0,
            "file_size_min": 0,
            "filter": [
                "Images",
                "Audios",
                "Videos"
            ],
            "auto_resume": false,
            "system_free_min": 0,
            "number_retries": 10
        },
        "binary_options": {
            "mp4decrypt": "//home/james/.config/ofscraper/bin/mp4decrypt",
            "ffmpeg": "//home/james/.config/ofscraper/bin/ffmpeg"
        },
        "cdm_options": {
            "private-key": "//home/james/.config/ofscraper/device/private_key.pem",
            "client-id": "//home/james/.config/ofscraper/device/client_id.bin",
            "key-mode-default": "manual",
            "keydb_api": ""
        },
        "performance_options": {
            "download-sems": 10,
            "threads": 10
        },
        "advanced_options": {
            "code-execution": true,
            "dynamic-mode-default": "dc",
            "backend": "aio",
            "downloadbars": false,
            "cache-mode": "sqlite",
            "appendlog": false,
            "custom_values": {},
            "sanitize_text": false,
            "avatar": true,
            "temp_dir": null,           
            "disable_auto_after": false,
            "default_user_list": "main",
            "default_black_list": ""
        },
        "responsetype": {
            "timeline": "Posts",
            "message": "Messages",
            "archived": "Archived",
            "paid": "Messages",
            "stories": "Stories",
            "highlights": "Stories",
            "profile": "Profile",
            "pinned": "Posts"
        }
        "overwrites":{
        audios:{},
        videos:{},
        images:{}
        
        }
    }
}

Config settings for save locations

Customize the final file path for downloads


Media Filtering

Customize which files are downloaded


Key Options

These settings are required for some files

File Output Options
Media Filtering Options
CDM Options