File name schemas

File name schemas are a way for users to customize their downloads. There are some drawbacks to having more details within the file name schema, that I wish to outline before getting into the valid values you can use.

Forewarning

Downloading (as of v3.0.0) checks for inconsistent files by the file names, which means files that have dynamic values (favorite count, rating, score, etc) will interfere with this inconsistent checking system. While I added the values to be optional for people to use, downloads that have dynamic values in the file name schema with no unique identifier should not be re-downloaded.

Additionally, file names can have large lengths in names. It's recommended that the selected download path is very short, to compensate for Windows' 255 character filename limit.

Global & provider-specific schemas

aphrodite supports global and provider-specific schemas, to allow you to specify schemas per-provider. If some provider does not have a schema value, you may have a different way to name the files from that provider.

Supported values

Key	Value
%hash% ***	The MD5 Hash (or equivalent) of the file. If none is added, idk it can be removed or kept. If boorus support in-place updating, this value may be different.
%id%	The ID of the post.
%rating% *	The full name of the rating; explicit, questionable, etc.
%rating2% *	The single-letter of the rating; e, q, etc.
%artist% **	The first value within the artist tags list.
%ext% ***	The extension of the file. If boorus support in-place updating, this value may be different.
%favcount% *	The favorite count of the post.
%score% *	The score (sum) of the post.
%scoreup% *	The upvote score of the post.
%scoredown% *	The downvote score of the post.
%author%	The ID (or username) of the user who submitted the post.
Pool-only supported keys
%poolname% ****	The name of the pool.
%poolid%	The ID of the pool.
%poolpage% ****	The page number of the post in the pool.

*This value may be different when re-downloading. See the forewarning for information.
**This value should be considered a dynamic value. See the Artist values section below.
***If a booru supports in-place updating of files, this value may be a dynamic value.
****The value should be updated when re-downloading the pool. If it is not, it may be inconsistent.

Unsupported characters in the schema

The following characters are not allowed in the file name schema:

:, *, ?, ", <, >, |

While backslashes \ and forward slashes / are allowed, they should not be used unless you know how pathing works on Windows.

Artist values

Due to the nature of e621 not having a designated "file artist" tag, multiple values may be posted in the artist list. Most offenders, such as sound_warning can be filtered out under the Undesired tags filter.

Any boorus that DO contain a designated "file artist" tag, this value may be static, unless the artist changes username or any other clause may cause the value to change.

---

The schema values outlined here is information about the e621 provider on version 3.0.0 and above.