Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update config.json docs #498

Merged
merged 1 commit into from
Jul 31, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion docs/docs/config/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,12 @@ Allowed values: Any valid path
Description: If left blank then content will be downloaded to `__user_data__/sites/OnlyFans/{username}`.
If you set the download path to `"S:/"`, then content will be downloaded to `S:/{username}`

:::note

If you are using a Windows path, you will need to escape the backslashes, e.g. `"C:\\Users\\user\\Downloads\\OnlyFans"`

:::

## PaidPostFileNameFormat

Type: `string`
Expand Down Expand Up @@ -375,7 +381,7 @@ Type: `string`

Default: `""`

Allowed values: The name of a list of users you have created on OnlyFans or `"""`
Allowed values: The name of a list of users you have created on OnlyFans or `""`

Description: When set to the name of a list, non-interactive mode will download media from the list of users instead of all
users (when [NonInteractiveMode](#noninteractivemode) is set to `true`). If set to `""`, all users will be scraped
Expand Down Expand Up @@ -405,6 +411,12 @@ Description: This is the path to the FFmpeg executable (`ffmpeg.exe` on Windows
If the path is not set then the program will try to find it in both the same directory as the OF-DL executable as well
as the PATH environment variable.

:::note

If you are using a Windows path, you will need to escape the backslashes, e.g. `"C:\\ffmpeg\\bin\\ffmpeg.exe"`

:::

## BypassContentForCreatorsWhoNoLongerExist

Type: `boolean`
Expand Down